list_nodes async ¶

async def list_nodes(
    self,
    cluster_arn: "capo_kafka.types.__string.__string",
    *,
    config_overrides: Optional[AsyncKafkaClientConfig] = 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.
    """

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

        (
            output,
            http_response,
        ) = await capo_kafka._operations.kafka.list_nodes.async_list_nodes(
            req.options, req.input
        )
        return AsyncOperationResponse(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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output