2022/04/26 - Amazon SageMaker Service - 2 updated api methods
Changes SageMaker Inference Recommender now accepts customer KMS key ID for encryption of endpoints and compilation outputs created during inference recommendation.
{'InputConfig': {'VolumeKmsKeyId': 'string'},
'OutputConfig': {'CompiledOutputConfig': {'S3OutputUri': 'string'},
'KmsKeyId': 'string'}}
Starts a recommendation job. You can create either an instance recommendation or load test job.
See also: AWS API Documentation
Request Syntax
client.create_inference_recommendations_job(
JobName='string',
JobType='Default'|'Advanced',
RoleArn='string',
InputConfig={
'ModelPackageVersionArn': 'string',
'JobDurationInSeconds': 123,
'TrafficPattern': {
'TrafficType': 'PHASES',
'Phases': [
{
'InitialNumberOfUsers': 123,
'SpawnRate': 123,
'DurationInSeconds': 123
},
]
},
'ResourceLimit': {
'MaxNumberOfTests': 123,
'MaxParallelOfTests': 123
},
'EndpointConfigurations': [
{
'InstanceType': 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge',
'InferenceSpecificationName': 'string',
'EnvironmentParameterRanges': {
'CategoricalParameterRanges': [
{
'Name': 'string',
'Value': [
'string',
]
},
]
}
},
],
'VolumeKmsKeyId': 'string'
},
JobDescription='string',
StoppingConditions={
'MaxInvocations': 123,
'ModelLatencyThresholds': [
{
'Percentile': 'string',
'ValueInMilliseconds': 123
},
]
},
OutputConfig={
'KmsKeyId': 'string',
'CompiledOutputConfig': {
'S3OutputUri': 'string'
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
string
[REQUIRED]
Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT ) job.
string
[REQUIRED]
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
dict
[REQUIRED]
Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.
ModelPackageVersionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of a versioned model package.
JobDurationInSeconds (integer) --
Specifies the maximum duration of the job, in seconds.>
TrafficPattern (dict) --
Specifies the traffic pattern of the job.
TrafficType (string) --
Defines the traffic patterns.
Phases (list) --
Defines the phases traffic specification.
(dict) --
Defines the traffic pattern.
InitialNumberOfUsers (integer) --
Specifies how many concurrent users to start with.
SpawnRate (integer) --
Specified how many new users to spawn in a minute.
DurationInSeconds (integer) --
Specifies how long traffic phase should be.
ResourceLimit (dict) --
Defines the resource limit of the job.
MaxNumberOfTests (integer) --
Defines the maximum number of load tests.
MaxParallelOfTests (integer) --
Defines the maximum number of parallel load tests.
EndpointConfigurations (list) --
Specifies the endpoint configuration to use for a job.
(dict) --
The endpoint configuration for the load test.
InstanceType (string) -- [REQUIRED]
The instance types to use for the load test.
InferenceSpecificationName (string) --
The inference specification name in the model package version.
EnvironmentParameterRanges (dict) --
The parameter you want to benchmark against.
CategoricalParameterRanges (list) --
Specified a list of parameters for each category.
(dict) --
Environment parameters you want to benchmark your load test against.
Name (string) -- [REQUIRED]
The Name of the environment variable.
Value (list) -- [REQUIRED]
The list of values you can pass.
(string) --
VolumeKmsKeyId (string) --
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
string
Description of the recommendation job.
dict
A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.
MaxInvocations (integer) --
The maximum number of requests per minute expected for the endpoint.
ModelLatencyThresholds (list) --
The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
(dict) --
The model latency threshold.
Percentile (string) --
The model latency percentile threshold.
ValueInMilliseconds (integer) --
The model latency percentile value in milliseconds.
dict
Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.
KmsKeyId (string) --
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
CompiledOutputConfig (dict) --
Provides information about the output configuration for the compiled model.
S3OutputUri (string) --
Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
list
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
(dict) --
A tag object that consists of a key and an optional value, used to manage metadata for SageMaker Amazon Web Services resources.
You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints. For more information on adding tags to SageMaker resources, see AddTags .
For more information on adding metadata to your Amazon Web Services resources with tagging, see Tagging Amazon Web Services resources . For advice on best practices for managing Amazon Web Services resources with tagging, see Tagging Best Practices: Implement an Effective Amazon Web Services Resource Tagging Strategy .
Key (string) -- [REQUIRED]
The tag key. Tag keys must be unique per resource.
Value (string) -- [REQUIRED]
The tag value.
dict
Response Syntax
{
'JobArn': 'string'
}
Response Structure
(dict) --
JobArn (string) --
The Amazon Resource Name (ARN) of the recommendation job.
{'InputConfig': {'VolumeKmsKeyId': 'string'}}
Provides the results of the Inference Recommender job. One or more recommendation jobs are returned.
See also: AWS API Documentation
Request Syntax
client.describe_inference_recommendations_job(
JobName='string'
)
string
[REQUIRED]
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
dict
Response Syntax
{
'JobName': 'string',
'JobDescription': 'string',
'JobType': 'Default'|'Advanced',
'JobArn': 'string',
'RoleArn': 'string',
'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'|'STOPPING'|'STOPPED',
'CreationTime': datetime(2015, 1, 1),
'CompletionTime': datetime(2015, 1, 1),
'LastModifiedTime': datetime(2015, 1, 1),
'FailureReason': 'string',
'InputConfig': {
'ModelPackageVersionArn': 'string',
'JobDurationInSeconds': 123,
'TrafficPattern': {
'TrafficType': 'PHASES',
'Phases': [
{
'InitialNumberOfUsers': 123,
'SpawnRate': 123,
'DurationInSeconds': 123
},
]
},
'ResourceLimit': {
'MaxNumberOfTests': 123,
'MaxParallelOfTests': 123
},
'EndpointConfigurations': [
{
'InstanceType': 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge',
'InferenceSpecificationName': 'string',
'EnvironmentParameterRanges': {
'CategoricalParameterRanges': [
{
'Name': 'string',
'Value': [
'string',
]
},
]
}
},
],
'VolumeKmsKeyId': 'string'
},
'StoppingConditions': {
'MaxInvocations': 123,
'ModelLatencyThresholds': [
{
'Percentile': 'string',
'ValueInMilliseconds': 123
},
]
},
'InferenceRecommendations': [
{
'Metrics': {
'CostPerHour': ...,
'CostPerInference': ...,
'MaxInvocations': 123,
'ModelLatency': 123
},
'EndpointConfiguration': {
'EndpointName': 'string',
'VariantName': 'string',
'InstanceType': 'ml.t2.medium'|'ml.t2.large'|'ml.t2.xlarge'|'ml.t2.2xlarge'|'ml.m4.xlarge'|'ml.m4.2xlarge'|'ml.m4.4xlarge'|'ml.m4.10xlarge'|'ml.m4.16xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.12xlarge'|'ml.m5.24xlarge'|'ml.m5d.large'|'ml.m5d.xlarge'|'ml.m5d.2xlarge'|'ml.m5d.4xlarge'|'ml.m5d.12xlarge'|'ml.m5d.24xlarge'|'ml.c4.large'|'ml.c4.xlarge'|'ml.c4.2xlarge'|'ml.c4.4xlarge'|'ml.c4.8xlarge'|'ml.p2.xlarge'|'ml.p2.8xlarge'|'ml.p2.16xlarge'|'ml.p3.2xlarge'|'ml.p3.8xlarge'|'ml.p3.16xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.18xlarge'|'ml.c5d.large'|'ml.c5d.xlarge'|'ml.c5d.2xlarge'|'ml.c5d.4xlarge'|'ml.c5d.9xlarge'|'ml.c5d.18xlarge'|'ml.g4dn.xlarge'|'ml.g4dn.2xlarge'|'ml.g4dn.4xlarge'|'ml.g4dn.8xlarge'|'ml.g4dn.12xlarge'|'ml.g4dn.16xlarge'|'ml.r5.large'|'ml.r5.xlarge'|'ml.r5.2xlarge'|'ml.r5.4xlarge'|'ml.r5.12xlarge'|'ml.r5.24xlarge'|'ml.r5d.large'|'ml.r5d.xlarge'|'ml.r5d.2xlarge'|'ml.r5d.4xlarge'|'ml.r5d.12xlarge'|'ml.r5d.24xlarge'|'ml.inf1.xlarge'|'ml.inf1.2xlarge'|'ml.inf1.6xlarge'|'ml.inf1.24xlarge',
'InitialInstanceCount': 123
},
'ModelConfiguration': {
'InferenceSpecificationName': 'string',
'EnvironmentParameters': [
{
'Key': 'string',
'ValueType': 'string',
'Value': 'string'
},
]
}
},
]
}
Response Structure
(dict) --
JobName (string) --
The name of the job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
JobDescription (string) --
The job description that you provided when you initiated the job.
JobType (string) --
The job type that you provided when you initiated the job.
JobArn (string) --
The Amazon Resource Name (ARN) of the job.
RoleArn (string) --
The Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role you provided when you initiated the job.
Status (string) --
The status of the job.
CreationTime (datetime) --
A timestamp that shows when the job was created.
CompletionTime (datetime) --
A timestamp that shows when the job completed.
LastModifiedTime (datetime) --
A timestamp that shows when the job was last modified.
FailureReason (string) --
If the job fails, provides information why the job failed.
InputConfig (dict) --
Returns information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations you provided when you initiated the job.
ModelPackageVersionArn (string) --
The Amazon Resource Name (ARN) of a versioned model package.
JobDurationInSeconds (integer) --
Specifies the maximum duration of the job, in seconds.>
TrafficPattern (dict) --
Specifies the traffic pattern of the job.
TrafficType (string) --
Defines the traffic patterns.
Phases (list) --
Defines the phases traffic specification.
(dict) --
Defines the traffic pattern.
InitialNumberOfUsers (integer) --
Specifies how many concurrent users to start with.
SpawnRate (integer) --
Specified how many new users to spawn in a minute.
DurationInSeconds (integer) --
Specifies how long traffic phase should be.
ResourceLimit (dict) --
Defines the resource limit of the job.
MaxNumberOfTests (integer) --
Defines the maximum number of load tests.
MaxParallelOfTests (integer) --
Defines the maximum number of parallel load tests.
EndpointConfigurations (list) --
Specifies the endpoint configuration to use for a job.
(dict) --
The endpoint configuration for the load test.
InstanceType (string) --
The instance types to use for the load test.
InferenceSpecificationName (string) --
The inference specification name in the model package version.
EnvironmentParameterRanges (dict) --
The parameter you want to benchmark against.
CategoricalParameterRanges (list) --
Specified a list of parameters for each category.
(dict) --
Environment parameters you want to benchmark your load test against.
Name (string) --
The Name of the environment variable.
Value (list) --
The list of values you can pass.
(string) --
VolumeKmsKeyId (string) --
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation.
The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.
The KmsKeyId can be any of the following formats:
// KMS Key ID "1234abcd-12ab-34cd-56ef-1234567890ab"
// Amazon Resource Name (ARN) of a KMS Key "arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
// KMS Key Alias "alias/ExampleAlias"
// Amazon Resource Name (ARN) of a KMS Key Alias "arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
StoppingConditions (dict) --
The stopping conditions that you provided when you initiated the job.
MaxInvocations (integer) --
The maximum number of requests per minute expected for the endpoint.
ModelLatencyThresholds (list) --
The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the container.
(dict) --
The model latency threshold.
Percentile (string) --
The model latency percentile threshold.
ValueInMilliseconds (integer) --
The model latency percentile value in milliseconds.
InferenceRecommendations (list) --
The recommendations made by Inference Recommender.
(dict) --
A list of recommendations made by Amazon SageMaker Inference Recommender.
Metrics (dict) --
The metrics used to decide what recommendation to make.
CostPerHour (float) --
Defines the cost per hour for the instance.
CostPerInference (float) --
Defines the cost per inference for the instance .
MaxInvocations (integer) --
The expected maximum number of requests per minute for the instance.
ModelLatency (integer) --
The expected model latency at maximum invocation per minute for the instance.
EndpointConfiguration (dict) --
Defines the endpoint configuration parameters.
EndpointName (string) --
The name of the endpoint made during a recommendation job.
VariantName (string) --
The name of the production variant (deployed model) made during a recommendation job.
InstanceType (string) --
The instance type recommended by Amazon SageMaker Inference Recommender.
InitialInstanceCount (integer) --
The number of instances recommended to launch initially.
ModelConfiguration (dict) --
Defines the model configuration.
InferenceSpecificationName (string) --
The inference specification name in the model package version.
EnvironmentParameters (list) --
Defines the environment parameters that includes key, value types, and values.
(dict) --
A list of environment parameters suggested by the Amazon SageMaker Inference Recommender.
Key (string) --
The environment key suggested by the Amazon SageMaker Inference Recommender.
ValueType (string) --
The value type suggested by the Amazon SageMaker Inference Recommender.
Value (string) --
The value suggested by the Amazon SageMaker Inference Recommender.