Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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

{
   "DesiredStartTime": number,
   "DomainName": "string",
   "ScheduleAt": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

DesiredStartTime

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Type: Long

Required: No

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

ScheduleAt

When to start the service software update.

NOW - Immediately schedules the update to happen in the current hour if there's capacity available.
TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.
OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

Type: String

Valid Values: NOW | TIMESTAMP | OFF_PEAK_WINDOW

Required: No

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.

message: A description of the error.

HTTP Status Code: 400

InternalException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 409

ValidationException

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

HTTP Status Code: 400