ScheduledActionResponse - Amazon Redshift Serverless

ScheduledActionResponse

The returned scheduled action object.

Contents

endTime

The end time of

Type: Timestamp

Required: No

namespaceName

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

Type: String

Length Constraints: Minimum length of 3. Maximum length of 64.

Pattern: ^[a-z0-9-]+$

Required: No

nextInvocations

An array of timestamps of when the next scheduled actions will trigger.

Type: Array of timestamps

Required: No

roleArn

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

Type: String

Required: No

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.

Type: Schedule object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

scheduledActionDescription

The description of the scheduled action.

Type: String

Required: No

scheduledActionName

The name of the scheduled action.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 60.

Pattern: ^[a-z0-9-]+$

Required: No

scheduledActionUuid

The uuid of the scheduled action.

Type: String

Required: No

startTime

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

Type: Timestamp

Required: No

state

The state of the scheduled action.

Type: String

Valid Values: ACTIVE | DISABLED

Required: No

targetAction

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"

Type: TargetAction object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: