ListScheduledActionsCommand

Suggest an Edit

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 .

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, ListScheduledActionsCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, ListScheduledActionsCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // ListScheduledActionsRequest
  DomainName: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListScheduledActionsCommand(input);
const response = await client.send(command);
// { // ListScheduledActionsResponse
//   ScheduledActions: [ // ScheduledActionsList
//     { // ScheduledAction
//       Id: "STRING_VALUE", // required
//       Type: "SERVICE_SOFTWARE_UPDATE" || "JVM_HEAP_SIZE_TUNING" || "JVM_YOUNG_GEN_TUNING", // required
//       Severity: "HIGH" || "MEDIUM" || "LOW", // required
//       ScheduledTime: Number("long"), // required
//       Description: "STRING_VALUE",
//       ScheduledBy: "CUSTOMER" || "SYSTEM",
//       Status: "PENDING_UPDATE" || "IN_PROGRESS" || "FAILED" || "COMPLETED" || "NOT_ELIGIBLE" || "ELIGIBLE",
//       Mandatory: true || false,
//       Cancellable: true || false,
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListScheduledActionsCommand Input

See ListScheduledActionsCommandInput for more details

Parameter
Type
Description
DomainName
Required
string | undefined

The name of the domain.

MaxResults
number | undefined

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

NextToken
string | undefined

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.

ListScheduledActionsCommand Output

See ListScheduledActionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

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.

ScheduledActions
ScheduledAction[] | undefined

A list of actions that are scheduled for the domain.

Throws

Name
Fault
Details
BaseException
client

An error occurred while processing the request.

InternalException
server

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

InvalidPaginationTokenException
client

Request processing failed because you provided an invalid pagination token.

ResourceNotFoundException
client

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

ValidationException
client

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

OpenSearchServiceException
Base exception class for all service exceptions from OpenSearch service.