Skip to content

list_nodes 

list_nodes(
    cluster_arn: __string,
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[__string] = None,
) -> ListNodesResponse

Returns a list of the broker nodes in the cluster.

Parameters:

  • cluster_arn (__string) –

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

  • max_results (Optional[MaxResults], default: None ) –

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

  • next_token (Optional[__string], default: None ) –

    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.

Raises:

Source code in docs_src/capo_kafka/_services/kafka.py 
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
def list_nodes(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[KafkaClientConfig] = None,
    max_results: Optional["capo_kafka.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_kafka.types.__string.__string"] = None,
) -> "capo_kafka.types.list_nodes_response.ListNodesResponse":
    """<p>Returns a list of the broker nodes in the cluster.</p>

    Args:
        cluster_arn: <p>The Amazon Resource Name (ARN) that uniquely identifies the cluster.</p>
        max_results: <p>The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.</p>
        next_token: <p>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.</p>

    Raises:
        capo_kafka.errors.bad_request_exception.BadRequestException: <p>Returns information about an error.</p>
        capo_kafka.errors.forbidden_exception.ForbiddenException: <p>Returns information about an error.</p>
        capo_kafka.errors.internal_server_error_exception.InternalServerErrorException: <p>Returns information about an error.</p>
        capo_kafka.errors.not_found_exception.NotFoundException: <p>Returns information about an error.</p>
        capo_kafka.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kafka.types.list_nodes_request.ListNodesRequest]",
    ) -> OperationResponse[
        "capo_kafka.types.list_nodes_response.ListNodesResponse"
    ]:
        import capo_kafka._operations.kafka.list_nodes

        output, http_response = capo_kafka._operations.kafka.list_nodes.list_nodes(
            req.options, req.input
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNodes")
    )
    input_: capo_kafka.types.list_nodes_request.ListNodesRequest = {
        "cluster_arn": cluster_arn
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output