Skip to content

ScheduledAction

Source code in docs_src/capo_opensearch/types/scheduled_action.py
class ScheduledAction(TypedDict, closed=True):
    id: "capo_opensearch.types.string.String"
    """<p>The unique identifier of the scheduled action.</p>"""
    type: "capo_opensearch.types.action_type.ActionType"
    """<p>The type of action that will be taken on the domain.</p>"""
    severity: "capo_opensearch.types.action_severity.ActionSeverity"
    """<p>The severity of the action.</p>"""
    scheduled_time: "capo_opensearch.types.long.Long"
    """<p>The time when the change is scheduled to happen.</p>"""
    description: NotRequired["capo_opensearch.types.string.String"]
    """<p>A description of the action to be taken.</p>"""
    scheduled_by: NotRequired["capo_opensearch.types.scheduled_by.ScheduledBy"]
    """<p>Whether the action was scheduled manually (<code>CUSTOMER</code>, or by OpenSearch Service automatically (<code>SYSTEM</code>).</p>"""
    status: NotRequired["capo_opensearch.types.action_status.ActionStatus"]
    """<p>The current status of the scheduled action.</p>"""
    mandatory: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether the action is required or optional.</p>"""
    cancellable: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether or not the scheduled action is cancellable.</p>"""

cancellable instance-attribute

cancellable: NotRequired[Boolean]

Whether or not the scheduled action is cancellable.

description instance-attribute

description: NotRequired[String]

A description of the action to be taken.

id instance-attribute

id: String

The unique identifier of the scheduled action.

mandatory instance-attribute

mandatory: NotRequired[Boolean]

Whether the action is required or optional.

scheduled_by instance-attribute

scheduled_by: NotRequired[ScheduledBy]

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

scheduled_time instance-attribute

scheduled_time: Long

The time when the change is scheduled to happen.

severity instance-attribute

severity: ActionSeverity

The severity of the action.

status instance-attribute

status: NotRequired[ActionStatus]

The current status of the scheduled action.

type instance-attribute

type: ActionType

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