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

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.

Synopsis

data ListClustersV2 = ListClustersV2' {
- clusterNameFilter :: Maybe Text
- clusterTypeFilter :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
}
newListClustersV2 :: ListClustersV2
listClustersV2_clusterNameFilter :: Lens' ListClustersV2 (Maybe Text)
listClustersV2_clusterTypeFilter :: Lens' ListClustersV2 (Maybe Text)
listClustersV2_maxResults :: Lens' ListClustersV2 (Maybe Natural)
listClustersV2_nextToken :: Lens' ListClustersV2 (Maybe Text)
data ListClustersV2Response = ListClustersV2Response' {
- clusterInfoList :: Maybe [Cluster]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListClustersV2Response :: Int -> ListClustersV2Response
listClustersV2Response_clusterInfoList :: Lens' ListClustersV2Response (Maybe [Cluster])
listClustersV2Response_nextToken :: Lens' ListClustersV2Response (Maybe Text)
listClustersV2Response_httpStatus :: Lens' ListClustersV2Response Int

Creating a Request

data ListClustersV2 Source #

See: newListClustersV2 smart constructor.

Constructors

ListClustersV2'

Fields

clusterNameFilter :: Maybe Text
Specify a prefix of the names of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.
clusterTypeFilter :: Maybe Text
Specify either PROVISIONED or SERVERLESS.
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 ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods toHeaders :: ListClustersV2 -> [Header] #
ToPath ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods toPath :: ListClustersV2 -> ByteString #
ToQuery ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods toQuery :: ListClustersV2 -> QueryString #
AWSPager ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods page :: ListClustersV2 -> AWSResponse ListClustersV2 -> Maybe ListClustersV2 #
AWSRequest ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Associated Types type AWSResponse ListClustersV2 # Methods request :: (Service -> Service) -> ListClustersV2 -> Request ListClustersV2 # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListClustersV2 -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListClustersV2))) #
Generic ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Associated Types type Rep ListClustersV2 :: Type -> Type # Methods from :: ListClustersV2 -> Rep ListClustersV2 x # to :: Rep ListClustersV2 x -> ListClustersV2 #
Read ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods readsPrec :: Int -> ReadS ListClustersV2 # readList :: ReadS [ListClustersV2] # readPrec :: ReadPrec ListClustersV2 # readListPrec :: ReadPrec [ListClustersV2] #
Show ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods showsPrec :: Int -> ListClustersV2 -> ShowS # show :: ListClustersV2 -> String # showList :: [ListClustersV2] -> ShowS #
NFData ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods rnf :: ListClustersV2 -> () #
Eq ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods (==) :: ListClustersV2 -> ListClustersV2 -> Bool # (/=) :: ListClustersV2 -> ListClustersV2 -> Bool #
Hashable ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods hashWithSalt :: Int -> ListClustersV2 -> Int # hash :: ListClustersV2 -> Int #
type AWSResponse ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 type AWSResponse ListClustersV2 = ListClustersV2Response
type Rep ListClustersV2 Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 type Rep ListClustersV2 = D1 ('MetaData "ListClustersV2" "Amazonka.Kafka.ListClustersV2" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "ListClustersV2'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clusterNameFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clusterTypeFilter") '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)))))

newListClustersV2 :: ListClustersV2 Source #

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

$sel:clusterTypeFilter:ListClustersV2', listClustersV2_clusterTypeFilter - Specify either PROVISIONED or SERVERLESS.

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

ListClustersV2, listClustersV2_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

listClustersV2_clusterNameFilter :: Lens' ListClustersV2 (Maybe Text) Source #

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

listClustersV2_clusterTypeFilter :: Lens' ListClustersV2 (Maybe Text) Source #

Specify either PROVISIONED or SERVERLESS.

listClustersV2_maxResults :: Lens' ListClustersV2 (Maybe Natural) Source #

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

listClustersV2_nextToken :: Lens' ListClustersV2 (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 ListClustersV2Response Source #

See: newListClustersV2Response smart constructor.

Constructors

ListClustersV2Response'
Fields clusterInfoList :: Maybe [Cluster] 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 ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Associated Types type Rep ListClustersV2Response :: Type -> Type # Methods from :: ListClustersV2Response -> Rep ListClustersV2Response x # to :: Rep ListClustersV2Response x -> ListClustersV2Response #
Read ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods readsPrec :: Int -> ReadS ListClustersV2Response # readList :: ReadS [ListClustersV2Response] # readPrec :: ReadPrec ListClustersV2Response # readListPrec :: ReadPrec [ListClustersV2Response] #
Show ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods showsPrec :: Int -> ListClustersV2Response -> ShowS # show :: ListClustersV2Response -> String # showList :: [ListClustersV2Response] -> ShowS #
NFData ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods rnf :: ListClustersV2Response -> () #
Eq ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 Methods (==) :: ListClustersV2Response -> ListClustersV2Response -> Bool # (/=) :: ListClustersV2Response -> ListClustersV2Response -> Bool #
type Rep ListClustersV2Response Source #
Instance details Defined in Amazonka.Kafka.ListClustersV2 type Rep ListClustersV2Response = D1 ('MetaData "ListClustersV2Response" "Amazonka.Kafka.ListClustersV2" "amazonka-kafka-2.0-Go9aKmtSH8zJub8xGjzkib" 'False) (C1 ('MetaCons "ListClustersV2Response'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Cluster])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListClustersV2Response Source #

Arguments

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

Create a value of ListClustersV2Response 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:ListClustersV2Response', listClustersV2Response_clusterInfoList - Information on each of the MSK clusters in the response.

ListClustersV2, listClustersV2Response_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:ListClustersV2Response', listClustersV2Response_httpStatus - The response's http status code.

Response Lenses

listClustersV2Response_clusterInfoList :: Lens' ListClustersV2Response (Maybe [Cluster]) Source #

Information on each of the MSK clusters in the response.

listClustersV2Response_nextToken :: Lens' ListClustersV2Response (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.

listClustersV2Response_httpStatus :: Lens' ListClustersV2Response Int Source #

The response's http status code.