DescribeSnapshotSchedules - Amazon Redshift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeSnapshotSchedules

Returns a list of snapshot schedules.

Request Parameters

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

ClusterIdentifier

The unique identifier for the cluster whose snapshot schedules you want to view.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

MaxRecords

The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Type: Integer

Required: No

ScheduleIdentifier

A unique identifier for a snapshot schedule.

Type: String

Length Constraints: Maximum length of 2147483647.

Required: No

TagKeys.TagKey.N

The key value for a snapshot schedule tag.

Type: Array of strings

Length Constraints: Maximum length of 2147483647.

Required: No

TagValues.TagValue.N

The value corresponding to the key of the snapshot schedule tag.

Type: Array of strings

Length Constraints: Maximum length of 2147483647.

Required: No

Response Elements

The following elements are returned by the service.

Marker

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

Type: String

Length Constraints: Maximum length of 2147483647.

SnapshotSchedules.SnapshotSchedule.N

A list of SnapshotSchedules.

Type: Array of SnapshotSchedule objects

Errors

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

Examples

Example

This example illustrates one usage of DescribeSnapshotSchedules.

Sample Request

https://redshift.us-east-2.amazonaws.com/ ?Action=DescribeSnapshotSchedules &ClusterIdentifier=mycluster &ScheduleIdentifier=mysnapshotschedule &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

<DescribeSnapshotSchedulesResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <DescribeSnapshotSchedulesResult> <SnapshotSchedules> <SnapshotSchedule> <ScheduleDefinitions> <ScheduleDefinition>rate(12 hours)</ScheduleDefinition> </ScheduleDefinitions> <ScheduleDescription>My schedule description</ScheduleDescription> <AssociatedClusterCount>1</AssociatedClusterCount> <AssociatedClusters> <ClusterAssociatedToSchedule> <ScheduleAssociationState>ACTIVE</ScheduleAssociationState> <ClusterIdentifier>mycluster</ClusterIdentifier> </ClusterAssociatedToSchedule> </AssociatedClusters> <ScheduleIdentifier>mysnapshotschedule</ScheduleIdentifier> <Tags/> </SnapshotSchedule> </SnapshotSchedules> </DescribeSnapshotSchedulesResult> <ResponseMetadata> <RequestId>65030ae0-28d3-11ea-9caa-c956bec1ce87</RequestId> </ResponseMetadata> </DescribeSnapshotSchedulesResponse>

See Also

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