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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of all the MSK configurations in this Region.

This operation returns paginated results.

Creating a Request

data ListConfigurations Source #

See: newListConfigurations smart constructor.

Constructors

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

newListConfigurations :: ListConfigurations Source #

Create a value of ListConfigurations 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:ListConfigurations', listConfigurations_maxResults - The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

ListConfigurations, listConfigurations_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

listConfigurations_maxResults :: Lens' ListConfigurations (Maybe Natural) Source #

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

listConfigurations_nextToken :: Lens' ListConfigurations (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 ListConfigurationsResponse Source #

See: newListConfigurationsResponse smart constructor.

Constructors

ListConfigurationsResponse'
Fields configurations :: Maybe [Configuration] An array of MSK configurations. nextToken :: Maybe Text The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. To get another batch of configurations, provide this token in your next request. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListConfigurationsResponse Source #

Arguments

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

Create a value of ListConfigurationsResponse 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:configurations:ListConfigurationsResponse', listConfigurationsResponse_configurations - An array of MSK configurations.

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

$sel:httpStatus:ListConfigurationsResponse', listConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

listConfigurationsResponse_configurations :: Lens' ListConfigurationsResponse (Maybe [Configuration]) Source #

An array of MSK configurations.

listConfigurationsResponse_nextToken :: Lens' ListConfigurationsResponse (Maybe Text) Source #

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

listConfigurationsResponse_httpStatus :: Lens' ListConfigurationsResponse Int Source #

The response's http status code.