EC2 / Client / get_ipam_pool_cidrs

get_ipam_pool_cidrs

EC2.Client.get_ipam_pool_cidrs(**kwargs)

Get the CIDRs provisioned to an IPAM pool.

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_pool_cidrs(
    DryRun=True|False,
    IpamPoolId='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 the CIDR for.

• 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 results to return in the request.

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

Return type:

dict

Returns:

Response Syntax

{
    'IpamPoolCidrs': [
        {
            'Cidr': 'string',
            'State': 'pending-provision'|'provisioned'|'failed-provision'|'pending-deprovision'|'deprovisioned'|'failed-deprovision'|'pending-import'|'failed-import',
            'FailureReason': {
                'Code': 'cidr-not-available'|'limit-exceeded',
                'Message': 'string'
            },
            'IpamPoolCidrId': 'string',
            'NetmaskLength': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • IpamPoolCidrs (list) –

    Information about the CIDRs provisioned to an IPAM pool.

    • (dict) –

      A CIDR provisioned to an IPAM pool.

      • Cidr (string) –

        The CIDR provisioned to the IPAM pool. 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.

      • State (string) –

        The state of the CIDR.

      • FailureReason (dict) –

        Details related to why an IPAM pool CIDR failed to be provisioned.

        • Code (string) –

          An error code related to why an IPAM pool CIDR failed to be provisioned.

        • Message (string) –

          A message related to why an IPAM pool CIDR failed to be provisioned.

      • IpamPoolCidrId (string) –

        The IPAM pool CIDR ID.

      • NetmaskLength (integer) –

        The netmask length of the CIDR you’d like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. “NetmaskLength” or “Cidr” is required.

  • 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.