Skip to content

UpdateScheduledActionRequest

Source code in docs_src/capo_opensearch/types/update_scheduled_action_request.py 
17
18
19
20
21
22
23
24
25
26
27
class UpdateScheduledActionRequest(TypedDict, closed=True):
    domain_name: "capo_opensearch.types.domain_name.DomainName"
    """<p>The name of the domain to reschedule an action for.</p>"""
    action_id: "capo_opensearch.types.string.String"
    """<p>The unique identifier of the action to reschedule. To retrieve this ID, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>"""
    action_type: "capo_opensearch.types.action_type.ActionType"
    """<p>The type of action to reschedule. Can be one of <code>SERVICE_SOFTWARE_UPDATE</code>, <code>JVM_HEAP_SIZE_TUNING</code>, or <code>JVM_YOUNG_GEN_TUNING</code>. To retrieve this value, send a <a href="https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html">ListScheduledActions</a> request.</p>"""
    schedule_at: "capo_opensearch.types.schedule_at.ScheduleAt"
    """<p>When to schedule the action.</p> <ul> <li> <p> <code>NOW</code> - Immediately schedules the update to happen in the current hour if there's capacity available.</p> </li> <li> <p> <code>TIMESTAMP</code> - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for <code>DesiredStartTime</code>.</p> </li> <li> <p> <code>OFF_PEAK_WINDOW</code> - 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.</p> </li> </ul>"""
    desired_start_time: NotRequired["capo_opensearch.types.long.Long"]
    """<p>The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>"""

action_id instance-attribute 

action_id: String

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

action_type instance-attribute 

action_type: ActionType

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.

desired_start_time instance-attribute 

desired_start_time: NotRequired[Long]

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

domain_name instance-attribute 

domain_name: DomainName

The name of the domain to reschedule an action for.

schedule_at instance-attribute 

schedule_at: ScheduleAt

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.