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.DocDbElastic.ListClusterSnapshots

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about Elastic DocumentDB snapshots for a specified cluster.

This operation returns paginated results.

Synopsis

data ListClusterSnapshots = ListClusterSnapshots' {
- clusterArn :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListClusterSnapshots :: ListClusterSnapshots
listClusterSnapshots_clusterArn :: Lens' ListClusterSnapshots (Maybe Text)
listClusterSnapshots_maxResults :: Lens' ListClusterSnapshots (Maybe Natural)
listClusterSnapshots_nextToken :: Lens' ListClusterSnapshots (Maybe Text)
data ListClusterSnapshotsResponse = ListClusterSnapshotsResponse' {
- nextToken :: Maybe Text
- snapshots :: Maybe [ClusterSnapshotInList]
- httpStatus :: Int
}
newListClusterSnapshotsResponse :: Int -> ListClusterSnapshotsResponse
listClusterSnapshotsResponse_nextToken :: Lens' ListClusterSnapshotsResponse (Maybe Text)
listClusterSnapshotsResponse_snapshots :: Lens' ListClusterSnapshotsResponse (Maybe [ClusterSnapshotInList])
listClusterSnapshotsResponse_httpStatus :: Lens' ListClusterSnapshotsResponse Int

Creating a Request

data ListClusterSnapshots Source #

See: newListClusterSnapshots smart constructor.

Constructors

ListClusterSnapshots'
Fields clusterArn :: Maybe Text The arn of the Elastic DocumentDB cluster. maxResults :: Maybe Natural The maximum number of entries to recieve in the response. nextToken :: Maybe Text The nextToken which is used the get the next page of data.

Instances

Instances details

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

newListClusterSnapshots :: ListClusterSnapshots Source #

Create a value of ListClusterSnapshots 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:

ListClusterSnapshots, listClusterSnapshots_clusterArn - The arn of the Elastic DocumentDB cluster.

$sel:maxResults:ListClusterSnapshots', listClusterSnapshots_maxResults - The maximum number of entries to recieve in the response.

ListClusterSnapshots, listClusterSnapshots_nextToken - The nextToken which is used the get the next page of data.

Request Lenses

listClusterSnapshots_clusterArn :: Lens' ListClusterSnapshots (Maybe Text) Source #

The arn of the Elastic DocumentDB cluster.

listClusterSnapshots_maxResults :: Lens' ListClusterSnapshots (Maybe Natural) Source #

The maximum number of entries to recieve in the response.

listClusterSnapshots_nextToken :: Lens' ListClusterSnapshots (Maybe Text) Source #

The nextToken which is used the get the next page of data.

Destructuring the Response

data ListClusterSnapshotsResponse Source #

See: newListClusterSnapshotsResponse smart constructor.

Constructors

ListClusterSnapshotsResponse'
Fields nextToken :: Maybe Text The response will provide a nextToken if there is more data beyond the maxResults. If there is no more data in the responce, the nextToken will not be returned. snapshots :: Maybe [ClusterSnapshotInList] A list of Elastic DocumentDB snapshots for a specified cluster. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListClusterSnapshotsResponse Source #

Arguments

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

Create a value of ListClusterSnapshotsResponse 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:

ListClusterSnapshots, listClusterSnapshotsResponse_nextToken - The response will provide a nextToken if there is more data beyond the maxResults.

If there is no more data in the responce, the nextToken will not be returned.

$sel:snapshots:ListClusterSnapshotsResponse', listClusterSnapshotsResponse_snapshots - A list of Elastic DocumentDB snapshots for a specified cluster.

$sel:httpStatus:ListClusterSnapshotsResponse', listClusterSnapshotsResponse_httpStatus - The response's http status code.

Response Lenses

listClusterSnapshotsResponse_nextToken :: Lens' ListClusterSnapshotsResponse (Maybe Text) Source #

The response will provide a nextToken if there is more data beyond the maxResults.

If there is no more data in the responce, the nextToken will not be returned.

listClusterSnapshotsResponse_snapshots :: Lens' ListClusterSnapshotsResponse (Maybe [ClusterSnapshotInList]) Source #

A list of Elastic DocumentDB snapshots for a specified cluster.

listClusterSnapshotsResponse_httpStatus :: Lens' ListClusterSnapshotsResponse Int Source #

The response's http status code.