/2015-01-01/es/upgradeDomain/{DomainName}/history

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

GET

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'http://es.{region}.amazonaws.com/2015-01-01/es/upgradeDomain//history'

Response Example

200 - Example 1

{
    "UpgradeHistories": [],
    "NextToken": "string"
}

Request

Path Params

DomainName

string

required

Query Params

maxResults

integer

optional

nextToken

string

optional

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Responses

🟢200Success

application/json

Body

Container for response returned by <code> <a>GetUpgradeHistory</a> </code> operation.

UpgradeHistories

array[object (UpgradeHistory) {4}]

optional

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

UpgradeName

string

optional

A string that describes the update briefly

StartTimestamp

string <date-time>

optional

UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.

UpgradeStatus

enum<string>

optional

The overall status of the update. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

Allowed values:

IN_PROGRESSSUCCEEDEDSUCCEEDED_WITH_ISSUESFAILED

StepsList

array[object (UpgradeStepItem) {4}]

optional

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

NextToken

string

optional

Pagination token that needs to be supplied to the next call to get the next page of results

🟠480BaseException

🟠481ResourceNotFoundException

🟠482DisabledOperationException

🟠483ValidationException

🟠484InternalException

Modified at 2023-08-15 04:15:53

/2015-01-01/packages/{PackageID}/history

/2015-01-01/es/upgradeDomain/{DomainName}/status