[ aws . kafka ]

list-nodes

Description

Returns a list of the broker nodes in the cluster.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

list-nodes is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: NodeInfoList

Synopsis

  list-nodes
--cluster-arn <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--cluster-arn (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

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.

(structure)

The node information object.

AddedToClusterTime -> (string)

The start time.

BrokerNodeInfo -> (structure)

The broker node info.

AttachedENIId -> (string)

The attached elastic network interface of the broker.

BrokerId -> (double)

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 -> (structure)

Information about the version of software currently deployed on the 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 -> (long)

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)

InstanceType -> (string)

The instance type.

NodeARN -> (string)

The Amazon Resource Name (ARN) of the node.

NodeType -> (string)

The node type.

ZookeeperNodeInfo -> (structure)

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 -> (double)

The role-specific ID for Zookeeper.

ZookeeperVersion -> (string)

The version of Zookeeper.