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

ListScheduledActions

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

Request Syntax


GET /2021-01-01/opensearch/domain/DomainName/scheduledActions?maxResults=MaxResults&nextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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 ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ScheduledActions": [ 
      { 
         "Cancellable": boolean,
         "Description": "string",
         "Id": "string",
         "Mandatory": boolean,
         "ScheduledBy": "string",
         "ScheduledTime": number,
         "Severity": "string",
         "Status": "string",
         "Type": "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.

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

ScheduledActions

A list of actions that are scheduled for the domain.

Type: Array of ScheduledAction objects

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

InvalidPaginationTokenException

Request processing failed because you provided an invalid pagination token.

HTTP Status Code: 400

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