Skip to content

delete_ipam_policy

Operation

delete_ipam_policy

delete_ipam_policy(request: DeleteIpamPolicyInput | DeleteIpamPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIpamPolicyInputDict]) -> DeleteIpamPolicyOutput

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:

Name Type Description Default
request DeleteIpamPolicyInput | DeleteIpamPolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteIpamPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIpamPolicyOutput

An instance of DeleteIpamPolicyOutput.

delete_ipam_policy async

delete_ipam_policy(request: DeleteIpamPolicyInput | DeleteIpamPolicyInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteIpamPolicyInputDict]) -> DeleteIpamPolicyOutput

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:

Name Type Description Default
request DeleteIpamPolicyInput | DeleteIpamPolicyInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[DeleteIpamPolicyInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteIpamPolicyOutput

An instance of DeleteIpamPolicyOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteIpamPolicyInputDict

Bases: TypedDict

Dictionary form of DeleteIpamPolicyInput.

Attributes

dry_run 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_policy_id instance-attribute
ipam_policy_id: Required[str]

The ID of the IPAM policy to delete.

DeleteIpamPolicyInput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamPolicyInput structure.

Attributes

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

The ID of the IPAM policy to delete.

Output

DeleteIpamPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteIpamPolicyOutput structure.

Attributes

ipam_policy class-attribute instance-attribute
ipam_policy: IpamPolicy | None = ...

Information about the deleted 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.

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.