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.MemoryDb.DescribeSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

This operation returns paginated results.

Synopsis

data DescribeSnapshots = DescribeSnapshots' {
- clusterName :: Maybe Text
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- showDetail :: Maybe Bool
- snapshotName :: Maybe Text
- source :: Maybe Text
}
newDescribeSnapshots :: DescribeSnapshots
describeSnapshots_clusterName :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Int)
describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_showDetail :: Lens' DescribeSnapshots (Maybe Bool)
describeSnapshots_snapshotName :: Lens' DescribeSnapshots (Maybe Text)
describeSnapshots_source :: Lens' DescribeSnapshots (Maybe Text)
data DescribeSnapshotsResponse = DescribeSnapshotsResponse' {
- nextToken :: Maybe Text
- snapshots :: Maybe [Snapshot]
- httpStatus :: Int
}
newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])
describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int

Creating a Request

data DescribeSnapshots Source #

See: newDescribeSnapshots smart constructor.

Constructors

DescribeSnapshots'

Fields

clusterName :: Maybe Text
A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.
maxResults :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
showDetail :: Maybe Bool
A Boolean value which if true, the 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 named snapshot is described.
source :: Maybe Text
If set to system, the output shows snapshots that were automatically created by MemoryDB. 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

ToJSON DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods toJSON :: DescribeSnapshots -> Value # toEncoding :: DescribeSnapshots -> Encoding # toJSONList :: [DescribeSnapshots] -> Value # toEncodingList :: [DescribeSnapshots] -> Encoding #
ToHeaders DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods toHeaders :: DescribeSnapshots -> [Header] #
ToPath DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods toPath :: DescribeSnapshots -> ByteString #
ToQuery DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods toQuery :: DescribeSnapshots -> QueryString #
AWSPager DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods page :: DescribeSnapshots -> AWSResponse DescribeSnapshots -> Maybe DescribeSnapshots #
AWSRequest DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.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.MemoryDb.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.MemoryDb.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshots # readList :: ReadS [DescribeSnapshots] # readPrec :: ReadPrec DescribeSnapshots # readListPrec :: ReadPrec [DescribeSnapshots] #
Show DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshots -> ShowS # show :: DescribeSnapshots -> String # showList :: [DescribeSnapshots] -> ShowS #
NFData DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods rnf :: DescribeSnapshots -> () #
Eq DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods (==) :: DescribeSnapshots -> DescribeSnapshots -> Bool # (/=) :: DescribeSnapshots -> DescribeSnapshots -> Bool #
Hashable DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods hashWithSalt :: Int -> DescribeSnapshots -> Int # hash :: DescribeSnapshots -> Int #
type AWSResponse DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots type AWSResponse DescribeSnapshots = DescribeSnapshotsResponse
type Rep DescribeSnapshots Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots type Rep DescribeSnapshots = D1 ('MetaData "DescribeSnapshots" "Amazonka.MemoryDb.DescribeSnapshots" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeSnapshots'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "showDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "snapshotName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "source") '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_clusterName - A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

$sel:maxResults:DescribeSnapshots', describeSnapshots_maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

DescribeSnapshots, describeSnapshots_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$sel:showDetail:DescribeSnapshots', describeSnapshots_showDetail - A Boolean value which if true, the shard configuration is included in the snapshot description.

$sel:snapshotName:DescribeSnapshots', describeSnapshots_snapshotName - A user-supplied name of the snapshot. If this parameter is specified, only this named snapshot is described.

DescribeSnapshots, describeSnapshots_source - If set to system, the output shows snapshots that were automatically created by MemoryDB. 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_clusterName :: 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_maxResults :: Lens' DescribeSnapshots (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

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

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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

A Boolean value which if true, the 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 named snapshot is described.

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

If set to system, the output shows snapshots that were automatically created by MemoryDB. 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 #

See: newDescribeSnapshotsResponse smart constructor.

Constructors

DescribeSnapshotsResponse'

Fields

nextToken :: Maybe Text
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
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.MemoryDb.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.MemoryDb.DescribeSnapshots Methods readsPrec :: Int -> ReadS DescribeSnapshotsResponse # readList :: ReadS [DescribeSnapshotsResponse] # readPrec :: ReadPrec DescribeSnapshotsResponse # readListPrec :: ReadPrec [DescribeSnapshotsResponse] #
Show DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods showsPrec :: Int -> DescribeSnapshotsResponse -> ShowS # show :: DescribeSnapshotsResponse -> String # showList :: [DescribeSnapshotsResponse] -> ShowS #
NFData DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods rnf :: DescribeSnapshotsResponse -> () #
Eq DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots Methods (==) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool # (/=) :: DescribeSnapshotsResponse -> DescribeSnapshotsResponse -> Bool #
type Rep DescribeSnapshotsResponse Source #
Instance details Defined in Amazonka.MemoryDb.DescribeSnapshots type Rep DescribeSnapshotsResponse = D1 ('MetaData "DescribeSnapshotsResponse" "Amazonka.MemoryDb.DescribeSnapshots" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") '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_nextToken - An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

$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_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

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.