list_nodes ¶

def list_nodes(
    self,
    network_id: "capo_managedblockchain.types.resource_id_string.ResourceIdString",
    *,
    config_overrides: Optional[ManagedBlockchainClientConfig] = None,
    member_id: Optional[
        "capo_managedblockchain.types.resource_id_string.ResourceIdString"
    ] = None,
    status: Optional["capo_managedblockchain.types.node_status.NodeStatus"] = None,
    max_results: Optional[
        "capo_managedblockchain.types.node_list_max_results.NodeListMaxResults"
    ] = None,
    next_token: Optional[
        "capo_managedblockchain.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_managedblockchain.types.list_nodes_output.ListNodesOutput":
    """<p>Returns information about the nodes within a network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>

    Args:
        network_id: <p>The unique identifier of the network for which to list nodes.</p>
        member_id: <p>The unique identifier of the member who owns the nodes to list.</p> <p>Applies only to Hyperledger Fabric and is required for Hyperledger Fabric.</p>
        status: <p>An optional status specifier. If provided, only nodes currently in this status are listed.</p>
        max_results: <p>The maximum number of nodes to list.</p>
        next_token: <p>The pagination token that indicates the next set of results to retrieve.</p>

    Raises:
        capo_managedblockchain.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action.</p>
        capo_managedblockchain.errors.internal_service_error_exception.InternalServiceErrorException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_managedblockchain.errors.invalid_request_exception.InvalidRequestException: <p>The action or operation requested is invalid. Verify that the action is typed correctly.</p>
        capo_managedblockchain.errors.throttling_exception.ThrottlingException: <p>The request or operation couldn't be performed because a service is throttling requests. The most common source of throttling errors is creating resources that exceed your service limit for this resource type. Request a limit increase or delete unused resources if possible.</p>
        capo_managedblockchain.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_managedblockchain.types.list_nodes_input.ListNodesInput]",
    ) -> OperationResponse[
        "capo_managedblockchain.types.list_nodes_output.ListNodesOutput"
    ]:
        import capo_managedblockchain._operations.taiga_web_service.list_nodes

        output, http_response = (
            capo_managedblockchain._operations.taiga_web_service.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_managedblockchain.types.list_nodes_input.ListNodesInput = {
        "network_id": network_id
    }
    if member_id is not None:
        input_["member_id"] = member_id
    if status is not None:
        input_["status"] = status
    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