StartServiceSoftwareUpdate - Amazon OpenSearch Service

StartServiceSoftwareUpdate

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Request Syntax

POST /2021-01-01/opensearch/serviceSoftwareUpdate/start HTTP/1.1 Content-type: application/json { "DomainName": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DomainName

The name of the domain that you want to update to the latest service software.

Type: String

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

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ServiceSoftwareOptions": { "AutomatedUpdateDate": number, "Cancellable": boolean, "CurrentVersion": "string", "Description": "string", "NewVersion": "string", "OptionalDeployment": boolean, "UpdateAvailable": boolean, "UpdateStatus": "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.

ServiceSoftwareOptions

The current status of the OpenSearch Service software update.

Type: ServiceSoftwareOptions object

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

InternalException

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

HTTP Status Code: 500

ResourceNotFoundException

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

HTTP Status Code: 409

ValidationException

An exception for missing / invalid input fields. Gives http status code of 400.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: