Skip to content

EC2  >  Operations  >  delete_ipam_pool

delete_ipam_pool

Operation

delete_ipam_pool async 

delete_ipam_pool(input: DeleteIpamPoolInput, plugins: list[Plugin] | None = None) -> DeleteIpamPoolOutput

Delete an IPAM pool.

Note

You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see ReleaseIpamPoolAllocation. To deprovision pool CIDRs, see DeprovisionIpamPoolCidr.

For more information, see Delete a pool in the Amazon VPC IPAM User Guide.

Parameters:

Name Type Description Default
input DeleteIpamPoolInput

An instance of DeleteIpamPoolInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteIpamPoolOutput

An instance of DeleteIpamPoolOutput.

Input

DeleteIpamPoolInput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamPoolInput structure.

Attributes

cascade class-attribute instance-attribute 
cascade: bool | None = ...

Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools.

Warning

You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

A check for 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.

ipam_pool_id class-attribute instance-attribute 
ipam_pool_id: str | None = ...

The ID of the pool to delete.

Output

DeleteIpamPoolOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamPoolOutput structure.

Attributes

ipam_pool class-attribute instance-attribute 
ipam_pool: IpamPool | None = ...

Information about the results of the deletion.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.