Skip to content

UpdateScheduledActionRequest

Source code in docs_src/capo_redshift_serverless/types/update_scheduled_action_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class UpdateScheduledActionRequest(TypedDict, closed=True):
    scheduled_action_name: (
        "capo_redshift_serverless.types.scheduled_action_name.ScheduledActionName"
    )
    """<p>The name of the scheduled action to update to.</p>"""
    target_action: NotRequired[
        "capo_redshift_serverless.types.target_action.TargetAction"
    ]
    schedule: NotRequired["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: NotRequired["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>"""
    enabled: NotRequired["bool"]
    """<p>Specifies whether to enable the scheduled action.</p>"""
    scheduled_action_description: NotRequired["str"]
    """<p>The descripion of the scheduled action to update to.</p>"""
    start_time: NotRequired["datetime.datetime"]
    """<p>The start time in UTC of the scheduled action to update to.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>The end time in UTC of the scheduled action to update.</p>"""

enabled instance-attribute 

enabled: NotRequired[bool]

Specifies whether to enable the scheduled action.

end_time instance-attribute 

end_time: NotRequired[datetime]

The end time in UTC of the scheduled action to update.

role_arn instance-attribute 

role_arn: NotRequired[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: NotRequired[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 descripion of the scheduled action to update to.

scheduled_action_name instance-attribute 

scheduled_action_name: ScheduledActionName

The name of the scheduled action to update to.

start_time instance-attribute 

start_time: NotRequired[datetime]

The start time in UTC of the scheduled action to update to.

target_action instance-attribute 

target_action: NotRequired[TargetAction]