Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).
Intended for use by Direct Connect Partners only.
Parameters:
-
connection_id
(ConnectionId)
–
The ID of the interconnect or LAG.
-
max_results
(Optional[MaxResultSetSize], default:
None
)
–
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
If MaxResults is given a value larger than 100, only 100 results are returned.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The token for the next page of results.
Raises:
Source code in docs_src/capo_direct_connect/_services/direct_connect.py
| def describe_hosted_connections(
self,
connection_id: "capo_direct_connect.types.connection_id.ConnectionId",
*,
config_overrides: Optional[DirectConnectClientConfig] = None,
max_results: Optional[
"capo_direct_connect.types.max_result_set_size.MaxResultSetSize"
] = None,
next_token: Optional[
"capo_direct_connect.types.pagination_token.PaginationToken"
] = None,
) -> "capo_direct_connect.types.connections.Connections":
"""<p>Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).</p> <note> <p>Intended for use by Direct Connect Partners only.</p> </note>
Args:
connection_id: <p>The ID of the interconnect or LAG.</p>
max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p> <p>If <code>MaxResults</code> is given a value larger than 100, only 100 results are returned.</p>
next_token: <p>The token for the next page of results.</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_hosted_connections_request.DescribeHostedConnectionsRequest]",
) -> OperationResponse["capo_direct_connect.types.connections.Connections"]:
import capo_direct_connect._operations.overture_service.describe_hosted_connections
output, http_response = (
capo_direct_connect._operations.overture_service.describe_hosted_connections.describe_hosted_connections(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeHostedConnections")
)
input_: capo_direct_connect.types.describe_hosted_connections_request.DescribeHostedConnectionsRequest = {
"connection_id": connection_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
|