list_scheduled_actions

OpenSearchService.Client.list_scheduled_actions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_scheduled_actions(
    DomainName='string',
    MaxResults=123,
    NextToken='string'
)

Parameters

• DomainName (string) --

  [REQUIRED]

  The name of the domain.

• MaxResults (integer) -- 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) -- 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.

Return type

dict

Returns

Response Syntax

{
    'ScheduledActions': [
        {
            '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'
}

Response Structure

• (dict) --

  • ScheduledActions (list) --

    A list of actions that are scheduled for the domain.

    • (dict) --

      Information about a scheduled configuration change for an OpenSearch Service domain. This actions can be a service software update or a blue/green Auto-Tune enhancement.

      • Id (string) --

        The unique identifier of the scheduled action.

      • Type (string) --

        The type of action that will be taken on the domain.

      • Severity (string) --

        The severity of the action.

      • ScheduledTime (integer) --

        The time when the change is scheduled to happen.

      • Description (string) --

        A description of the action to be taken.

      • ScheduledBy (string) --

        Whether the action was scheduled manually ( CUSTOMER , or by OpenSearch Service automatically ( SYSTEM ).

      • Status (string) --

        The current status of the scheduled action.

      • Mandatory (boolean) --

        Whether the action is required or optional.

      • Cancellable (boolean) --

        Whether or not the scheduled action is cancellable.

  • NextToken (string) --

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

Exceptions

• OpenSearchService.Client.exceptions.BaseException
• OpenSearchService.Client.exceptions.InternalException
• OpenSearchService.Client.exceptions.ResourceNotFoundException
• OpenSearchService.Client.exceptions.InvalidPaginationTokenException
• OpenSearchService.Client.exceptions.ValidationException