The input configuration of the recommendation job.
Contents
- ContainerConfig
-
Specifies mandatory fields for running an Inference Recommender job. The fields specified in
ContainerConfigoverride the corresponding fields in the model package.Type: RecommendationJobContainerConfig object
Required: No
- EndpointConfigurations
-
Specifies the endpoint configuration to use for a job.
Type: Array of EndpointInputConfiguration objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: No
- Endpoints
-
Existing customer endpoints on which to run an Inference Recommender job.
Type: Array of EndpointInfo objects
Array Members: Maximum number of 1 item.
Required: No
- JobDurationInSeconds
-
Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- ModelName
-
The name of the created model.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?Required: No
- ModelPackageVersionArn
-
The Amazon Resource Name (ARN) of a versioned model package.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$Required: No
- ResourceLimit
-
Defines the resource limit of the job.
Type: RecommendationJobResourceLimit object
Required: No
- TrafficPattern
-
Specifies the traffic pattern of the job.
Type: TrafficPattern object
Required: No
- VolumeKmsKeyId
-
The Amazon Resource Name (ARN) of a AWS Key Management Service (AWS 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:CreateGrantpermission 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 havekms:CreateGrantpermission.The
KmsKeyIdcan 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 AWS Key Management Service (AWS KMS) documentation.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^[a-zA-Z0-9:/_-]*$Required: No
-
- VpcConfig
-
Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.
Type: RecommendationJobVpcConfig object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
