Skip to content

CreateScheduledActionMessage

Source code in docs_src/capo_redshift/types/create_scheduled_action_message.py
class CreateScheduledActionMessage(TypedDict, closed=True):
    scheduled_action_name: NotRequired["capo_redshift.types.string.String"]
    """<p>The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see <a>ScheduledAction</a>. </p>"""
    target_action: NotRequired[
        "capo_redshift.types.scheduled_action_type.ScheduledActionType"
    ]
    """<p>A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see <a>ScheduledAction</a>. </p>"""
    schedule: NotRequired["capo_redshift.types.string.String"]
    """<p>The schedule in <code>at( )</code> or <code>cron( )</code> format. For more information about this parameter, see <a>ScheduledAction</a>.</p>"""
    iam_role: NotRequired["capo_redshift.types.string.String"]
    """<p>The IAM role to assume to run the target action. For more information about this parameter, see <a>ScheduledAction</a>. </p>"""
    scheduled_action_description: NotRequired["capo_redshift.types.string.String"]
    """<p>The description of the scheduled action. </p>"""
    start_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see <a>ScheduledAction</a>.</p>"""
    end_time: NotRequired["capo_redshift.types.t_stamp.TStamp"]
    """<p>The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see <a>ScheduledAction</a>. </p>"""
    enable: NotRequired["capo_redshift.types.boolean_optional.BooleanOptional"]
    """<p>If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a>ScheduledAction</a>. </p>"""

enable instance-attribute

enable: NotRequired[BooleanOptional]

If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

end_time instance-attribute

end_time: NotRequired[TStamp]

The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

iam_role instance-attribute

iam_role: NotRequired[String]

The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.

schedule instance-attribute

schedule: NotRequired[String]

The schedule in at( ) or cron( ) format. For more information about this parameter, see ScheduledAction.

scheduled_action_description instance-attribute

scheduled_action_description: NotRequired[String]

The description of the scheduled action.

scheduled_action_name instance-attribute

scheduled_action_name: NotRequired[String]

The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.

start_time instance-attribute

start_time: NotRequired[TStamp]

The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.

target_action instance-attribute

target_action: NotRequired[ScheduledActionType]

A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.