Deletes a carrier gateway.
If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see DeleteRoute.
Parameters:
-
carrier_gateway_id
(Optional[CarrierGatewayId], default:
None
)
–
The ID of the carrier 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_carrier_gateway(
self,
*,
config_overrides: Optional[EC2ClientConfig] = None,
carrier_gateway_id: Optional[
"capo_ec2.types.carrier_gateway_id.CarrierGatewayId"
] = None,
dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_carrier_gateway_result.DeleteCarrierGatewayResult":
"""<p>Deletes a carrier gateway.</p> <important> <p>If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html">DeleteRoute</a>.</p> </important>
Args:
carrier_gateway_id: <p>The ID of the carrier 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_carrier_gateway_request.DeleteCarrierGatewayRequest]",
) -> OperationResponse[
"capo_ec2.types.delete_carrier_gateway_result.DeleteCarrierGatewayResult"
]:
import capo_ec2._operations.amazon_ec2.delete_carrier_gateway
output, http_response = (
capo_ec2._operations.amazon_ec2.delete_carrier_gateway.delete_carrier_gateway(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteCarrierGateway")
)
input_: capo_ec2.types.delete_carrier_gateway_request.DeleteCarrierGatewayRequest = {}
if carrier_gateway_id is not None:
input_["carrier_gateway_id"] = carrier_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
|