Kafka / Client / list_nodes

list_nodes

Kafka.Client.list_nodes(**kwargs)

Returns a list of the broker nodes in the cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_nodes(
    ClusterArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

• ClusterArn (string) –

  [REQUIRED]

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

• MaxResults (integer) – The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

• NextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'NodeInfoList': [
        {
            'AddedToClusterTime': 'string',
            'BrokerNodeInfo': {
                'AttachedENIId': 'string',
                'BrokerId': 123.0,
                'ClientSubnet': 'string',
                'ClientVpcIpAddress': 'string',
                'CurrentBrokerSoftwareInfo': {
                    'ConfigurationArn': 'string',
                    'ConfigurationRevision': 123,
                    'KafkaVersion': 'string'
                },
                'Endpoints': [
                    'string',
                ]
            },
            'ControllerNodeInfo': {
                'Endpoints': [
                    'string',
                ]
            },
            'InstanceType': 'string',
            'NodeARN': 'string',
            'NodeType': 'BROKER',
            'ZookeeperNodeInfo': {
                'AttachedENIId': 'string',
                'ClientVpcIpAddress': 'string',
                'Endpoints': [
                    'string',
                ],
                'ZookeeperId': 123.0,
                'ZookeeperVersion': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  Successful response.

  • NextToken (string) –

    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 (list) –

    List containing a NodeInfo object.

    • (dict) –

      The node information object.

      • AddedToClusterTime (string) –

        The start time.

      • BrokerNodeInfo (dict) –

        The broker node info.

        • AttachedENIId (string) –

          The attached elastic network interface of the broker.

        • BrokerId (float) –

          The ID of the broker.

        • ClientSubnet (string) –

          The client subnet to which this broker node belongs.

        • ClientVpcIpAddress (string) –

          The virtual private cloud (VPC) of the client.

        • CurrentBrokerSoftwareInfo (dict) –

          Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

          • ConfigurationArn (string) –

            The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn’t visible in this preview release.

          • ConfigurationRevision (integer) –

            The revision of the configuration to use. This field isn’t visible in this preview release.

          • KafkaVersion (string) –

            The version of Apache Kafka.

        • Endpoints (list) –

          Endpoints for accessing the broker.

          • (string) –

      • ControllerNodeInfo (dict) –

        The ControllerNodeInfo.

        • Endpoints (list) –

          Endpoints for accessing the Controller.

          • (string) –

      • InstanceType (string) –

        The instance type.

      • NodeARN (string) –

        The Amazon Resource Name (ARN) of the node.

      • NodeType (string) –

        The node type.

      • ZookeeperNodeInfo (dict) –

        The ZookeeperNodeInfo.

        • AttachedENIId (string) –

          The attached elastic network interface of the broker.

        • ClientVpcIpAddress (string) –

          The virtual private cloud (VPC) IP address of the client.

        • Endpoints (list) –

          Endpoints for accessing the ZooKeeper.

          • (string) –

        • ZookeeperId (float) –

          The role-specific ID for Zookeeper.

        • ZookeeperVersion (string) –

          The version of Zookeeper.

Exceptions

• Kafka.Client.exceptions.NotFoundException

• Kafka.Client.exceptions.BadRequestException

• Kafka.Client.exceptions.InternalServerErrorException

• Kafka.Client.exceptions.ForbiddenException