EC2 / Client / release_ipam_pool_allocation

release_ipam_pool_allocation#

EC2.Client.release_ipam_pool_allocation(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.release_ipam_pool_allocation(
    DryRun=True|False,
    IpamPoolId='string',
    Cidr='string',
    IpamPoolAllocationId='string'
)
Parameters:

  • DryRun (boolean) – 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.

  • IpamPoolId (string) –

    [REQUIRED]

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

  • Cidr (string) –

    [REQUIRED]

    The CIDR of the allocation you want to release.

  • IpamPoolAllocationId (string) –

    [REQUIRED]

    The ID of the allocation.

Return type:

dict

Returns:

Response Syntax

{
    'Success': True|False
}

Response Structure

  • (dict) –

    • Success (boolean) –

      Indicates if the release was successful.