Skip to content

DescribeScheduledActionsMessage

Source code in docs_src/capo_redshift/types/describe_scheduled_actions_message.py
class DescribeScheduledActionsMessage(TypedDict, closed=True):
    scheduled_action_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the scheduled action to retrieve. </p>"""
    target_action_type: NotRequired[
        "capo_redshift.types.scheduled_action_type_values.ScheduledActionTypeValues"
    ]
    """<p>The type of the scheduled actions to retrieve. </p>"""
    start_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.</p>"""
    end_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.</p>"""
    active: NotRequired["capo_redshift.types.boolean_optional.BooleanOptional"]
    """<p>If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions. </p>"""
    filters: NotRequired[
        "capo_redshift.types.scheduled_action_filter_list.ScheduledActionFilterList"
    ]
    """<p>List of scheduled action filters. </p>"""
    marker: NotRequired["capo_redshift.types.string.String"]
    """<p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <a>DescribeScheduledActions</a> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request. </p>"""
    max_records: NotRequired["capo_redshift.types.integer_optional.IntegerOptional"]
    """<p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. </p> <p>Default: <code>100</code> </p> <p>Constraints: minimum 20, maximum 100.</p>"""

active instance-attribute

active: NotRequired[BooleanOptional]

If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.

end_time instance-attribute

end_time: NotRequired[TStamp]

The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.

filters instance-attribute

filters: NotRequired[ScheduledActionFilterList]

List of scheduled action filters.

marker instance-attribute

marker: NotRequired[String]

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeScheduledActions request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

max_records instance-attribute

max_records: NotRequired[IntegerOptional]

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

scheduled_action_name instance-attribute

scheduled_action_name: NotRequired[String]

The name of the scheduled action to retrieve.

start_time instance-attribute

start_time: NotRequired[TStamp]

The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.

target_action_type instance-attribute

target_action_type: NotRequired[ScheduledActionTypeValues]

The type of the scheduled actions to retrieve.