Deletes an IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.
Parameters:
-
dry_run
(Optional[Boolean], default:
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_policy_id
(Optional[IpamPolicyId], default:
None
)
–
The ID of the IPAM policy to delete.
Raises:
Source code in docs_src/capo_ec2/_services/async_ec2.py
| async def delete_ipam_policy(
self,
*,
config_overrides: Optional[AsyncEC2ClientConfig] = None,
dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
ipam_policy_id: Optional["capo_ec2.types.ipam_policy_id.IpamPolicyId"] = None,
) -> "capo_ec2.types.delete_ipam_policy_result.DeleteIpamPolicyResult":
"""<p>Deletes an IPAM policy.</p> <p>An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.</p>
Args:
dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
ipam_policy_id: <p>The ID of the IPAM policy to delete.</p>
Raises:
capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_ec2.types.delete_ipam_policy_request.DeleteIpamPolicyRequest]",
) -> AsyncOperationResponse[
"capo_ec2.types.delete_ipam_policy_result.DeleteIpamPolicyResult"
]:
import capo_ec2._operations.amazon_ec2.delete_ipam_policy
(
output,
http_response,
) = await capo_ec2._operations.amazon_ec2.delete_ipam_policy.async_delete_ipam_policy(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteIpamPolicy")
)
input_: capo_ec2.types.delete_ipam_policy_request.DeleteIpamPolicyRequest = {}
if dry_run is not None:
input_["dry_run"] = dry_run
if ipam_policy_id is not None:
input_["ipam_policy_id"] = ipam_policy_id
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|