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

The Amazon Elasticsearch Service multi-region endpoint

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

GET

Retrieves the latest status of the last upgrade or upgrade eligibility check that was 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//status'

Response Example

200 - Example 1

{
    "UpgradeStep": "PRE_UPGRADE_CHECK",
    "StepStatus": "IN_PROGRESS",
    "UpgradeName": "string"
}

Request

Path Params

DomainName

string

required

Responses

🟢200Success

application/json

Body

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

UpgradeStep

enum<string>

optional

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

PreUpgradeCheck
Snapshot
Upgrade

Allowed values:

PRE_UPGRADE_CHECKSNAPSHOTUPGRADE

StepStatus

enum<string>

optional

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

In Progress
Succeeded
Succeeded with Issues
Failed

Allowed values:

IN_PROGRESSSUCCEEDEDSUCCEEDED_WITH_ISSUESFAILED

UpgradeName

string

optional

A string that describes the update briefly

🟠480BaseException

🟠481ResourceNotFoundException

🟠482DisabledOperationException

🟠483ValidationException

🟠484InternalException

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

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

/2015-01-01/domain