Network.AWS.ElastiCache.DescribeSnapshots

Returns information about cache cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation returns paginated results.

Creating a Request

describeSnapshots :: DescribeSnapshots

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

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

• dsCacheClusterId - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster are described.
• dsMarker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• dsMaxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.
• dsSnapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
• dsShowNodeGroupConfig - A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
• dsReplicationGroupId - A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
• dsSnapshotSource - If set to system , the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

data DescribeSnapshots

Represents the input of a DescribeSnapshotsMessage operation.

See: describeSnapshots smart constructor.

Instances

Eq DescribeSnapshots

Methods

(==) :: DescribeSnapshots -> DescribeSnapshots -> Bool

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

Data DescribeSnapshots

Methods

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

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

toConstr :: DescribeSnapshots -> Constr

dataTypeOf :: DescribeSnapshots -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeSnapshots

Methods

readsPrec :: Int -> ReadS DescribeSnapshots

readList :: ReadS [DescribeSnapshots]

readPrec :: ReadPrec DescribeSnapshots

readListPrec :: ReadPrec [DescribeSnapshots]

Show DescribeSnapshots

Methods

showsPrec :: Int -> DescribeSnapshots -> ShowS

show :: DescribeSnapshots -> String

showList :: [DescribeSnapshots] -> ShowS

Generic DescribeSnapshots

Associated Types

type Rep DescribeSnapshots :: * -> *

Methods

from :: DescribeSnapshots -> Rep DescribeSnapshots x

to :: Rep DescribeSnapshots x -> DescribeSnapshots

Hashable DescribeSnapshots

Methods

hashWithSalt :: Int -> DescribeSnapshots -> Int

hash :: DescribeSnapshots -> Int

NFData DescribeSnapshots

Methods

rnf :: DescribeSnapshots -> ()

AWSPager DescribeSnapshots

Methods

page :: DescribeSnapshots -> Rs DescribeSnapshots -> Maybe DescribeSnapshots

AWSRequest DescribeSnapshots

Associated Types

type Rs DescribeSnapshots :: *

Methods

request :: DescribeSnapshots -> Request DescribeSnapshots

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

ToPath DescribeSnapshots

Methods

toPath :: DescribeSnapshots -> ByteString

ToHeaders DescribeSnapshots

Methods

toHeaders :: DescribeSnapshots -> [Header]

ToQuery DescribeSnapshots

Methods

toQuery :: DescribeSnapshots -> QueryString

type Rep DescribeSnapshots

type Rep DescribeSnapshots = D1 (MetaData "DescribeSnapshots" "Network.AWS.ElastiCache.DescribeSnapshots" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "DescribeSnapshots'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsCacheClusterId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsMaxRecords") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dsSnapshotName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsShowNodeGroupConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_dsReplicationGroupId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dsSnapshotSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs DescribeSnapshots

type Rs DescribeSnapshots = DescribeSnapshotsResponse

Request Lenses

dsCacheClusterId :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster are described.

dsMarker :: Lens' DescribeSnapshots (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

dsMaxRecords :: Lens' DescribeSnapshots (Maybe Int)

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved. Default: 50 Constraints: minimum 20; maximum 50.

dsSnapshotName :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

dsShowNodeGroupConfig :: Lens' DescribeSnapshots (Maybe Bool)

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

dsReplicationGroupId :: Lens' DescribeSnapshots (Maybe Text)

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

dsSnapshotSource :: Lens' DescribeSnapshots (Maybe Text)

If set to system , the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

Destructuring the Response

describeSnapshotsResponse

Arguments

:: Int

dssrsResponseStatus

-> DescribeSnapshotsResponse

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

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

• dssrsSnapshots - A list of snapshots. Each item in the list contains detailed information about one snapshot.
• dssrsMarker - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
• dssrsResponseStatus - -- | The response status code.

data DescribeSnapshotsResponse

Represents the output of a DescribeSnapshots operation.

See: describeSnapshotsResponse smart constructor.

Instances

Eq DescribeSnapshotsResponse

Methods

(==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool

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

Data DescribeSnapshotsResponse

Methods

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

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

toConstr :: DescribeSnapshotsResponse -> Constr

dataTypeOf :: DescribeSnapshotsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeSnapshotsResponse

Methods

readsPrec :: Int -> ReadS DescribeSnapshotsResponse

readList :: ReadS [DescribeSnapshotsResponse]

readPrec :: ReadPrec DescribeSnapshotsResponse

readListPrec :: ReadPrec [DescribeSnapshotsResponse]

Show DescribeSnapshotsResponse

Methods

showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS

show :: DescribeSnapshotsResponse -> String

showList :: [DescribeSnapshotsResponse] -> ShowS

Generic DescribeSnapshotsResponse

Associated Types

type Rep DescribeSnapshotsResponse :: * -> *

Methods

from :: DescribeSnapshotsResponse -> Rep DescribeSnapshotsResponse x

to :: Rep DescribeSnapshotsResponse x -> DescribeSnapshotsResponse

NFData DescribeSnapshotsResponse

Methods

rnf :: DescribeSnapshotsResponse -> ()

type Rep DescribeSnapshotsResponse

type Rep DescribeSnapshotsResponse = D1 (MetaData "DescribeSnapshotsResponse" "Network.AWS.ElastiCache.DescribeSnapshots" "amazonka-elasticache-1.4.5-DCZ22LKkzpiJjmUycYjUf" False) (C1 (MetaCons "DescribeSnapshotsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dssrsSnapshots") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Snapshot]))) ((:*:) (S1 (MetaSel (Just Symbol "_dssrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dssrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]

A list of snapshots. Each item in the list contains detailed information about one snapshot.

dssrsMarker :: Lens' DescribeSnapshotsResponse (Maybe Text)

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

dssrsResponseStatus :: Lens' DescribeSnapshotsResponse Int

• - | The response status code.