Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateScheduledAction

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 CreateSnapshot API operation.

Request Syntax


{
   "enabled": boolean,
   "endTime": number,
   "namespaceName": "string",
   "roleArn": "string",
   "schedule": { ... },
   "scheduledActionDescription": "string",
   "scheduledActionName": "string",
   "startTime": number,
   "targetAction": { ... }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

enabled

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.

Type: Boolean

Required: No

endTime

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

Type: Timestamp

Required: No

namespaceName

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

Type: String

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

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

Required: Yes

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 Cluster Management Guide

Type: String

Required: Yes

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: Yes

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: Yes

startTime

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

Type: Timestamp

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: Yes

Response Syntax


{
   "scheduledAction": { 
      "endTime": number,
      "namespaceName": "string",
      "nextInvocations": [ number ],
      "roleArn": "string",
      "schedule": { ... },
      "scheduledActionDescription": "string",
      "scheduledActionName": "string",
      "scheduledActionUuid": "string",
      "startTime": number,
      "state": "string",
      "targetAction": { ... }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

scheduledAction

The returned ScheduledAction object that describes the properties of a scheduled action.

Type: ScheduledActionResponse object

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

The submitted action has conflicts.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ValidationException

The input failed to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400