| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.DeleteIpamPool
Description
Delete an IPAM pool.
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.
Synopsis
- data DeleteIpamPool = DeleteIpamPool' {
- dryRun :: Maybe Bool
- ipamPoolId :: Text
- newDeleteIpamPool :: Text -> DeleteIpamPool
- deleteIpamPool_dryRun :: Lens' DeleteIpamPool (Maybe Bool)
- deleteIpamPool_ipamPoolId :: Lens' DeleteIpamPool Text
- data DeleteIpamPoolResponse = DeleteIpamPoolResponse' {
- ipamPool :: Maybe IpamPool
- httpStatus :: Int
- newDeleteIpamPoolResponse :: Int -> DeleteIpamPoolResponse
- deleteIpamPoolResponse_ipamPool :: Lens' DeleteIpamPoolResponse (Maybe IpamPool)
- deleteIpamPoolResponse_httpStatus :: Lens' DeleteIpamPoolResponse Int
Creating a Request
data DeleteIpamPool Source #
See: newDeleteIpamPool smart constructor.
Constructors
| DeleteIpamPool' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DeleteIpamPool |
Create a value of DeleteIpamPool with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dryRun:DeleteIpamPool', deleteIpamPool_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 is UnauthorizedOperation.
DeleteIpamPool, deleteIpamPool_ipamPoolId - The ID of the pool to delete.
Request Lenses
deleteIpamPool_dryRun :: Lens' DeleteIpamPool (Maybe Bool) Source #
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.
deleteIpamPool_ipamPoolId :: Lens' DeleteIpamPool Text Source #
The ID of the pool to delete.
Destructuring the Response
data DeleteIpamPoolResponse Source #
See: newDeleteIpamPoolResponse smart constructor.
Constructors
| DeleteIpamPoolResponse' | |
Fields
| |
Instances
newDeleteIpamPoolResponse Source #
Create a value of DeleteIpamPoolResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ipamPool:DeleteIpamPoolResponse', deleteIpamPoolResponse_ipamPool - Information about the results of the deletion.
$sel:httpStatus:DeleteIpamPoolResponse', deleteIpamPoolResponse_httpStatus - The response's http status code.
Response Lenses
deleteIpamPoolResponse_ipamPool :: Lens' DeleteIpamPoolResponse (Maybe IpamPool) Source #
Information about the results of the deletion.
deleteIpamPoolResponse_httpStatus :: Lens' DeleteIpamPoolResponse Int Source #
The response's http status code.