Skip to content

describe_connections_on_interconnect

describe_connections_on_interconnect(
    interconnect_id: InterconnectId,
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
) -> Connections

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by Direct Connect Partners only.

Parameters:

Raises:

Source code in docs_src/capo_direct_connect/_services/direct_connect.py
def describe_connections_on_interconnect(
    self,
    interconnect_id: "capo_direct_connect.types.interconnect_id.InterconnectId",
    *,
    config_overrides: Optional[DirectConnectClientConfig] = None,
) -> "capo_direct_connect.types.connections.Connections":
    """<note> <p>Deprecated. Use <a>DescribeHostedConnections</a> instead.</p> </note> <p>Lists the connections that have been provisioned on the specified interconnect.</p> <note> <p>Intended for use by Direct Connect Partners only.</p> </note>

    Args:
        interconnect_id: <p>The ID of the interconnect.</p>

    Raises:
        capo_direct_connect.errors.direct_connect_client_exception.DirectConnectClientException: <p>One or more parameters are not valid.</p>
        capo_direct_connect.errors.direct_connect_server_exception.DirectConnectServerException: <p>A server-side error occurred.</p>
        capo_direct_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_direct_connect.types.describe_connections_on_interconnect_request.DescribeConnectionsOnInterconnectRequest]",
    ) -> OperationResponse["capo_direct_connect.types.connections.Connections"]:
        import capo_direct_connect._operations.overture_service.describe_connections_on_interconnect

        output, http_response = (
            capo_direct_connect._operations.overture_service.describe_connections_on_interconnect.describe_connections_on_interconnect(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConnectionsOnInterconnect")
    )
    input_: capo_direct_connect.types.describe_connections_on_interconnect_request.DescribeConnectionsOnInterconnectRequest = {
        "interconnect_id": interconnect_id
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output