Skip to content

list_connect_peers

list_connect_peers(
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    core_network_id: Optional[CoreNetworkId] = None,
    connect_attachment_id: Optional[AttachmentId] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListConnectPeersResponse

Returns a list of core network Connect peers.

Parameters:

Raises:

Source code in docs_src/capo_networkmanager/_services/network_manager.py
def list_connect_peers(
    self,
    *,
    config_overrides: Optional[NetworkManagerClientConfig] = None,
    core_network_id: Optional[
        "capo_networkmanager.types.core_network_id.CoreNetworkId"
    ] = None,
    connect_attachment_id: Optional[
        "capo_networkmanager.types.attachment_id.AttachmentId"
    ] = 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_connect_peers_response.ListConnectPeersResponse"
):
    """<p>Returns a list of core network Connect peers.</p>

    Args:
        core_network_id: <p>The ID of a core network.</p>
        connect_attachment_id: <p>The ID of the attachment.</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.
    """

    def _handler(
        req: "OperationRequest[capo_networkmanager.types.list_connect_peers_request.ListConnectPeersRequest]",
    ) -> OperationResponse[
        "capo_networkmanager.types.list_connect_peers_response.ListConnectPeersResponse"
    ]:
        import capo_networkmanager._operations.network_manager.list_connect_peers

        output, http_response = (
            capo_networkmanager._operations.network_manager.list_connect_peers.list_connect_peers(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListConnectPeers")
    )
    input_: capo_networkmanager.types.list_connect_peers_request.ListConnectPeersRequest = {}
    if core_network_id is not None:
        input_["core_network_id"] = core_network_id
    if connect_attachment_id is not None:
        input_["connect_attachment_id"] = connect_attachment_id
    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