Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ElastiCache.DescribeSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about 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 is valid for Redis only.

This operation returns paginated results.

Synopsis

data DescribeSnapshots = DescribeSnapshots' {
- cacheClusterId :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
- replicationGroupId :: Maybe Text
- showNodeGroupConfig :: Maybe Bool
- snapshotName :: Maybe Text
- snapshotSource :: Maybe Text
}
newDescribeSnapshots :: DescribeSnapshots
describeSnapshots_cacheClusterId :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_marker :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_maxRecords :: Lens' DescribeSnapshots (Maybe Int)
describeSnapshots_replicationGroupId :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_showNodeGroupConfig :: Lens' DescribeSnapshots (Maybe Bool)
describeSnapshots_snapshotName :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_snapshotSource :: Lens' DescribeSnapshots (Maybe Text)
data DescribeSnapshotsResponse = DescribeSnapshotsResponse' {
- marker :: Maybe Text
- snapshots :: Maybe [Snapshot]
- httpStatus :: Int
}
newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
describeSnapshotsResponse_marker :: Lens' DescribeSnapshotsResponse (Maybe Text)
describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])
describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int

Creating a Request

data DescribeSnapshots Source #

Represents the input of a DescribeSnapshotsMessage operation.

See: newDescribeSnapshots smart constructor.

Constructors

DescribeSnapshots'

Fields

cacheClusterId :: Maybe Text
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
marker :: 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.
maxRecords :: 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.
replicationGroupId :: Maybe Text
A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.
showNodeGroupConfig :: Maybe Bool
A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.
snapshotName :: Maybe Text
A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.
snapshotSource :: 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.

Instances

Instances details

ToHeaders DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods toHeaders :: DescribeSnapshots -> [Header] #
ToPath DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods toPath :: DescribeSnapshots -> ByteString #
ToQuery DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods toQuery :: DescribeSnapshots -> QueryString #
AWSPager DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods page :: DescribeSnapshots -> AWSResponse DescribeSnapshots -> Maybe DescribeSnapshots #
AWSRequest DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Associated Types type AWSResponse DescribeSnapshots # Methods request :: (Service -> Service) -> DescribeSnapshots -> Request DescribeSnapshots # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSnapshots))) #
Generic DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Associated Types type Rep DescribeSnapshots :: Type -> Type # Methods from :: DescribeSnapshots -> Rep DescribeSnapshots x # to :: Rep DescribeSnapshots x -> DescribeSnapshots #
Read DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshots # readList :: ReadS [DescribeSnapshots] # readPrec :: ReadPrec DescribeSnapshots # readListPrec :: ReadPrec [DescribeSnapshots] #
Show DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshots -> ShowS # show :: DescribeSnapshots -> String # showList :: [DescribeSnapshots] -> ShowS #
NFData DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods rnf :: DescribeSnapshots -> () #
Eq DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods (==) :: DescribeSnapshots -> DescribeSnapshots -> Bool # (/=) :: DescribeSnapshots -> DescribeSnapshots -> Bool #
Hashable DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods hashWithSalt :: Int -> DescribeSnapshots -> Int # hash :: DescribeSnapshots -> Int #
type AWSResponse DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots type AWSResponse DescribeSnapshots = DescribeSnapshotsResponse
type Rep DescribeSnapshots Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots type Rep DescribeSnapshots = D1 ('MetaData "DescribeSnapshots" "Amazonka.ElastiCache.DescribeSnapshots" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cacheClusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "replicationGroupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "showNodeGroupConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "snapshotSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeSnapshots :: DescribeSnapshots Source #

Create a value of DescribeSnapshots with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

DescribeSnapshots, describeSnapshots_marker - 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.

$sel:maxRecords:DescribeSnapshots', describeSnapshots_maxRecords - 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.

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

$sel:showNodeGroupConfig:DescribeSnapshots', describeSnapshots_showNodeGroupConfig - A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

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

DescribeSnapshots, describeSnapshots_snapshotSource - 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.

Request Lenses

describeSnapshots_cacheClusterId :: Lens' DescribeSnapshots (Maybe Text) Source #

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

describeSnapshots_marker :: Lens' DescribeSnapshots (Maybe Text) Source #

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.

describeSnapshots_maxRecords :: Lens' DescribeSnapshots (Maybe Int) Source #

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.

describeSnapshots_replicationGroupId :: Lens' DescribeSnapshots (Maybe Text) Source #

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

describeSnapshots_showNodeGroupConfig :: Lens' DescribeSnapshots (Maybe Bool) Source #

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

describeSnapshots_snapshotName :: Lens' DescribeSnapshots (Maybe Text) Source #

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

describeSnapshots_snapshotSource :: Lens' DescribeSnapshots (Maybe Text) Source #

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

data DescribeSnapshotsResponse Source #

Represents the output of a DescribeSnapshots operation.

See: newDescribeSnapshotsResponse smart constructor.

Constructors

DescribeSnapshotsResponse'

Fields

marker :: 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.
snapshots :: Maybe [Snapshot]
A list of snapshots. Each item in the list contains detailed information about one snapshot.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Associated Types type Rep DescribeSnapshotsResponse :: Type -> Type # Methods from :: DescribeSnapshotsResponse -> Rep DescribeSnapshotsResponse x # to :: Rep DescribeSnapshotsResponse x -> DescribeSnapshotsResponse #
Read DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshotsResponse # readList :: ReadS [DescribeSnapshotsResponse] # readPrec :: ReadPrec DescribeSnapshotsResponse # readListPrec :: ReadPrec [DescribeSnapshotsResponse] #
Show DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS # show :: DescribeSnapshotsResponse -> String # showList :: [DescribeSnapshotsResponse] -> ShowS #
NFData DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods rnf :: DescribeSnapshotsResponse -> () #
Eq DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots Methods (==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool # (/=) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool #
type Rep DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.ElastiCache.DescribeSnapshots type Rep DescribeSnapshotsResponse = D1 ('MetaData "DescribeSnapshotsResponse" "Amazonka.ElastiCache.DescribeSnapshots" "amazonka-elasticache-2.0-DTWyHgx8JwY7IlNovngF22" 'False) (C1 ('MetaCons "DescribeSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "snapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Snapshot])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSnapshotsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSnapshotsResponse'`
-> DescribeSnapshotsResponse

Create a value of DescribeSnapshotsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSnapshots, describeSnapshotsResponse_marker - 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.

$sel:snapshots:DescribeSnapshotsResponse', describeSnapshotsResponse_snapshots - A list of snapshots. Each item in the list contains detailed information about one snapshot.

$sel:httpStatus:DescribeSnapshotsResponse', describeSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

describeSnapshotsResponse_marker :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

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.

describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #

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

describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #

The response's http status code.