Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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.
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.
maxResults :: Maybe Natural
The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

Instances

Instances details

Eq ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods (==) :: ListClusters -> ListClusters -> Bool # (/=) :: ListClusters -> ListClusters -> Bool #
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 #
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 #
NFData ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods rnf :: ListClusters -> () #
Hashable ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods hashWithSalt :: Int -> ListClusters -> Int # hash :: ListClusters -> Int #
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 :: ListClusters -> Request ListClusters # response :: MonadResource m => Logger -> Service -> Proxy ListClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClusters))) #
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 #
type Rep ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters type Rep ListClusters = D1 ('MetaData "ListClusters" "Amazonka.Kafka.ListClusters" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "ListClusters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterNameFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse ListClusters Source #
Instance details Defined in Amazonka.Kafka.ListClusters type AWSResponse ListClusters = ListClustersResponse

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:nextToken: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.

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

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

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.

Destructuring the Response

data ListClustersResponse Source #

See: newListClustersResponse smart constructor.

Constructors

ListClustersResponse'
Fields 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. clusterInfoList :: Maybe [ClusterInfo] Information on each of the MSK clusters in the response. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods (==) :: ListClustersResponse -> ListClustersResponse -> Bool # (/=) :: ListClustersResponse -> ListClustersResponse -> Bool #
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 #
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 #
NFData ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters Methods rnf :: ListClustersResponse -> () #
type Rep ListClustersResponse Source #
Instance details Defined in Amazonka.Kafka.ListClusters type Rep ListClustersResponse = D1 ('MetaData "ListClustersResponse" "Amazonka.Kafka.ListClusters" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "ListClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "clusterInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClusterInfo])) :: 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:nextToken: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:clusterInfoList:ListClustersResponse', listClustersResponse_clusterInfoList - Information on each of the MSK clusters in the response.

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

Response Lenses

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_clusterInfoList :: Lens' ListClustersResponse (Maybe [ClusterInfo]) Source #

Information on each of the MSK clusters in the response.

listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #

The response's http status code.