GetUpgradeHistory - Amazon OpenSearch Service


Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Request Syntax

GET /2021-01-01/opensearch/upgradeDomain/DomainName/history?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The name of an existing domain.

Length Constraints: Minimum length of 3. Maximum length of 28.

Pattern: [a-z][a-z0-9\-]+

Required: Yes


An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Valid Range: Maximum value of 100.


If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "UpgradeHistories": [ { "StartTimestamp": number, "StepsList": [ { "Issues": [ "string" ], "ProgressPercent": number, "UpgradeStep": "string", "UpgradeStepStatus": "string" } ], "UpgradeName": "string", "UpgradeStatus": "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.


When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String


A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

Type: Array of UpgradeHistory objects


For information about the errors that are common to all actions, see Common Errors.


An error occurred while processing the request.

HTTP Status Code: 400


An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409


Request processing failed because of an unknown error, exception, or internal failure.

HTTP Status Code: 500


An exception for accessing or deleting a resource that doesn't exist.

HTTP Status Code: 409


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: