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

Creating a Request

data ListNodes Source #

See: newListNodes smart constructor.

Constructors

ListNodes'

Fields

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

Instances

Instances details

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

newListNodes Source #

Arguments

:: Text	`$sel:clusterArn: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:nextToken: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.

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

$sel:clusterArn:ListNodes', listNodes_clusterArn - The Amazon Resource Name (ARN) that uniquely identifies the cluster.

Request Lenses

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_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_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 nodeInfoList :: Maybe [NodeInfo] List containing a NodeInfo object. 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListNodesResponse Source #
Instance details Defined in Amazonka.Kafka.ListNodes Methods (==) :: ListNodesResponse -> ListNodesResponse -> Bool # (/=) :: ListNodesResponse -> ListNodesResponse -> Bool #
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 #
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 #
NFData ListNodesResponse Source #
Instance details Defined in Amazonka.Kafka.ListNodes Methods rnf :: ListNodesResponse -> () #
type Rep ListNodesResponse Source #
Instance details Defined in Amazonka.Kafka.ListNodes type Rep ListNodesResponse = D1 ('MetaData "ListNodesResponse" "Amazonka.Kafka.ListNodes" "libZSservicesZSamazonka-kafkaZSamazonka-kafka" 'False) (C1 ('MetaCons "ListNodesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nodeInfoList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [NodeInfo])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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:

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

$sel:nextToken: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:httpStatus:ListNodesResponse', listNodesResponse_httpStatus - The response's http status code.

Response Lenses

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

List containing a NodeInfo object.

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_httpStatus :: Lens' ListNodesResponse Int Source #

The response's http status code.