List Scheduled Actions

opensearchservice_list_scheduled_actions

R Documentation

Retrieves a list of configuration changes that are scheduled for a domain¶

Description¶

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.

Usage¶

opensearchservice_list_scheduled_actions(DomainName, MaxResults,
  NextToken)

Arguments¶

DomainName

[required] The name of the domain.

MaxResults

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

NextToken

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

Value¶

A list with the following syntax:

list(
  ScheduledActions = list(
    list(
      Id = "string",
      Type = "SERVICE_SOFTWARE_UPDATE"|"JVM_HEAP_SIZE_TUNING"|"JVM_YOUNG_GEN_TUNING",
      Severity = "HIGH"|"MEDIUM"|"LOW",
      ScheduledTime = 123,
      Description = "string",
      ScheduledBy = "CUSTOMER"|"SYSTEM",
      Status = "PENDING_UPDATE"|"IN_PROGRESS"|"FAILED"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE",
      Mandatory = TRUE|FALSE,
      Cancellable = TRUE|FALSE
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_scheduled_actions(
  DomainName = "string",
  MaxResults = 123,
  NextToken = "string"
)