EC2 / Client / describe_ipam_pool_allocations

describe_ipam_pool_allocations¶

EC2.Client.describe_ipam_pool_allocations(**kwargs)¶

Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID.

If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results.

Note

This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations.

Request Syntax

response = client.describe_ipam_pool_allocations(
    DryRun=True|False,
    IpamPoolAllocationIds=[
        '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.
IpamPoolAllocationIds (list) –
The IDs of the IPAM pool allocations you want to describe.
- (string) –
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.
  
  For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.
  - 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 items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
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'|'anycast-ip-list',
            'ResourceRegion': 'string',
            'ResourceOwner': 'string',
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- IpamPoolAllocations (list) –
  
  Information about the IPAM pool allocations.
  - (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.
    - Tags (list) –
      
      The tags for the IPAM pool allocation.
      - (dict) –
        
        Describes a tag.
        
        Key (string) –
        
        The key of the tag.
        
        Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
        
        Value (string) –
        
        The value of the tag.
        
        Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
- 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.