Skip to content

CreateScheduledActionRequest

Source code in docs_src/capo_redshift_serverless/types/create_scheduled_action_request.py
class CreateScheduledActionRequest(TypedDict, closed=True):
    scheduled_action_name: (
        "capo_redshift_serverless.types.scheduled_action_name.ScheduledActionName"
    )
    """<p>The name of the scheduled action.</p>"""
    target_action: "capo_redshift_serverless.types.target_action.TargetAction"
    schedule: "capo_redshift_serverless.types.schedule.Schedule"
    """<p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p> <ul> <li> <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p> </li> <li> <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p> </li> </ul>"""
    role_arn: "capo_redshift_serverless.types.iam_role_arn.IamRoleArn"
    """<p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>"""
    namespace_name: "capo_redshift_serverless.types.namespace_name.NamespaceName"
    """<p>The name of the namespace for which to create a scheduled action.</p>"""
    enabled: NotRequired["bool"]
    """<p>Indicates whether 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 href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>"""
    scheduled_action_description: NotRequired["str"]
    """<p>The description of the scheduled action.</p>"""
    start_time: NotRequired["datetime.datetime"]
    """<p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>"""

enabled instance-attribute

enabled: NotRequired[bool]

Indicates whether 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[datetime]

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

namespace_name instance-attribute

namespace_name: NamespaceName

The name of the namespace for which to create a scheduled action.

role_arn instance-attribute

role_arn: IamRoleArn

The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Management Guide

schedule instance-attribute

schedule: Schedule

The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

  • Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

  • Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

scheduled_action_description instance-attribute

scheduled_action_description: NotRequired[str]

The description of the scheduled action.

scheduled_action_name instance-attribute

scheduled_action_name: ScheduledActionName

The name of the scheduled action.

start_time instance-attribute

start_time: NotRequired[datetime]

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

target_action instance-attribute

target_action: TargetAction