AWS CLI Command Reference

[ aws . es ]

update-clone

Description

Manages a cloned blue/green upgrade that is in progress on a domain. Use it to shift a percentage of search traffic to the cloned cluster, to cut over to the cloned cluster or back to the primary cluster, or to change the retention period. Specify exactly one of TrafficSplitOptions , CutoverOptions , or RetentionOptions in each request.

See also: AWS API Documentation

Synopsis

  update-clone
--domain-name <value>
[--traffic-split-options <value>]
[--cutover-options <value>]
[--retention-options <value>]
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--domain-name (string) [required]

The name of the domain that has a cloned blue/green upgrade in progress.

Constraints:

  • min: 3
  • max: 28
  • pattern: [a-z][a-z0-9\-]+

--traffic-split-options (structure)

Shifts a percentage of search traffic from the primary cluster to the cloned cluster.

Strategy -> (string) [required]

The traffic shifting strategy. The only valid value is ShiftReadTrafficPercent .

Possible values:

  • ShiftReadTrafficPercent

CloneReadTrafficPercent -> (integer) [required]

The percentage of search traffic, from 0 to 100, to send to the cloned cluster. The rest goes to the primary cluster.

Constraints:

  • min: 0
  • max: 100

Shorthand Syntax:

Strategy=string,CloneReadTrafficPercent=integer

JSON Syntax:

{
  "Strategy": "ShiftReadTrafficPercent",
  "CloneReadTrafficPercent": integer
}

--cutover-options (structure)

Cuts the domain over to the cloned cluster or back to the primary cluster.

Target -> (string) [required]

The cluster to cut over to. ClonedCluster makes the cloned cluster serve the domain. PrimaryCluster keeps the primary cluster and ends the upgrade.

Possible values:

  • ClonedCluster
  • PrimaryCluster

Shorthand Syntax:

Target=string

JSON Syntax:

{
  "Target": "ClonedCluster"|"PrimaryCluster"
}

--retention-options (tagged union structure)

Changes the retention period, or ends it after cutover completes.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: RetentionInHours, RetentionAction.

RetentionInHours -> (integer)

The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

RetentionAction -> (string)

Ends the retention period now. Valid only after cutover completes.

Possible values:

  • RollbackToPrimaryCluster
  • DeletePrimaryCluster

Shorthand Syntax:

RetentionInHours=integer,RetentionAction=string

JSON Syntax:

{
  "RetentionInHours": integer,
  "RetentionAction": "RollbackToPrimaryCluster"|"DeletePrimaryCluster"
}

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Output

DomainName -> (string)

The name of the domain.

Constraints:

  • min: 3
  • max: 28
  • pattern: [a-z][a-z0-9\-]+

ChangeId -> (string)

The unique identifier of the configuration change. Use it with DescribeDomainChangeProgress to track the change.

Constraints:

  • pattern: \p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}

CutoverOptions -> (structure)

The requested cutover target and the status of the cutover.

Target -> (string) [required]

The cluster that the domain is cutting over to.

Possible values:

  • ClonedCluster
  • PrimaryCluster

Status -> (string) [required]

The status of the cutover.

Possible values:

  • InProgress
  • Completed
  • Failed

TrafficSplitOptions -> (structure)

The current and requested traffic split, and the status of the traffic shift.

Current -> (structure) [required]

The traffic split currently in effect.

PrimaryReadTrafficPercent -> (integer) [required]

The percentage of search traffic sent to the primary cluster.

Constraints:

  • min: 0
  • max: 100

CloneReadTrafficPercent -> (integer) [required]

The percentage of search traffic sent to the cloned cluster.

Constraints:

  • min: 0
  • max: 100

Target -> (structure) [required]

The requested traffic split.

PrimaryReadTrafficPercent -> (integer) [required]

The percentage of search traffic sent to the primary cluster.

Constraints:

  • min: 0
  • max: 100

CloneReadTrafficPercent -> (integer) [required]

The percentage of search traffic sent to the cloned cluster.

Constraints:

  • min: 0
  • max: 100

Status -> (string) [required]

The status of the traffic shift.

Possible values:

  • InProgress
  • Completed
  • Failed

RetentionOptions -> (tagged union structure)

The retention settings for the upgrade.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: RetentionInHours, RetentionAction.

RetentionInHours -> (integer)

The number of hours to keep the cluster that you cut over from. The retention period starts when cutover completes. The minimum is 1 hour. In an UpdateClone response after cutover completes, this value is the number of hours remaining in the retention period, rounded up.

RetentionAction -> (string)

Ends the retention period now. Valid only after cutover completes.

Possible values:

  • RollbackToPrimaryCluster
  • DeletePrimaryCluster
© Copyright 2026, Amazon Web Services. Created using Sphinx.