Skip to content

Reschedules a planned domain configuration change for a later time

Description

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.

Usage

opensearchservice_update_scheduled_action(DomainName, ActionID,
  ActionType, ScheduleAt, DesiredStartTime)

Arguments

  • DomainName

    [required] The name of the domain to reschedule an action for.

  • ActionID

    [required] The unique identifier of the action to reschedule. To retrieve this ID, send a list_scheduled_actions request.

  • ActionType

    [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 list_scheduled_actions request.

  • ScheduleAt

    [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

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

Value

A list with the following syntax:

list(
  ScheduledAction = 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
  )
)

Request syntax

svc$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
)