Skip to content

UpdateEndpointInput

Source code in docs_src/capo_sagemaker/types/update_endpoint_input.py
class UpdateEndpointInput(TypedDict, closed=True):
    endpoint_name: NotRequired["capo_sagemaker.types.endpoint_name.EndpointName"]
    """<p>The name of the endpoint whose configuration you want to update.</p>"""
    endpoint_config_name: NotRequired[
        "capo_sagemaker.types.endpoint_config_name.EndpointConfigName"
    ]
    """<p>The name of the new endpoint configuration.</p>"""
    retain_all_variant_properties: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p>"""
    exclude_retained_variant_properties: NotRequired[
        "capo_sagemaker.types.variant_property_list.VariantPropertyList"
    ]
    """<p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden. </p>"""
    deployment_config: NotRequired[
        "capo_sagemaker.types.deployment_config.DeploymentConfig"
    ]
    """<p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p>"""
    retain_deployment_config: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p>"""

deployment_config instance-attribute

deployment_config: NotRequired[DeploymentConfig]

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

endpoint_config_name instance-attribute

endpoint_config_name: NotRequired[EndpointConfigName]

The name of the new endpoint configuration.

endpoint_name instance-attribute

endpoint_name: NotRequired[EndpointName]

The name of the endpoint whose configuration you want to update.

exclude_retained_variant_properties instance-attribute

exclude_retained_variant_properties: NotRequired[VariantPropertyList]

When you are updating endpoint resources with RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeRetainedVariantProperties, no variant properties are overridden.

retain_all_variant_properties instance-attribute

retain_all_variant_properties: NotRequired[Boolean]

When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.

retain_deployment_config instance-attribute

retain_deployment_config: NotRequired[Boolean]

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).