Skip to content

CreateInferenceRecommendationsJobRequest

Source code in docs_src/capo_sagemaker/types/create_inference_recommendations_job_request.py
class CreateInferenceRecommendationsJobRequest(TypedDict, closed=True):
    job_name: NotRequired[
        "capo_sagemaker.types.recommendation_job_name.RecommendationJobName"
    ]
    """<p>A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.</p>"""
    job_type: NotRequired[
        "capo_sagemaker.types.recommendation_job_type.RecommendationJobType"
    ]
    """<p>Defines the type of recommendation job. Specify <code>Default</code> to initiate an instance recommendation and <code>Advanced</code> to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (<code>DEFAULT</code>) job.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>"""
    input_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_input_config.RecommendationJobInputConfig"
    ]
    """<p>Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.</p>"""
    job_description: NotRequired[
        "capo_sagemaker.types.recommendation_job_description.RecommendationJobDescription"
    ]
    """<p>Description of the recommendation job.</p>"""
    stopping_conditions: NotRequired[
        "capo_sagemaker.types.recommendation_job_stopping_conditions.RecommendationJobStoppingConditions"
    ]
    """<p>A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.</p>"""
    output_config: NotRequired[
        "capo_sagemaker.types.recommendation_job_output_config.RecommendationJobOutputConfig"
    ]
    """<p>Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the Amazon Web Services General Reference.</p>"""

input_config instance-attribute

input_config: NotRequired[RecommendationJobInputConfig]

Provides information about the versioned model package Amazon Resource Name (ARN), the traffic pattern, and endpoint configurations.

job_description instance-attribute

job_description: NotRequired[RecommendationJobDescription]

Description of the recommendation job.

job_name instance-attribute

job_name: NotRequired[RecommendationJobName]

A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.

job_type instance-attribute

job_type: NotRequired[RecommendationJobType]

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.

output_config instance-attribute

output_config: NotRequired[RecommendationJobOutputConfig]

Provides information about the output artifacts and the KMS key to use for Amazon S3 server-side encryption.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

stopping_conditions instance-attribute

stopping_conditions: NotRequired[RecommendationJobStoppingConditions]

A set of conditions for stopping a recommendation job. If any of the conditions are met, the job is automatically stopped.

tags instance-attribute

tags: NotRequired[TagList]

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.