delete_subnet `async` ¶

delete_subnet(
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    subnet_id: Optional[SubnetId] = None,
    dry_run: Optional[Boolean] = None,
) -> None

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

Parameters:

subnet_id (Optional[SubnetId], default: None ) –

The ID of the subnet.
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:

UnknownServiceError –

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

Examples:

To delete a subnet This example deletes the specified subnet.

>>> await client.delete_subnet(subnet_id='subnet-9d4a7b6c')

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

async def delete_subnet(
    self,
    *,
    config_overrides: Optional[AsyncEC2ClientConfig] = None,
    subnet_id: Optional["capo_ec2.types.subnet_id.SubnetId"] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> None:
    """<p>Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.</p>

    Args:
        subnet_id: <p>The ID of the subnet.</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.

    Examples:
        To delete a subnet
        This example deletes the specified subnet.

        >>> await client.delete_subnet(subnet_id='subnet-9d4a7b6c')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_ec2.types.delete_subnet_request.DeleteSubnetRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_ec2._operations.amazon_ec2.delete_subnet

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteSubnet")
    )
    input_: capo_ec2.types.delete_subnet_request.DeleteSubnetRequest = {}
    if subnet_id is not None:
        input_["subnet_id"] = subnet_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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

delete_subnet async ¶

delete_subnet `async` ¶