UpdateScheduledAction
Updates a scheduled action.
Request Syntax
{
"enabled": boolean,
"endTime": number,
"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
-
Specifies whether to enable the scheduled action.
Type: Boolean
Required: No
- endTime
-
The end time in UTC of the scheduled action to update.
Type: Timestamp
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 descripion of the scheduled action to update to.
Type: String
Required: No
- scheduledActionName
-
The name of the scheduled action to update to.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 60.
Pattern:
^[a-z0-9-]+$Required: Yes
- startTime
-
The start time in UTC of the scheduled action to update to.
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: No
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 ScheduledAction object that was updated.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
