Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]



Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

When Amazon SageMaker receives the request, it sets the endpoint status to Updating . After updating the endpoint, it sets the status to InService . To check the status of an endpoint, use the DescribeEndpoint API.


You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig .

If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--endpoint-name <value>
--endpoint-config-name <value>
[--retain-all-variant-properties | --no-retain-all-variant-properties]
[--exclude-retained-variant-properties <value>]
[--deployment-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--endpoint-name (string)

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

--endpoint-config-name (string)

The name of the new endpoint configuration.

--retain-all-variant-properties | --no-retain-all-variant-properties (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 .

--exclude-retained-variant-properties (list)

When you are updating endpoint resources with UpdateEndpointInput$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 ExcludeAllVariantProperties , no variant properties are overridden.


Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the UpdateEndpointInput$RetainAllVariantProperties option set to true , the VariantProperty objects listed in UpdateEndpointInput$ExcludeRetainedVariantProperties override the existing variant properties of the endpoint.

VariantPropertyType -> (string)

The type of variant property. The supported values are:

  • DesiredInstanceCount : Overrides the existing variant instance counts using the ProductionVariant$InitialInstanceCount values in the CreateEndpointConfigInput$ProductionVariants .
  • DesiredWeight : Overrides the existing variant weights using the ProductionVariant$InitialVariantWeight values in the CreateEndpointConfigInput$ProductionVariants .
  • DataCaptureConfig : (Not currently supported.)

Shorthand Syntax:

VariantPropertyType=string ...

JSON Syntax:

    "VariantPropertyType": "DesiredInstanceCount"|"DesiredWeight"|"DataCaptureConfig"

--deployment-config (structure)

The deployment configuration for the endpoint to be updated.

BlueGreenUpdatePolicy -> (structure)

TrafficRoutingConfiguration -> (structure)

Type -> (string)

WaitIntervalInSeconds -> (integer)

CanarySize -> (structure)

Type -> (string)

This API is not supported.

Value -> (integer)

TerminationWaitInSeconds -> (integer)

MaximumExecutionTimeoutInSeconds -> (integer)

AutoRollbackConfiguration -> (structure)

Alarms -> (list)


This API is not supported.

AlarmName -> (string)

JSON Syntax:

  "BlueGreenUpdatePolicy": {
    "TrafficRoutingConfiguration": {
      "Type": "ALL_AT_ONCE"|"CANARY",
      "WaitIntervalInSeconds": integer,
      "CanarySize": {
        "Value": integer
    "TerminationWaitInSeconds": integer,
    "MaximumExecutionTimeoutInSeconds": integer
  "AutoRollbackConfiguration": {
    "Alarms": [
        "AlarmName": "string"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


EndpointArn -> (string)

The Amazon Resource Name (ARN) of the endpoint.