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

describe-domain-change-progress

Description

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-domain-change-progress
--domain-name <value>
[--change-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--domain-name (string)

The domain you want to get the progress information about.

--change-id (string)

The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

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

Output

ChangeProgressStatus -> (structure)

Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

ChangeId -> (string)

The unique change identifier associated with a specific domain configuration change.

StartTime -> (timestamp)

The time at which the configuration change is made on the domain.

Status -> (string)

The overall status of the domain configuration change. This field can take the following values: PENDING , PROCESSING , COMPLETED and FAILED

PendingProperties -> (list)

The list of properties involved in the domain configuration change that are still in pending.

(string)

CompletedProperties -> (list)

The list of properties involved in the domain configuration change that are completed.

(string)

TotalNumberOfStages -> (integer)

The total number of stages required for the configuration change.

ChangeProgressStages -> (list)

The specific stages that the domain is going through to perform the configuration change.

(structure)

A progress stage details of a specific domain configuration change.

Name -> (string)

The name of the specific progress stage.

Status -> (string)

The overall status of a specific progress stage.

Description -> (string)

The description of the progress stage.

LastUpdated -> (timestamp)

The last updated timestamp of the progress stage.