DeleteIpam
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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- Cascade
-
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.
Type: Boolean
Required: No
-
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- IpamId
-
The ID of the IPAM to delete.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- ipam
-
Information about the results of the deletion.
Type: Ipam object
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: