OpenSearchService / Client / update_scheduled_action

update_scheduled_action

OpenSearchService.Client.update_scheduled_action(**kwargs)

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

See also: AWS API Documentation

Request Syntax

response = client.update_scheduled_action(
    DomainName='string',
    ActionID='string',
    ActionType='SERVICE_SOFTWARE_UPDATE'|'JVM_HEAP_SIZE_TUNING'|'JVM_YOUNG_GEN_TUNING',
    ScheduleAt='NOW'|'TIMESTAMP'|'OFF_PEAK_WINDOW',
    DesiredStartTime=123
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain to reschedule an action for.

  • ActionID (string) –

    [REQUIRED]

    The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

  • ActionType (string) –

    [REQUIRED]

    The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

  • ScheduleAt (string) –

    [REQUIRED]

    When to schedule the action.

    • NOW - Immediately schedules the update to happen in the current hour if there’s capacity available.

    • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

    • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There’s no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

  • DesiredStartTime (integer) – The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ScheduledAction (dict) –

      Information about the rescheduled action.

      • 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.

Exceptions

  • OpenSearchService.Client.exceptions.BaseException

  • OpenSearchService.Client.exceptions.InternalException

  • OpenSearchService.Client.exceptions.ResourceNotFoundException

  • OpenSearchService.Client.exceptions.SlotNotAvailableException

  • OpenSearchService.Client.exceptions.ConflictException

  • OpenSearchService.Client.exceptions.LimitExceededException

  • OpenSearchService.Client.exceptions.ValidationException