EC2 / Client / get_ipam_pool_allocations

get_ipam_pool_allocations

EC2.Client.get_ipam_pool_allocations(**kwargs)

Get a list of all the CIDR allocations in 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.

Note

If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_pool_allocations(
    DryRun=True|False,
    IpamPoolId='string',
    IpamPoolAllocationId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='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 you want to see the allocations for.

• IpamPoolAllocationId (string) – The ID of the allocation.

• Filters (list) –

  One or more filters for the request. For more information about filtering, see Filtering CLI output.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results you would like returned per page.

• NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPoolAllocations': [
        {
            'Cidr': 'string',
            'IpamPoolAllocationId': 'string',
            'Description': 'string',
            'ResourceId': 'string',
            'ResourceType': 'ipam-pool'|'vpc'|'ec2-public-ipv4-pool'|'custom'|'subnet'|'eip',
            'ResourceRegion': 'string',
            'ResourceOwner': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IpamPoolAllocations (list) –

    The IPAM pool allocations you want information on.

    • (dict) –

      In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

      • Cidr (string) –

        The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

      • IpamPoolAllocationId (string) –

        The ID of an allocation.

      • Description (string) –

        A description of the pool allocation.

      • ResourceId (string) –

        The ID of the resource.

      • ResourceType (string) –

        The type of the resource.

      • ResourceRegion (string) –

        The Amazon Web Services Region of the resource.

      • ResourceOwner (string) –

        The owner of the resource.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.