Deletes an existing Connection with the supplied identifier.
This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the Connection will cease to exist.
Parameters:
Raises:
Examples:
Delete Connection
>>> await client.delete_connection(identifier='mcc-abc12345')
Source code in docs_src/capo_interconnect/_services/async_interconnect.py
| async def delete_connection(
self,
identifier: "capo_interconnect.types.connection_id.ConnectionId",
*,
config_overrides: Optional[AsyncInterconnectClientConfig] = None,
client_token: Optional[str] = None,
) -> "capo_interconnect.types.delete_connection_response.DeleteConnectionResponse":
"""<p>Deletes an existing Connection with the supplied identifier.</p> <p>This operation will also inform the remote partner of your intention to delete your connection. Note, the partner may still require you to delete to fully clean up resources, but the network connectivity provided by the <a>Connection</a> will cease to exist.</p>
Args:
identifier: <p>The identifier of the <a>Connection</a> to be deleted. </p>
client_token: <p>Idempotency token used for the request.</p>
Raises:
capo_interconnect.errors.access_denied_exception.AccessDeniedException: <p>The calling principal is not allowed to access the specified resource, or the resource does not exist.</p>
capo_interconnect.errors.interconnect_client_exception.InterconnectClientException: <p>The request was denied due to incorrect client supplied parameters.</p>
capo_interconnect.errors.interconnect_server_exception.InterconnectServerException: <p>The request resulted in an exception internal to the service.</p>
capo_interconnect.errors.interconnect_validation_exception.InterconnectValidationException: <p>The input fails to satisfy the constraints specified.</p>
capo_interconnect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request specifies a resource that does not exist on the server.</p>
capo_interconnect.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The requested operation would result in the calling principal exceeding their allotted quota.</p>
capo_interconnect.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_interconnect.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
Delete Connection
>>> await client.delete_connection(identifier='mcc-abc12345')
"""
async def _handler(
req: "AsyncOperationRequest[capo_interconnect.types.delete_connection_request.DeleteConnectionRequest]",
) -> AsyncOperationResponse[
"capo_interconnect.types.delete_connection_response.DeleteConnectionResponse"
]:
import capo_interconnect._operations.interconnect.delete_connection
(
output,
http_response,
) = await capo_interconnect._operations.interconnect.delete_connection.async_delete_connection(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
def _redact_output(
output: "capo_interconnect.types.delete_connection_response.DeleteConnectionResponse",
) -> dict[str, Any]:
import capo_interconnect.types.delete_connection_response
return capo_interconnect.types.delete_connection_response.redact_sensitive(
output
)
interceptors_, options_ = self.operation_options(
config_overrides,
OperationLogging("DeleteConnection", redact_output=_redact_output),
)
input_: capo_interconnect.types.delete_connection_request.DeleteConnectionRequest = {
"identifier": identifier
}
if client_token is None:
client_token = str(uuid.uuid4())
input_["client_token"] = client_token
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|