Skip to content

DescribeOptimizationJobResponse

Source code in docs_src/capo_sagemaker/types/describe_optimization_job_response.py
class DescribeOptimizationJobResponse(TypedDict, closed=True):
    optimization_job_arn: NotRequired[
        "capo_sagemaker.types.optimization_job_arn.OptimizationJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the optimization job.</p>"""
    optimization_job_status: NotRequired[
        "capo_sagemaker.types.optimization_job_status.OptimizationJobStatus"
    ]
    """<p>The current status of the optimization job.</p>"""
    optimization_start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the optimization job started.</p>"""
    optimization_end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the optimization job finished processing.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>The time when you created the optimization job.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>The time when the optimization job was last updated.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the optimization job status is <code>FAILED</code>, the reason for the failure.</p>"""
    optimization_job_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The name that you assigned to the optimization job.</p>"""
    model_source: NotRequired[
        "capo_sagemaker.types.optimization_job_model_source.OptimizationJobModelSource"
    ]
    """<p>The location of the source model to optimize with an optimization job.</p>"""
    optimization_environment: NotRequired[
        "capo_sagemaker.types.optimization_job_environment_variables.OptimizationJobEnvironmentVariables"
    ]
    """<p>The environment variables to set in the model container.</p>"""
    deployment_instance_type: NotRequired[
        "capo_sagemaker.types.optimization_job_deployment_instance_type.OptimizationJobDeploymentInstanceType"
    ]
    """<p>The type of instance that hosts the optimized model that you create with the optimization job.</p>"""
    max_instance_count: NotRequired[
        "capo_sagemaker.types.optimization_job_max_instance_count.OptimizationJobMaxInstanceCount"
    ]
    """<p>The maximum number of instances to use for the optimization job.</p>"""
    optimization_configs: NotRequired[
        "capo_sagemaker.types.optimization_configs.OptimizationConfigs"
    ]
    """<p>Settings for each of the optimization techniques that the job applies.</p>"""
    output_config: NotRequired[
        "capo_sagemaker.types.optimization_job_output_config.OptimizationJobOutputConfig"
    ]
    """<p>Details for where to store the optimized model that you create with the optimization job.</p>"""
    optimization_output: NotRequired[
        "capo_sagemaker.types.optimization_output.OptimizationOutput"
    ]
    """<p>Output values produced by an optimization job.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The ARN of the IAM role that you assigned to the optimization job.</p>"""
    stopping_condition: NotRequired[
        "capo_sagemaker.types.stopping_condition.StoppingCondition"
    ]
    vpc_config: NotRequired[
        "capo_sagemaker.types.optimization_vpc_config.OptimizationVpcConfig"
    ]
    """<p>A VPC in Amazon VPC that your optimized model has access to.</p>"""
    training_plan_arns: NotRequired[
        "capo_sagemaker.types.optimization_job_training_plan_arns.OptimizationJobTrainingPlanArns"
    ]
    """<p>The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field.</p>"""

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The time when you created the optimization job.

deployment_instance_type instance-attribute

deployment_instance_type: NotRequired[OptimizationJobDeploymentInstanceType]

The type of instance that hosts the optimized model that you create with the optimization job.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the optimization job status is FAILED, the reason for the failure.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

The time when the optimization job was last updated.

max_instance_count instance-attribute

max_instance_count: NotRequired[OptimizationJobMaxInstanceCount]

The maximum number of instances to use for the optimization job.

model_source instance-attribute

model_source: NotRequired[OptimizationJobModelSource]

The location of the source model to optimize with an optimization job.

optimization_configs instance-attribute

optimization_configs: NotRequired[OptimizationConfigs]

Settings for each of the optimization techniques that the job applies.

optimization_end_time instance-attribute

optimization_end_time: NotRequired[Timestamp]

The time when the optimization job finished processing.

optimization_environment instance-attribute

optimization_environment: NotRequired[OptimizationJobEnvironmentVariables]

The environment variables to set in the model container.

optimization_job_arn instance-attribute

optimization_job_arn: NotRequired[OptimizationJobArn]

The Amazon Resource Name (ARN) of the optimization job.

optimization_job_name instance-attribute

optimization_job_name: NotRequired[EntityName]

The name that you assigned to the optimization job.

optimization_job_status instance-attribute

optimization_job_status: NotRequired[OptimizationJobStatus]

The current status of the optimization job.

optimization_output instance-attribute

optimization_output: NotRequired[OptimizationOutput]

Output values produced by an optimization job.

optimization_start_time instance-attribute

optimization_start_time: NotRequired[Timestamp]

The time when the optimization job started.

output_config instance-attribute

output_config: NotRequired[OptimizationJobOutputConfig]

Details for where to store the optimized model that you create with the optimization job.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The ARN of the IAM role that you assigned to the optimization job.

stopping_condition instance-attribute

stopping_condition: NotRequired[StoppingCondition]

training_plan_arns instance-attribute

training_plan_arns: NotRequired[OptimizationJobTrainingPlanArns]

The Amazon Resource Name (ARN) of the training plan associated with this optimization job. This field appears only when you specified a training plan when you created the job. Optimization jobs that use on-demand capacity don't return this field.

vpc_config instance-attribute

vpc_config: NotRequired[OptimizationVpcConfig]

A VPC in Amazon VPC that your optimized model has access to.