Sign In to the Console
Amazon Redshift
API Reference (API Version 2012-12-01)

AWS Documentation » Amazon Redshift Documentation » API Reference » Actions » DescribeClusterSnapshots

DescribeClusterSnapshots

Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

Request Parameters

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

ClusterExists

A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

  • If ClusterExists is set to true, ClusterIdentifier is required.

  • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

  • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

Type: Boolean

Required: No

ClusterIdentifier

The identifier of the cluster for which information about snapshots is requested.

Type: String

Required: No

EndTime

A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Type: Timestamp

Required: No

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Type: String

Required: No

MaxRecords

The maximum number of 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.

Default: 100

Constraints: minimum 20, maximum 100.

Type: Integer

Required: No

OwnerAccount

The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

Type: String

Required: No

SnapshotIdentifier

The snapshot identifier of the snapshot about which to return information.

Type: String

Required: No

SnapshotType

The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

Valid Values: automated | manual

Type: String

Required: No

SortingEntities.SnapshotSortingEntity.N

Type: Array of SnapshotSortingEntity objects

Required: No

StartTime

A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2012-07-16T18:00:00Z

Type: Timestamp

Required: No

TagKeys.TagKey.N

A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

Type: Array of strings

Required: No

TagValues.TagValue.N

A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

Type: Array of strings

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

Snapshots.Snapshot.N

A list of Snapshot instances.

Type: Array of Snapshot objects

Errors

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

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

ClusterSnapshotNotFound

The snapshot identifier does not refer to an existing cluster snapshot.

HTTP Status Code: 404

InvalidTagFault

The tag is invalid.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=DescribeClusterSnapshots
    &ClusterIdentifier=examplecluster
    &Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request
    &x-amz-date=20130123T011512Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<DescribeClusterSnapshotsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <DescribeClusterSnapshotsResult>
    <Snapshots>
      <Snapshot>
        <Port>5439</Port>
        <SnapshotIdentifier>cm:examplecluster-2013-01-22-19-27-58</SnapshotIdentifier>
        <Status>available</Status>
        <SnapshotType>automated</SnapshotType>
        <ClusterVersion>1.0</ClusterVersion>
        <SnapshotCreateTime>2013-01-22T19:27:58.931Z</SnapshotCreateTime>
        <NumberOfNodes>2</NumberOfNodes>
        <DBName>dev</DBName>
        <ClusterCreateTime>2013-01-22T19:23:59.368Z</ClusterCreateTime>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <NodeType>ds2.xlarge</NodeType>
        <ClusterIdentifier>examplecluster</ClusterIdentifier>
        <MasterUsername>adminuser</MasterUsername>
      </Snapshot>
      <Snapshot>
        <Port>5439</Port>
        <SnapshotIdentifier>my-snapshot-123</SnapshotIdentifier>
        <Status>available</Status>
        <SnapshotType>manual</SnapshotType>
        <ClusterVersion>1.0</ClusterVersion>
        <SnapshotCreateTime>2013-01-23T01:09:03.149Z</SnapshotCreateTime>
        <NumberOfNodes>2</NumberOfNodes>
        <DBName>dev</DBName>
        <ClusterCreateTime>2013-01-22T19:23:59.368Z</ClusterCreateTime>
        <AvailabilityZone>us-east-1c</AvailabilityZone>
        <NodeType>ds2.xlarge</NodeType>
        <ClusterIdentifier>examplecluster</ClusterIdentifier>
        <MasterUsername>adminuser</MasterUsername>
      </Snapshot>
    </Snapshots>
  </DescribeClusterSnapshotsResult>
  <ResponseMetadata>
    <RequestId>56a9daf4-64fa-11e2-a8da-655adc216806</RequestId>
  </ResponseMetadata>
</DescribeClusterSnapshotsResponse>

See Also

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