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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the broker nodes in the cluster.

This operation returns paginated results.

Synopsis

data ListNodes = ListNodes' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- clusterArn :: Text
}
newListNodes :: Text -> ListNodes
listNodes_maxResults :: Lens' ListNodes (Maybe Natural)
listNodes_nextToken :: Lens' ListNodes (Maybe Text)
listNodes_clusterArn :: Lens' ListNodes Text
data ListNodesResponse = ListNodesResponse' {
- nextToken :: Maybe Text
- nodeInfoList :: Maybe [NodeInfo]
- httpStatus :: Int
}
newListNodesResponse :: Int -> ListNodesResponse
listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text)
listNodesResponse_nodeInfoList :: Lens' ListNodesResponse (Maybe [NodeInfo])
listNodesResponse_httpStatus :: Lens' ListNodesResponse Int

Creating a Request

data ListNodes Source #

See: newListNodes smart constructor.

Constructors

ListNodes'

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.
clusterArn :: Text
The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Instances

Instances details

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

newListNodes Source #

Arguments

:: Text	`ListNodes`
-> ListNodes

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

ListNodes, listNodes_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.

ListNodes, listNodes_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Request Lenses

listNodes_maxResults :: Lens' ListNodes (Maybe Natural) Source #

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

listNodes_nextToken :: Lens' ListNodes (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.

listNodes_clusterArn :: Lens' ListNodes Text Source #

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Destructuring the Response

data ListNodesResponse Source #

See: newListNodesResponse smart constructor.

Constructors

ListNodesResponse'
Fields nextToken :: Maybe Text The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. To get another batch of nodes, provide this token in your next request. nodeInfoList :: Maybe [NodeInfo] List containing a NodeInfo object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListNodesResponse Source #

Arguments

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

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

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

$sel:nodeInfoList:ListNodesResponse', listNodesResponse_nodeInfoList - List containing a NodeInfo object.

$sel:httpStatus:ListNodesResponse', listNodesResponse_httpStatus - The response's http status code.

Response Lenses

listNodesResponse_nextToken :: Lens' ListNodesResponse (Maybe Text) Source #

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

listNodesResponse_nodeInfoList :: Lens' ListNodesResponse (Maybe [NodeInfo]) Source #

List containing a NodeInfo object.

listNodesResponse_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.