[ 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-endpoint-weights-and-capacities
--endpoint-name <value>
--desired-weights-and-capacities <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <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.

Shorthand Syntax:

VariantName=string,DesiredWeight=float,DesiredInstanceCount=integer ...

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Output

EndpointArn -> (string)

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