Skip to content

RecommendationJobInputConfig

Source code in docs_src/capo_sagemaker/types/recommendation_job_input_config.py
class RecommendationJobInputConfig(TypedDict, closed=True):
    model_package_version_arn: NotRequired[
        "capo_sagemaker.types.model_package_arn.ModelPackageArn"
    ]
    """<p>The Amazon Resource Name (ARN) of a versioned model package.</p>"""
    model_name: NotRequired["capo_sagemaker.types.model_name.ModelName"]
    """<p>The name of the created model.</p>"""
    job_duration_in_seconds: NotRequired[
        "capo_sagemaker.types.job_duration_in_seconds.JobDurationInSeconds"
    ]
    """<p>Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.</p>"""
    traffic_pattern: NotRequired["capo_sagemaker.types.traffic_pattern.TrafficPattern"]
    """<p>Specifies the traffic pattern of the job.</p>"""
    resource_limit: NotRequired[
        "capo_sagemaker.types.recommendation_job_resource_limit.RecommendationJobResourceLimit"
    ]
    """<p>Defines the resource limit of the job.</p>"""
    endpoint_configurations: NotRequired[
        "capo_sagemaker.types.endpoint_input_configurations.EndpointInputConfigurations"
    ]
    """<p>Specifies the endpoint configuration to use for a job.</p>"""
    volume_kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>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. </p> <p>The SageMaker execution role must have <code>kms:CreateGrant</code> 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 <code>kms:CreateGrant</code> permission.</p> <p>The <code>KmsKeyId</code> can be any of the following formats:</p> <ul> <li> <p>// KMS Key ID</p> <p> <code>"1234abcd-12ab-34cd-56ef-1234567890ab"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key</p> <p> <code>"arn:aws:kms:&lt;region&gt;:&lt;account&gt;:key/&lt;key-id-12ab-34cd-56ef-1234567890ab&gt;"</code> </p> </li> <li> <p>// KMS Key Alias</p> <p> <code>"alias/ExampleAlias"</code> </p> </li> <li> <p>// Amazon Resource Name (ARN) of a KMS Key Alias</p> <p> <code>"arn:aws:kms:&lt;region&gt;:&lt;account&gt;:alias/&lt;ExampleAlias&gt;"</code> </p> </li> </ul> <p>For more information about key identifiers, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-id">Key identifiers (KeyID)</a> in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.</p>"""
    container_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_container_config.RecommendationJobContainerConfig"
    ]
    """<p>Specifies mandatory fields for running an Inference Recommender job. The fields specified in <code>ContainerConfig</code> override the corresponding fields in the model package.</p>"""
    endpoints: NotRequired["capo_sagemaker.types.endpoints.Endpoints"]
    """<p>Existing customer endpoints on which to run an Inference Recommender job.</p>"""
    vpc_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_vpc_config.RecommendationJobVpcConfig"
    ]
    """<p>Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.</p>"""

container_config instance-attribute

container_config: NotRequired[RecommendationJobContainerConfig]

Specifies mandatory fields for running an Inference Recommender job. The fields specified in ContainerConfig override the corresponding fields in the model package.

endpoint_configurations instance-attribute

endpoint_configurations: NotRequired[EndpointInputConfigurations]

Specifies the endpoint configuration to use for a job.

endpoints instance-attribute

endpoints: NotRequired[Endpoints]

Existing customer endpoints on which to run an Inference Recommender job.

job_duration_in_seconds instance-attribute

job_duration_in_seconds: NotRequired[JobDurationInSeconds]

Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.

model_name instance-attribute

model_name: NotRequired[ModelName]

The name of the created model.

model_package_version_arn instance-attribute

model_package_version_arn: NotRequired[ModelPackageArn]

The Amazon Resource Name (ARN) of a versioned model package.

resource_limit instance-attribute

resource_limit: NotRequired[RecommendationJobResourceLimit]

Defines the resource limit of the job.

traffic_pattern instance-attribute

traffic_pattern: NotRequired[TrafficPattern]

Specifies the traffic pattern of the job.

volume_kms_key_id instance-attribute

volume_kms_key_id: NotRequired[KmsKeyId]

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.

vpc_config instance-attribute

vpc_config: NotRequired[RecommendationJobVpcConfig]

Inference Recommender provisions SageMaker endpoints with access to VPC in the inference recommendation job.