Skip to content

list_peerings async

list_peerings(
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    core_network_id: Optional[CoreNetworkId] = None,
    peering_type: Optional[PeeringType] = None,
    edge_location: Optional[ExternalRegionCode] = None,
    state: Optional[PeeringState] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListPeeringsResponse

Lists the peerings for a core network.

Parameters:

Raises:

Source code in docs_src/capo_networkmanager/_services/async_network_manager.py
async def list_peerings(
    self,
    *,
    config_overrides: Optional[AsyncNetworkManagerClientConfig] = None,
    core_network_id: Optional[
        "capo_networkmanager.types.core_network_id.CoreNetworkId"
    ] = None,
    peering_type: Optional[
        "capo_networkmanager.types.peering_type.PeeringType"
    ] = None,
    edge_location: Optional[
        "capo_networkmanager.types.external_region_code.ExternalRegionCode"
    ] = None,
    state: Optional["capo_networkmanager.types.peering_state.PeeringState"] = None,
    max_results: Optional[
        "capo_networkmanager.types.max_results.MaxResults"
    ] = None,
    next_token: Optional["capo_networkmanager.types.next_token.NextToken"] = None,
) -> "capo_networkmanager.types.list_peerings_response.ListPeeringsResponse":
    """<p>Lists the peerings for a core network.</p>

    Args:
        core_network_id: <p>The ID of a core network.</p>
        peering_type: <p>Returns a list of a peering requests.</p>
        edge_location: <p>Returns a list edge locations for the </p>
        state: <p>Returns a list of the peering request states.</p>
        max_results: <p>The maximum number of results to return.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_networkmanager.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_networkmanager.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal error.</p>
        capo_networkmanager.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_networkmanager.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints.</p>
        capo_networkmanager.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_networkmanager.types.list_peerings_request.ListPeeringsRequest]",
    ) -> AsyncOperationResponse[
        "capo_networkmanager.types.list_peerings_response.ListPeeringsResponse"
    ]:
        import capo_networkmanager._operations.network_manager.list_peerings

        (
            output,
            http_response,
        ) = await capo_networkmanager._operations.network_manager.list_peerings.async_list_peerings(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListPeerings")
    )
    input_: capo_networkmanager.types.list_peerings_request.ListPeeringsRequest = {}
    if core_network_id is not None:
        input_["core_network_id"] = core_network_id
    if peering_type is not None:
        input_["peering_type"] = peering_type
    if edge_location is not None:
        input_["edge_location"] = edge_location
    if state is not None:
        input_["state"] = state
    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