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

ListDomainMaintenances

A list of maintenance actions for the domain.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/domainMaintenances?action=Action&maxResults=MaxResults&nextToken=NextToken&status=Status HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

Action

The name of the action.

Valid Values: REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD

DomainName

The name of the domain.

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

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

Required: Yes

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Valid Range: Maximum value of 100.

NextToken

If your initial ListDomainMaintenances operation returns a nextToken, include the returned nextToken in subsequent ListDomainMaintenances operations, which returns results in the next page.

Status

The status of the action.

Valid Values: PENDING | IN_PROGRESS | COMPLETED | FAILED | TIMED_OUT

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "DomainMaintenances": [ 
      { 
         "Action": "string",
         "CreatedAt": number,
         "DomainName": "string",
         "MaintenanceId": "string",
         "NodeId": "string",
         "Status": "string",
         "StatusMessage": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "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.

DomainMaintenances

A list of the submitted maintenance actions.

Type: Array of DomainMaintenanceDetails objects

NextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

BaseException

An error occurred while processing the request.

message: A description of the error.

HTTP Status Code: 400

DisabledOperationException

An error occured because the client wanted to access an unsupported operation.

HTTP Status Code: 409

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