/2015-01-01/es/serviceSoftwareUpdate/cancel - Amazon Elasticsearch Service

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/serviceSoftwareUpdate/cancel' \ --header 'Content-Type: application/json' \ --data-raw '{ "DomainName": "string" }'

{ "ServiceSoftwareOptions": { "CurrentVersion": "string", "NewVersion": "string", "UpdateAvailable": true, "Cancellable": true, "UpdateStatus": "PENDING_UPDATE", "Description": "string", "AutomatedUpdateDate": "string", "OptionalDeployment": true } }

Request

Body Params application/json

DomainName

string

required

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

>= 3 characters<= 28 characters

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

The result of a <code>CancelElasticsearchServiceSoftwareUpdate</code> operation. Contains the status of the update.

ServiceSoftwareOptions

object

optional

The current status of the Elasticsearch service software update.

CurrentVersion

string

optional

The current service software version that is present on the domain.

NewVersion

string

optional

The new service software version if one is available.

UpdateAvailable

boolean

optional

True if you are able to update you service software version. False if you are not able to update your service software version.

Cancellable

boolean

optional

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

UpdateStatus

enum<string>

optional

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

Allowed values:

PENDING_UPDATEIN_PROGRESSCOMPLETEDNOT_ELIGIBLEELIGIBLE

Description

string

optional

The description of the UpdateStatus.

AutomatedUpdateDate

string <date-time>

optional

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

OptionalDeployment

boolean

optional

True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.

🟠480BaseException

🟠481InternalException

🟠482ResourceNotFoundException

🟠483ValidationException