Skip to content

delete_transit_gateway

delete_transit_gateway(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_id: Optional[TransitGatewayId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteTransitGatewayResult

Deletes the specified transit gateway.

Parameters:

  • transit_gateway_id (Optional[TransitGatewayId], default: None ) –

    The ID of the transit gateway.

  • 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(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    transit_gateway_id: Optional[
        "capo_ec2.types.transit_gateway_id.TransitGatewayId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_transit_gateway_result.DeleteTransitGatewayResult":
    """<p>Deletes the specified transit gateway.</p>

    Args:
        transit_gateway_id: <p>The ID of the transit gateway.</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_request.DeleteTransitGatewayRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_transit_gateway_result.DeleteTransitGatewayResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_transit_gateway

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTransitGateway")
    )
    input_: capo_ec2.types.delete_transit_gateway_request.DeleteTransitGatewayRequest = {}
    if transit_gateway_id is not None:
        input_["transit_gateway_id"] = transit_gateway_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