Skip to content

ProductionVariantSummary

Source code in docs_src/capo_sagemaker/types/production_variant_summary.py
class ProductionVariantSummary(TypedDict, closed=True):
    variant_name: NotRequired["capo_sagemaker.types.variant_name.VariantName"]
    """<p>The name of the variant.</p>"""
    deployed_images: NotRequired["capo_sagemaker.types.deployed_images.DeployedImages"]
    """<p>An array of <code>DeployedImage</code> objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this <code>ProductionVariant</code>.</p>"""
    current_weight: NotRequired["capo_sagemaker.types.variant_weight.VariantWeight"]
    """<p>The weight associated with the variant.</p>"""
    desired_weight: NotRequired["capo_sagemaker.types.variant_weight.VariantWeight"]
    """<p>The requested weight, as specified in the <code>UpdateEndpointWeightsAndCapacities</code> request. </p>"""
    current_instance_count: NotRequired["capo_sagemaker.types.task_count.TaskCount"]
    """<p>The number of instances associated with the variant.</p>"""
    desired_instance_count: NotRequired["capo_sagemaker.types.task_count.TaskCount"]
    """<p>The number of instances requested in the <code>UpdateEndpointWeightsAndCapacities</code> request. </p>"""
    instance_pools: NotRequired[
        "capo_sagemaker.types.instance_pool_summary_list.InstancePoolSummaryList"
    ]
    """<p>A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.</p>"""
    variant_status: NotRequired[
        "capo_sagemaker.types.production_variant_status_list.ProductionVariantStatusList"
    ]
    """<p>The endpoint variant status which describes the current deployment stage status or operational status.</p>"""
    current_serverless_config: NotRequired[
        "capo_sagemaker.types.production_variant_serverless_config.ProductionVariantServerlessConfig"
    ]
    """<p>The serverless configuration for the endpoint.</p>"""
    desired_serverless_config: NotRequired[
        "capo_sagemaker.types.production_variant_serverless_config.ProductionVariantServerlessConfig"
    ]
    """<p>The serverless configuration requested for the endpoint update.</p>"""
    managed_instance_scaling: NotRequired[
        "capo_sagemaker.types.production_variant_managed_instance_scaling.ProductionVariantManagedInstanceScaling"
    ]
    """<p>Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic. </p>"""
    routing_config: NotRequired[
        "capo_sagemaker.types.production_variant_routing_config.ProductionVariantRoutingConfig"
    ]
    """<p>Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.</p>"""
    capacity_reservation_config: NotRequired[
        "capo_sagemaker.types.production_variant_capacity_reservation_summary.ProductionVariantCapacityReservationSummary"
    ]
    """<p>Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint. </p>"""

capacity_reservation_config instance-attribute

capacity_reservation_config: NotRequired[ProductionVariantCapacityReservationSummary]

Settings for the capacity reservation for the compute instances that SageMaker AI reserves for an endpoint.

current_instance_count instance-attribute

current_instance_count: NotRequired[TaskCount]

The number of instances associated with the variant.

current_serverless_config instance-attribute

current_serverless_config: NotRequired[ProductionVariantServerlessConfig]

The serverless configuration for the endpoint.

current_weight instance-attribute

current_weight: NotRequired[VariantWeight]

The weight associated with the variant.

deployed_images instance-attribute

deployed_images: NotRequired[DeployedImages]

An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

desired_instance_count instance-attribute

desired_instance_count: NotRequired[TaskCount]

The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

desired_serverless_config instance-attribute

desired_serverless_config: NotRequired[ProductionVariantServerlessConfig]

The serverless configuration requested for the endpoint update.

desired_weight instance-attribute

desired_weight: NotRequired[VariantWeight]

The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

instance_pools instance-attribute

instance_pools: NotRequired[InstancePoolSummaryList]

A list of instance pools for the production variant. Each pool indicates the instance type and the current number of instances of that type.

managed_instance_scaling instance-attribute

managed_instance_scaling: NotRequired[ProductionVariantManagedInstanceScaling]

Settings that control the range in the number of instances that the endpoint provisions as it scales up or down to accommodate traffic.

routing_config instance-attribute

routing_config: NotRequired[ProductionVariantRoutingConfig]

Settings that control how the endpoint routes incoming traffic to the instances that the endpoint hosts.

variant_name instance-attribute

variant_name: NotRequired[VariantName]

The name of the variant.

variant_status instance-attribute

variant_status: NotRequired[ProductionVariantStatusList]

The endpoint variant status which describes the current deployment stage status or operational status.