Skip to content

EC2  >  Operations  >  release_ipam_pool_allocation

release_ipam_pool_allocation

Operation

release_ipam_pool_allocation async 

release_ipam_pool_allocation(input: ReleaseIpamPoolAllocationInput, plugins: list[Plugin] | None = None) -> ReleaseIpamPoolAllocationOutput

Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the Amazon Web Services Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using ModifyIpamResourceCidr. For more information, see Release an allocation in the Amazon VPC IPAM User Guide.

Note

All EC2 API actions follow an eventual consistency model.

Parameters:

Name Type Description Default
input ReleaseIpamPoolAllocationInput

An instance of ReleaseIpamPoolAllocationInput.

 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
ReleaseIpamPoolAllocationOutput

An instance of ReleaseIpamPoolAllocationOutput.

Input

ReleaseIpamPoolAllocationInput dataclass

Bases: _SerdeShape

Dataclass for ReleaseIpamPoolAllocationInput structure.

Attributes

cidr class-attribute instance-attribute 
cidr: str | None = ...

The CIDR of the allocation you want to release.

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

The ID of the allocation.

ipam_pool_id class-attribute instance-attribute 
ipam_pool_id: str | None = ...

The ID of the IPAM pool which contains the allocation you want to release.

Output

ReleaseIpamPoolAllocationOutput dataclass

Bases: _SerdeShape

Dataclass for ReleaseIpamPoolAllocationOutput structure.

Attributes

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.

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

Indicates if the release was successful.