Skip to content

delete_transit_gateway_client_vpn_attachment

delete_transit_gateway_client_vpn_attachment(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_id: Optional[TransitGatewayAttachmentId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteTransitGatewayClientVpnAttachmentResult

Deletes a Transit Gateway attachment for a Client VPN endpoint. The Transit Gateway owner can delete the attachment to remove the association between the Client VPN endpoint and the Transit Gateway.

Parameters:

  • transit_gateway_attachment_id (Optional[TransitGatewayAttachmentId], default: None ) –

    The ID of the Transit Gateway attachment.

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def delete_transit_gateway_client_vpn_attachment(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_attachment_id: Optional[
        "capo_ec2.types.transit_gateway_attachment_id.TransitGatewayAttachmentId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_transit_gateway_client_vpn_attachment_result.DeleteTransitGatewayClientVpnAttachmentResult":
    """<p>Deletes a Transit Gateway attachment for a Client VPN endpoint. The Transit Gateway owner can delete the attachment to remove the association between the Client VPN endpoint and the Transit Gateway.</p>

    Args:
        transit_gateway_attachment_id: <p>The ID of the Transit Gateway attachment.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_transit_gateway_client_vpn_attachment_request.DeleteTransitGatewayClientVpnAttachmentRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_transit_gateway_client_vpn_attachment_result.DeleteTransitGatewayClientVpnAttachmentResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_transit_gateway_client_vpn_attachment

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_transit_gateway_client_vpn_attachment.delete_transit_gateway_client_vpn_attachment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteTransitGatewayClientVpnAttachment"),
    )
    input_: capo_ec2.types.delete_transit_gateway_client_vpn_attachment_request.DeleteTransitGatewayClientVpnAttachmentRequest = {}
    if transit_gateway_attachment_id is not None:
        input_["transit_gateway_attachment_id"] = transit_gateway_attachment_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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