Amazon Elastic Compute Cloud

{'Filters': [{'Name': 'string', 'Values': ['string']}]}

{'PublicIpv4Pools': {'Tags': [{'Key': 'string', 'Value': 'string'}]}}

Describes the specified IPv4 address pools.

See also: AWS API Documentation

Request Syntax

client.describe_public_ipv4_pools(
    PoolIds=[
        'string',
    ],
    NextToken='string',
    MaxResults=123,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

type PoolIds

list

param PoolIds

The IDs of the address pools.

• (string) --

type NextToken

string

param NextToken

The token for the next page of results.

type MaxResults

integer

param MaxResults

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

type Filters

list

param Filters

One or more filters.

• tag :<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA , specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• (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. The filters supported by a describe operation are documented with the describe operation. For example:

  • DescribeAvailabilityZones

  • DescribeImages

  • DescribeInstances

  • DescribeKeyPairs

  • DescribeSecurityGroups

  • DescribeSnapshots

  • DescribeSubnets

  • DescribeTags

  • DescribeVolumes

  • DescribeVpcs

  • Name (string) --

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

  • Values (list) --

    The filter values. Filter values are case-sensitive.

    • (string) --

rtype

dict

returns

Response Syntax

{
    'PublicIpv4Pools': [
        {
            'PoolId': 'string',
            'Description': 'string',
            'PoolAddressRanges': [
                {
                    'FirstAddress': 'string',
                    'LastAddress': 'string',
                    'AddressCount': 123,
                    'AvailableAddressCount': 123
                },
            ],
            'TotalAddressCount': 123,
            'TotalAvailableAddressCount': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • PublicIpv4Pools (list) --

    Information about the address pools.

    • (dict) --

      Describes an IPv4 address pool.

      • PoolId (string) --

        The ID of the address pool.

      • Description (string) --

        A description of the address pool.

      • PoolAddressRanges (list) --

        The address ranges.

        • (dict) --

          Describes an address range of an IPv4 address pool.

          • FirstAddress (string) --

            The first IP address in the range.

          • LastAddress (string) --

            The last IP address in the range.

          • AddressCount (integer) --

            The number of addresses in the range.

          • AvailableAddressCount (integer) --

            The number of available addresses in the range.

      • TotalAddressCount (integer) --

        The total number of addresses.

      • TotalAvailableAddressCount (integer) --

        The total number of available addresses.

      • Tags (list) --

        Any tags for the address pool.

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