CreateSnapshotSchedule - Amazon Redshift

CreateSnapshotSchedule

Creates a snapshot schedule with the rate of every 12 hours.

Request Parameters

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

DryRun

Type: Boolean

Required: No

NextInvocations

Type: Integer

Required: No

ScheduleDefinitions.ScheduleDefinition.N

The definition of the snapshot schedule. The definition is made up of schedule expressions, for example "cron(30 12 *)" or "rate(12 hours)".

Type: Array of strings

Required: No

ScheduleDescription

The description of the snapshot schedule.

Type: String

Required: No

ScheduleIdentifier

A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

Type: String

Required: No

Tags.Tag.N

An optional set of tags you can use to search for the schedule.

Type: Array of Tag objects

Required: No

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

ScheduleDescription

The description of the schedule.

Type: String

ScheduleIdentifier

A unique identifier for the schedule.

Type: String

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

ScheduleDefinitionTypeUnsupported

The definition you submitted is not supported.

HTTP Status Code: 400

SnapshotScheduleAlreadyExists

The specified snapshot schedule already exists.

HTTP Status Code: 400

SnapshotScheduleQuotaExceeded

You have exceeded the quota of snapshot schedules.

HTTP Status Code: 400

TagLimitExceededFault

You have exceeded the number of tags allowed.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=CreateSnapshotSchedule &ScheduleDefinitions.ScheduleDefinition.1=rate%2812+hours%29 &ScheduleIdentifier=mysnapshotschedule &ScheduleDescription=My+schedule+description &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

<CreateSnapshotScheduleResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <CreateSnapshotScheduleResult> <ScheduleDefinitions> <ScheduleDefinition>rate(12 hours)</ScheduleDefinition> </ScheduleDefinitions> <ScheduleDescription>My schedule description</ScheduleDescription> <ScheduleIdentifier>mysnapshotschedule</ScheduleIdentifier> <Tags/> </CreateSnapshotScheduleResult> <ResponseMetadata> <RequestId>6f3e2f58-2837-11ea-9939-5fccefa818c0</RequestId> </ResponseMetadata> </CreateSnapshotScheduleResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: