Network.AWS.Redshift.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.

This operation returns paginated results.

Creating a Request

describeClusterSnapshots :: DescribeClusterSnapshots

Creates a value of DescribeClusterSnapshots with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dSnapshotIdentifier
• dTagValues
• dStartTime
• dTagKeys
• dClusterIdentifier
• dSnapshotType
• dMarker
• dMaxRecords
• dEndTime
• dOwnerAccount

data DescribeClusterSnapshots

See: describeClusterSnapshots smart constructor.

Instances

Eq DescribeClusterSnapshots

Methods

(==) :: DescribeClusterSnapshots -> DescribeClusterSnapshots -> Bool

(/=) :: DescribeClusterSnapshots -> DescribeClusterSnapshots -> Bool

Data DescribeClusterSnapshots

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterSnapshots -> c DescribeClusterSnapshots

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterSnapshots

toConstr :: DescribeClusterSnapshots -> Constr

dataTypeOf :: DescribeClusterSnapshots -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterSnapshots)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterSnapshots)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterSnapshots -> DescribeClusterSnapshots

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSnapshots -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSnapshots -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterSnapshots -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterSnapshots -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshots -> m DescribeClusterSnapshots

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshots -> m DescribeClusterSnapshots

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshots -> m DescribeClusterSnapshots

Read DescribeClusterSnapshots

Methods

readsPrec :: Int -> ReadS DescribeClusterSnapshots

readList :: ReadS [DescribeClusterSnapshots]

readPrec :: ReadPrec DescribeClusterSnapshots

readListPrec :: ReadPrec [DescribeClusterSnapshots]

Show DescribeClusterSnapshots

Methods

showsPrec :: Int -> DescribeClusterSnapshots -> ShowS

show :: DescribeClusterSnapshots -> String

showList :: [DescribeClusterSnapshots] -> ShowS

Generic DescribeClusterSnapshots

Associated Types

type Rep DescribeClusterSnapshots :: * -> *

Methods

from :: DescribeClusterSnapshots -> Rep DescribeClusterSnapshots x

to :: Rep DescribeClusterSnapshots x -> DescribeClusterSnapshots

Hashable DescribeClusterSnapshots

Methods

hashWithSalt :: Int -> DescribeClusterSnapshots -> Int

hash :: DescribeClusterSnapshots -> Int

NFData DescribeClusterSnapshots

Methods

rnf :: DescribeClusterSnapshots -> ()

AWSPager DescribeClusterSnapshots

Methods

page :: DescribeClusterSnapshots -> Rs DescribeClusterSnapshots -> Maybe DescribeClusterSnapshots

AWSRequest DescribeClusterSnapshots

Associated Types

type Rs DescribeClusterSnapshots :: *

Methods

request :: DescribeClusterSnapshots -> Request DescribeClusterSnapshots

response :: MonadResource m => Logger -> Service -> Proxy * DescribeClusterSnapshots -> ClientResponse -> m (Response DescribeClusterSnapshots)

ToPath DescribeClusterSnapshots

Methods

toPath :: DescribeClusterSnapshots -> ByteString

ToHeaders DescribeClusterSnapshots

Methods

toHeaders :: DescribeClusterSnapshots -> [Header]

ToQuery DescribeClusterSnapshots

Methods

toQuery :: DescribeClusterSnapshots -> QueryString

type Rep DescribeClusterSnapshots

type Rep DescribeClusterSnapshots = D1 (MetaData "DescribeClusterSnapshots" "Network.AWS.Redshift.DescribeClusterSnapshots" "amazonka-redshift-1.4.2-6pcb6KeSjlW7uTiZZqVkvG" False) (C1 (MetaCons "DescribeClusterSnapshots'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dTagValues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_dStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) ((:*:) (S1 (MetaSel (Just Symbol "_dTagKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_dClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dSnapshotType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_dEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_dOwnerAccount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

type Rs DescribeClusterSnapshots

type Rs DescribeClusterSnapshots = DescribeClusterSnapshotsResponse

Request Lenses

dSnapshotIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text)

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

dTagValues :: Lens' DescribeClusterSnapshots [Text]

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.

dStartTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime)

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'

dTagKeys :: Lens' DescribeClusterSnapshots [Text]

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.

dClusterIdentifier :: Lens' DescribeClusterSnapshots (Maybe Text)

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

dSnapshotType :: Lens' DescribeClusterSnapshots (Maybe Text)

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

Valid Values: automated | manual

dMarker :: Lens' DescribeClusterSnapshots (Maybe Text)

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.

dMaxRecords :: Lens' DescribeClusterSnapshots (Maybe Int)

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.

dEndTime :: Lens' DescribeClusterSnapshots (Maybe UTCTime)

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'

dOwnerAccount :: Lens' DescribeClusterSnapshots (Maybe Text)

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.

Destructuring the Response

describeClusterSnapshotsResponse

Arguments

:: Int

dcssrsResponseStatus

-> DescribeClusterSnapshotsResponse

Creates a value of DescribeClusterSnapshotsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcssrsSnapshots
• dcssrsMarker
• dcssrsResponseStatus

data DescribeClusterSnapshotsResponse

Contains the output from the DescribeClusterSnapshots action.

See: describeClusterSnapshotsResponse smart constructor.

Instances

Eq DescribeClusterSnapshotsResponse

Methods

(==) :: DescribeClusterSnapshotsResponse -> DescribeClusterSnapshotsResponse -> Bool

(/=) :: DescribeClusterSnapshotsResponse -> DescribeClusterSnapshotsResponse -> Bool

Data DescribeClusterSnapshotsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeClusterSnapshotsResponse -> c DescribeClusterSnapshotsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeClusterSnapshotsResponse

toConstr :: DescribeClusterSnapshotsResponse -> Constr

dataTypeOf :: DescribeClusterSnapshotsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeClusterSnapshotsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeClusterSnapshotsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeClusterSnapshotsResponse -> DescribeClusterSnapshotsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSnapshotsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeClusterSnapshotsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeClusterSnapshotsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeClusterSnapshotsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshotsResponse -> m DescribeClusterSnapshotsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshotsResponse -> m DescribeClusterSnapshotsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeClusterSnapshotsResponse -> m DescribeClusterSnapshotsResponse

Read DescribeClusterSnapshotsResponse

Methods

readsPrec :: Int -> ReadS DescribeClusterSnapshotsResponse

readList :: ReadS [DescribeClusterSnapshotsResponse]

readPrec :: ReadPrec DescribeClusterSnapshotsResponse

readListPrec :: ReadPrec [DescribeClusterSnapshotsResponse]

Show DescribeClusterSnapshotsResponse

Methods

showsPrec :: Int -> DescribeClusterSnapshotsResponse -> ShowS

show :: DescribeClusterSnapshotsResponse -> String

showList :: [DescribeClusterSnapshotsResponse] -> ShowS

Generic DescribeClusterSnapshotsResponse

Associated Types

type Rep DescribeClusterSnapshotsResponse :: * -> *

Methods

from :: DescribeClusterSnapshotsResponse -> Rep DescribeClusterSnapshotsResponse x

to :: Rep DescribeClusterSnapshotsResponse x -> DescribeClusterSnapshotsResponse

NFData DescribeClusterSnapshotsResponse

Methods

rnf :: DescribeClusterSnapshotsResponse -> ()

type Rep DescribeClusterSnapshotsResponse

type Rep DescribeClusterSnapshotsResponse = D1 (MetaData "DescribeClusterSnapshotsResponse" "Network.AWS.Redshift.DescribeClusterSnapshots" "amazonka-redshift-1.4.2-6pcb6KeSjlW7uTiZZqVkvG" False) (C1 (MetaCons "DescribeClusterSnapshotsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dcssrsSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Snapshot]))) ((:*:) (S1 (MetaSel (Just Symbol "_dcssrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dcssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

dcssrsSnapshots :: Lens' DescribeClusterSnapshotsResponse [Snapshot]

A list of Snapshot instances.

dcssrsMarker :: Lens' DescribeClusterSnapshotsResponse (Maybe Text)

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.

dcssrsResponseStatus :: Lens' DescribeClusterSnapshotsResponse Int

The response status code.