ModifySnapshotSchedule
Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ScheduleDefinitions.ScheduleDefinition.N
-
An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, "cron(30 12 *)" or "rate(12 hours)".
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: Yes
- ScheduleIdentifier
-
A unique alphanumeric identifier of the schedule to modify.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: Yes
Response Elements
The following elements are returned by the service.
- AssociatedClusterCount
-
The number of clusters associated with the schedule.
Type: Integer
- AssociatedClusters.ClusterAssociatedToSchedule.N
-
A list of clusters associated with the schedule. A maximum of 100 clusters is returned.
Type: Array of ClusterAssociatedToSchedule objects
- NextInvocations.SnapshotTime.N
-
Type: Array of timestamps
- ScheduleDefinitions.ScheduleDefinition.N
-
A list of ScheduleDefinitions.
Type: Array of strings
Length Constraints: Maximum length of 2147483647.
- ScheduleDescription
-
The description of the schedule.
Type: String
Length Constraints: Maximum length of 2147483647.
- ScheduleIdentifier
-
A unique identifier for the schedule.
Type: String
Length Constraints: Maximum length of 2147483647.
- Tags.Tag.N
-
An optional set of tags describing the schedule.
Type: Array of Tag objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidSchedule
-
The schedule you submitted isn't valid.
HTTP Status Code: 400
- SnapshotScheduleNotFound
-
We could not find the specified snapshot schedule.
HTTP Status Code: 400
- SnapshotScheduleUpdateInProgress
-
The specified snapshot schedule is already being updated.
HTTP Status Code: 400
Examples
Example
This example sets a snapshot schedule to the rate of every 10 hours.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=ModifySnapshotSchedule
&ScheduleIdentifier=mysnapshotschedule
&ScheduleDefinitions.ScheduleDefinition.1=rate%2810+hours%29
&SignatureMethod=HmacSHA256&SignatureVersion=4
&Version=2012-12-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request
&X-Amz-Date=20190825T160000Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7b
Sample Response
<ModifySnapshotScheduleResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<ModifySnapshotScheduleResult>
<ScheduleDefinitions>
<ScheduleDefinition>rate(10 hours)</ScheduleDefinition>
</ScheduleDefinitions>
<ScheduleDescription>My schedule description</ScheduleDescription>
<ScheduleIdentifier>mysnapshotschedule</ScheduleIdentifier>
<Tags/>
</ModifySnapshotScheduleResult>
<ResponseMetadata>
<RequestId>8c27532d-28f4-11ea-a940-1b28a85fd753</RequestId>
</ResponseMetadata>
</ModifySnapshotScheduleResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: