Skip to content

StartServiceSoftwareUpdateRequest

Source code in docs_src/capo_opensearch/types/start_service_software_update_request.py 
15
16
17
18
19
20
21
class StartServiceSoftwareUpdateRequest(TypedDict, closed=True):
    domain_name: "capo_opensearch.types.domain_name.DomainName"
    """<p>The name of the domain that you want to update to the latest service software.</p>"""
    schedule_at: NotRequired["capo_opensearch.types.schedule_at.ScheduleAt"]
    """<p>When to start the service software update.</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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.</p> </li> </ul> <p>Default: <code>NOW</code> if you don't specify a value for <code>DesiredStartTime</code>, and <code>TIMESTAMP</code> if you do.</p>"""
    desired_start_time: NotRequired["capo_opensearch.types.long.Long"]
    """<p>The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set <code>ScheduleAt</code> to <code>TIMESTAMP</code>.</p>"""

desired_start_time instance-attribute 

desired_start_time: NotRequired[Long]

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

domain_name instance-attribute 

domain_name: DomainName

The name of the domain that you want to update to the latest service software.

schedule_at instance-attribute 

schedule_at: NotRequired[ScheduleAt]

When to start the service software update.

  • 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 update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.