GetUpgradeStatus
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
Request Syntax
GET /2021-01-01/opensearch/upgradeDomain/DomainName/status HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- DomainName
-
The domain of the domain to get upgrade status 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
{
"StepStatus": "string",
"UpgradeName": "string",
"UpgradeStep": "string"
}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.
- StepStatus
-
The status of the current step that an upgrade is on.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | SUCCEEDED_WITH_ISSUES | FAILED - UpgradeName
-
A string that describes the update.
Type: String
- UpgradeStep
-
One of three steps that an upgrade or upgrade eligibility check goes through.
Type: String
Valid Values:
PRE_UPGRADE_CHECK | SNAPSHOT | UPGRADE
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
- DisabledOperationException
-
An error occured because the client wanted to access an unsupported operation.
HTTP Status Code: 409
- 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:
