DescribeDomainChangeProgress
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
Request Syntax
GET /2021-01-01/opensearch/domain/DomainName/progress?changeid=ChangeId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- ChangeId
-
The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
Length Constraints: Fixed length of 36.
Pattern:
\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12} - DomainName
-
The name of the domain to get progress information for.
Length Constraints: Minimum length of 3. Maximum length of 28.
Pattern:
[a-z][a-z0-9\-]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ChangeProgressStatus": {
"ChangeId": "string",
"ChangeProgressStages": [
{
"Description": "string",
"LastUpdated": number,
"Name": "string",
"Status": "string"
}
],
"CompletedProperties": [ "string" ],
"ConfigChangeStatus": "string",
"InitiatedBy": "string",
"LastUpdatedTime": number,
"PendingProperties": [ "string" ],
"StartTime": number,
"Status": "string",
"TotalNumberOfStages": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ChangeProgressStatus
-
Container for information about the stages of a configuration change happening on a domain.
Type: ChangeProgressStatusDetails object
Errors
For information about the errors that are common to all actions, see Common Errors.
- BaseException
-
An error occurred while processing the request.
HTTP Status Code: 400
- InternalException
-
Request processing failed because of an unknown error, exception, or internal failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 409
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
