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 ]

update-endpoint-weights-and-capacities

Description

Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, SageMaker 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.

See also: AWS API Documentation

Synopsis

  update-endpoint-weights-and-capacities
--endpoint-name <value>
--desired-weights-and-capacities <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--endpoint-name (string)

The name of an existing SageMaker endpoint.

--desired-weights-and-capacities (list)

An object that provides new capacity and weight values for a variant.

(structure)

Specifies weight and capacity values for a production variant.

VariantName -> (string)

The name of the variant to update.

DesiredWeight -> (float)

The variant's weight.

DesiredInstanceCount -> (integer)

The variant's capacity.

ServerlessUpdateConfig -> (structure)

Specifies the serverless update concurrency configuration for an endpoint variant.

MaxConcurrency -> (integer)

The updated maximum number of concurrent invocations your serverless endpoint can process.

ProvisionedConcurrency -> (integer)

The updated amount of provisioned concurrency to allocate for the serverless endpoint. Should be less than or equal to MaxConcurrency .

Shorthand Syntax:

VariantName=string,DesiredWeight=float,DesiredInstanceCount=integer,ServerlessUpdateConfig={MaxConcurrency=integer,ProvisionedConcurrency=integer} ...

JSON Syntax:

[
  {
    "VariantName": "string",
    "DesiredWeight": float,
    "DesiredInstanceCount": integer,
    "ServerlessUpdateConfig": {
      "MaxConcurrency": integer,
      "ProvisionedConcurrency": integer
    }
  }
  ...
]

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

EndpointArn -> (string)

The Amazon Resource Name (ARN) of the updated endpoint.