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.ListClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about provisioned Elastic DocumentDB clusters.

This operation returns paginated results.

Creating a Request

data ListClusters Source #

See: newListClusters smart constructor.

Constructors

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

newListClusters :: ListClusters Source #

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

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

ListClusters, listClusters_nextToken - The nextToken which is used the get the next page of data.

Request Lenses

listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #

The maximum number of entries to recieve in the response.

listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #

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

Destructuring the Response

data ListClustersResponse Source #

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'
Fields clusters :: Maybe [ClusterInList] A list of Elastic DocumentDB cluster. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListClustersResponse Source #

Arguments

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

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

$sel:clusters:ListClustersResponse', listClustersResponse_clusters - A list of Elastic DocumentDB cluster.

ListClusters, listClustersResponse_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:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.

Response Lenses

listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterInList]) Source #

A list of Elastic DocumentDB cluster.

listClustersResponse_nextToken :: Lens' ListClustersResponse (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.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #

The response's http status code.