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 ResizeCluster API operation.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- IamRole
-
The IAM role to assume to run the target action. For more information about this parameter, see ScheduledAction.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- Schedule
-
The schedule in
at( )orcron( )format. For more information about this parameter, see ScheduledAction.Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- ScheduledActionName
-
The name of the scheduled action. The name must be unique within an account. For more information about this parameter, see ScheduledAction.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
- TargetAction
-
A JSON format string of the Amazon Redshift API operation with input parameters. For more information about this parameter, see ScheduledAction.
Type: ScheduledActionType object
Required: Yes
- Enable
-
If true, the schedule is enabled. If false, the scheduled action does not trigger. For more information about
stateof the scheduled action, see ScheduledAction.Type: Boolean
Required: No
- EndTime
-
The end time in UTC of the scheduled action. After this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
Type: Timestamp
Required: No
- ScheduledActionDescription
-
The description of the scheduled action.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- StartTime
-
The start time in UTC of the scheduled action. Before this time, the scheduled action does not trigger. For more information about this parameter, see ScheduledAction.
Type: Timestamp
Required: No
Response Elements
The following elements are returned by the service.
- EndTime
-
The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
Type: Timestamp
- IamRole
-
The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (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
Length Constraints: Maximum length of 2147483647.
- NextInvocations.ScheduledActionTime.N
-
List of times when the scheduled action will run.
Type: Array of timestamps
- Schedule
-
The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.
Format of at expressions is "
at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".Format of cron expressions is "
cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.Type: String
Length Constraints: Maximum length of 2147483647.
- ScheduledActionDescription
-
The description of the scheduled action.
Type: String
Length Constraints: Maximum length of 2147483647.
- ScheduledActionName
-
The name of the scheduled action.
Type: String
Length Constraints: Maximum length of 2147483647.
- StartTime
-
The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
Type: Timestamp
- State
-
The state of the scheduled action. For example,
DISABLED.Type: String
Valid Values:
ACTIVE | DISABLED - TargetAction
-
A JSON format string of the Amazon Redshift API operation with input parameters.
"
{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".Type: ScheduledActionType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFound
-
The
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- InvalidSchedule
-
The schedule you submitted isn't valid.
HTTP Status Code: 400
- InvalidScheduledAction
-
The scheduled action is not valid.
HTTP Status Code: 400
- ScheduledActionAlreadyExists
-
The scheduled action already exists.
HTTP Status Code: 400
- ScheduledActionQuotaExceeded
-
The quota for scheduled actions exceeded.
HTTP Status Code: 400
- ScheduledActionTypeUnsupported
-
The action type specified for a scheduled action is not supported.
HTTP Status Code: 400
- UnauthorizedOperation
-
Your account is not authorized to perform the requested operation.
HTTP Status Code: 400
- UnsupportedOperation
-
The requested operation isn't supported.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
