Safe Haskell | None |
---|---|
Language | Haskell2010 |
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.
http://docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusterSnapshots.html
- data DescribeClusterSnapshots
- describeClusterSnapshots :: DescribeClusterSnapshots
- dcs1ClusterIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text)
- dcs1EndTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime)
- dcs1Marker :: Lens' DescribeClusterSnapshots (Maybe Text)
- dcs1MaxRecords :: Lens' DescribeClusterSnapshots (Maybe Int)
- dcs1OwnerAccount :: Lens' DescribeClusterSnapshots (Maybe Text)
- dcs1SnapshotIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text)
- dcs1SnapshotType :: Lens' DescribeClusterSnapshots (Maybe Text)
- dcs1StartTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime)
- dcs1TagKeys :: Lens' DescribeClusterSnapshots [Text]
- dcs1TagValues :: Lens' DescribeClusterSnapshots [Text]
- data DescribeClusterSnapshotsResponse
- describeClusterSnapshotsResponse :: DescribeClusterSnapshotsResponse
- dcsrMarker :: Lens' DescribeClusterSnapshotsResponse (Maybe Text)
- dcsrSnapshots :: Lens' DescribeClusterSnapshotsResponse [Snapshot]
Request
data DescribeClusterSnapshots Source
Request constructor
describeClusterSnapshots :: DescribeClusterSnapshots Source
DescribeClusterSnapshots
constructor.
The fields accessible through corresponding lenses are:
Request lenses
dcs1ClusterIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text) Source
The identifier of the cluster for which information about snapshots is requested.
dcs1EndTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime) Source
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'
dcs1Marker :: Lens' DescribeClusterSnapshots (Maybe Text) Source
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.
dcs1MaxRecords :: Lens' DescribeClusterSnapshots (Maybe Int) Source
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.
dcs1OwnerAccount :: Lens' DescribeClusterSnapshots (Maybe Text) Source
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.
dcs1SnapshotIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text) Source
The snapshot identifier of the snapshot about which to return information.
dcs1SnapshotType :: Lens' DescribeClusterSnapshots (Maybe Text) Source
The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.
Valid Values: automated
| manual
dcs1StartTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime) Source
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'
dcs1TagKeys :: Lens' DescribeClusterSnapshots [Text] Source
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.
dcs1TagValues :: Lens' DescribeClusterSnapshots [Text] Source
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.
Response
Response constructor
describeClusterSnapshotsResponse :: DescribeClusterSnapshotsResponse Source
DescribeClusterSnapshotsResponse
constructor.
The fields accessible through corresponding lenses are:
dcsrMarker
::
Maybe
Text
dcsrSnapshots
::
[Snapshot
]
Response lenses
dcsrMarker :: Lens' DescribeClusterSnapshotsResponse (Maybe Text) Source
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.
dcsrSnapshots :: Lens' DescribeClusterSnapshotsResponse [Snapshot] Source
A list of Snapshot
instances.