Skip to content

EC2  >  Operations  >  delete_ipam

delete_ipam

Operation

delete_ipam async 

delete_ipam(input: DeleteIpamInput, plugins: list[Plugin] | None = None) -> DeleteIpamOutput

Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs.

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

Parameters:

Name Type Description Default
input DeleteIpamInput

An instance of DeleteIpamInput.

 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
DeleteIpamOutput

An instance of DeleteIpamOutput.

Input

DeleteIpamInput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamInput structure.

Attributes

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

Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following:

  • Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes.

Note: No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged.

  • Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes.

  • Deletes all IPAM pools in private scopes.

  • Deletes all non-default private scopes in the IPAM.

  • Deletes the default public and private scopes and the IPAM.

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_id class-attribute instance-attribute 
ipam_id: str | None = ...

The ID of the IPAM to delete.

Output

DeleteIpamOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamOutput structure.

Attributes

ipam class-attribute instance-attribute 
ipam: Ipam | 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.