delete_nat_gateway `async` ¶

delete_nat_gateway(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    nat_gateway_id: Optional[NatGatewayId] = None,
) -> DeleteNatGatewayResult

Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

Parameters:

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.
nat_gateway_id (Optional[NatGatewayId], default: None ) –

The ID of the NAT gateway.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To delete a NAT gateway This example deletes the specified NAT gateway.

>>> await client.delete_nat_gateway(nat_gateway_id='nat-04ae55e711cec5680')

Source code in docs_src/capo_ec2/_services/async_ec2.py

async def delete_nat_gateway(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    nat_gateway_id: Optional["capo_ec2.types.nat_gateway_id.NatGatewayId"] = None,
) -> "capo_ec2.types.delete_nat_gateway_result.DeleteNatGatewayResult":
    """<p>Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.</p>

    Args:
        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>
        nat_gateway_id: <p>The ID of the NAT gateway.</p>

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

    Examples:
        To delete a NAT gateway
        This example deletes the specified NAT gateway.

        >>> await client.delete_nat_gateway(nat_gateway_id='nat-04ae55e711cec5680')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.delete_nat_gateway_request.DeleteNatGatewayRequest]",
    ) -> AsyncOperationResponse[
        "capo_ec2.types.delete_nat_gateway_result.DeleteNatGatewayResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_nat_gateway

        (
            output,
            http_response,
        ) = await capo_ec2._operations.amazon_ec2.delete_nat_gateway.async_delete_nat_gateway(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteNatGateway")
    )
    input_: capo_ec2.types.delete_nat_gateway_request.DeleteNatGatewayRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if nat_gateway_id is not None:
        input_["nat_gateway_id"] = nat_gateway_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_nat_gateway async ¶

delete_nat_gateway `async` ¶