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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all the MSK clusters in the current Region.

This operation returns paginated results.

Creating a Request

data ListClusters Source #

See: newListClusters smart constructor.

Constructors

ListClusters'

Fields

clusterNameFilter :: Maybe Text
Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
maxResults :: Maybe Natural
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.
nextToken :: Maybe Text
The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

Instances

Instances details

ToHeaders ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods toHeaders :: ListClusters -> [Header] #
ToPath ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods toPath :: ListClusters -> ByteString #
ToQuery ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods toQuery :: ListClusters -> QueryString #
AWSPager ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods page :: ListClusters -> AWSResponse ListClusters -> Maybe ListClusters #
AWSRequest ListClusters Source #
Instance details Defined in Amazonka.Kafka.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.Kafka.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.Kafka.ListClusters Methods readsPrec :: Int -> ReadS ListClusters # readList :: ReadS [ListClusters] # readPrec :: ReadPrec ListClusters # readListPrec :: ReadPrec [ListClusters] #
Show ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods showsPrec :: Int -> ListClusters -> ShowS # show :: ListClusters -> String # showList :: [ListClusters] -> ShowS #
NFData ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods rnf :: ListClusters -> () #
Eq ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods (==) :: ListClusters -> ListClusters -> Bool # (/=) :: ListClusters -> ListClusters -> Bool #
Hashable ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods hashWithSalt :: Int -> ListClusters -> Int # hash :: ListClusters -> Int #
type AWSResponse ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters type AWSResponse ListClusters = ListClustersResponse
type Rep ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.Kafka.ListClusters" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterNameFilter") '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)))))

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:clusterNameFilter:ListClusters', listClusters_clusterNameFilter - Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

$sel:maxResults:ListClusters', listClusters_maxResults - The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

ListClusters, listClusters_nextToken - The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

Request Lenses

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

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

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

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

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

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. To get the next batch, provide this token in your next request.

Destructuring the Response

data ListClustersResponse Source #

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'
Fields clusterInfoList :: Maybe [ClusterInfo] Information on each of the MSK clusters in the response. nextToken :: Maybe Text The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.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.Kafka.ListClusters Methods readsPrec :: Int -> ReadS ListClustersResponse # readList :: ReadS [ListClustersResponse] # readPrec :: ReadPrec ListClustersResponse # readListPrec :: ReadPrec [ListClustersResponse] #
Show ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods showsPrec :: Int -> ListClustersResponse -> ShowS # show :: ListClustersResponse -> String # showList :: [ListClustersResponse] -> ShowS #
NFData ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods rnf :: ListClustersResponse -> () #
Eq ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods (==) :: ListClustersResponse -> ListClustersResponse -> Bool # (/=) :: ListClustersResponse -> ListClustersResponse -> Bool #
type Rep ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.Kafka.ListClusters" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterInfo])) :: (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:clusterInfoList:ListClustersResponse', listClustersResponse_clusterInfoList - Information on each of the MSK clusters in the response.

ListClusters, listClustersResponse_nextToken - The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

$sel:httpStatus:ListClustersResponse', listClustersResponse_httpStatus - The response's http status code.

Response Lenses

listClustersResponse_clusterInfoList :: Lens' ListClustersResponse (Maybe [ClusterInfo]) Source #

Information on each of the MSK clusters in the response.

listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #

The response's http status code.