Skip to content

list_networks async

list_networks(
    *,
    config_overrides: Optional[AsyncManagedBlockchainClientConfig] = None,
    name: Optional[String] = None,
    framework: Optional[Framework] = None,
    status: Optional[NetworkStatus] = None,
    max_results: Optional[NetworkListMaxResults] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListNetworksOutput

Returns information about the networks in which the current Amazon Web Services account participates.

Applies to Hyperledger Fabric and Ethereum.

Parameters:

  • name (Optional[String], default: None ) –

    The name of the network.

  • framework (Optional[Framework], default: None ) –

    An optional framework specifier. If provided, only networks of this framework type are listed.

  • status (Optional[NetworkStatus], default: None ) –

    An optional status specifier. If provided, only networks currently in this status are listed.

    Applies only to Hyperledger Fabric.

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

    The maximum number of networks to list.

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

    The pagination token that indicates the next set of results to retrieve.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action.

  • InternalServiceErrorException –

    The request processing has failed because of an unknown error, exception or failure.

  • InvalidRequestException –

    The action or operation requested is invalid. Verify that the action is typed correctly.

  • ThrottlingException –

    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.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_managedblockchain/_services/async_managed_blockchain.py
async def list_networks(
    self,
    *,
    config_overrides: Optional[AsyncManagedBlockchainClientConfig] = None,
    name: Optional["capo_managedblockchain.types.string.String"] = None,
    framework: Optional["capo_managedblockchain.types.framework.Framework"] = None,
    status: Optional[
        "capo_managedblockchain.types.network_status.NetworkStatus"
    ] = None,
    max_results: Optional[
        "capo_managedblockchain.types.network_list_max_results.NetworkListMaxResults"
    ] = None,
    next_token: Optional[
        "capo_managedblockchain.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_managedblockchain.types.list_networks_output.ListNetworksOutput":
    """<p>Returns information about the networks in which the current Amazon Web Services account participates.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>

    Args:
        name: <p>The name of the network.</p>
        framework: <p>An optional framework specifier. If provided, only networks of this framework type are listed.</p>
        status: <p>An optional status specifier. If provided, only networks currently in this status are listed.</p> <p>Applies only to Hyperledger Fabric.</p>
        max_results: <p>The maximum number of networks 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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_managedblockchain.types.list_networks_input.ListNetworksInput]",
    ) -> AsyncOperationResponse[
        "capo_managedblockchain.types.list_networks_output.ListNetworksOutput"
    ]:
        import capo_managedblockchain._operations.taiga_web_service.list_networks

        (
            output,
            http_response,
        ) = await capo_managedblockchain._operations.taiga_web_service.list_networks.async_list_networks(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListNetworks")
    )
    input_: capo_managedblockchain.types.list_networks_input.ListNetworksInput = {}
    if name is not None:
        input_["name"] = name
    if framework is not None:
        input_["framework"] = framework
    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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output