Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465272236.5 KB

Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the <code>CreateSnapshot</code> API operation.

post/#X-Amz-Target=RedshiftServerless.CreateScheduledAction

Headers

X-Amz-Target'RedshiftServerless.CreateScheduledAction' required

Request body

enabledboolean

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>.

endTimestring date-time

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

namespaceNamestring required

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

roleArnstring required

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

scheduledActionDescriptionstring

The description of the scheduled action.

scheduledActionNamestring required

The name of the scheduled action.

startTimestring date-time

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

Response

Success