/2015-01-01/es/domain/{DomainName}/progress - Amazon Elasticsearch Service

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

{ "ChangeProgressStatus": { "ChangeId": "string", "StartTime": "string", "Status": "PENDING", "PendingProperties": [], "CompletedProperties": [], "TotalNumberOfStages": 0, "ChangeProgressStages": [] } }

Request

Path Params

DomainName

string

required

The domain you want to get the progress information about.

Query Params

changeid

string

optional

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.

Responses

🟢200Success

application/json

Body

The result of a <code>DescribeDomainChangeProgress</code> request. Contains the progress information of the requested domain change.

ChangeProgressStatus

object

optional

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

ChangeId

string

optional

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

Match pattern:

\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}

StartTime

string <date-time>

optional

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

Status

enum<string>

optional

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

Allowed values:

PENDINGPROCESSINGCOMPLETEDFAILED

PendingProperties

array[string]

optional

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

CompletedProperties

array[string]

optional

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

TotalNumberOfStages

integer

optional

The total number of stages required for the configuration change.

ChangeProgressStages

array[object (ChangeProgressStage) {4}]

optional

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

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483ValidationException