Skip to content

DescribePublicIpv4PoolsRequest

Source code in docs_src/capo_ec2/types/describe_public_ipv4_pools_request.py
class DescribePublicIpv4PoolsRequest(TypedDict, closed=True):
    pool_ids: NotRequired[
        "capo_ec2.types.public_ipv4_pool_id_string_list.PublicIpv4PoolIdStringList"
    ]
    """<p>The IDs of the address pools.</p>"""
    next_token: NotRequired["capo_ec2.types.next_token.NextToken"]
    """<p>The token for the next page of results.</p>"""
    max_results: NotRequired["capo_ec2.types.pool_max_results.PoolMaxResults"]
    """<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>One or more filters.</p> <ul> <li> <p> <code>tag</code>:<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 <code>Owner</code> and the value <code>TeamA</code>, specify <code>tag:Owner</code> for the filter name and <code>TeamA</code> for the filter value.</p> </li> <li> <p> <code>tag-key</code> - 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.</p> </li> </ul>"""

filters instance-attribute

filters: NotRequired[FilterList]

One or more filters.

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

max_results instance-attribute

max_results: NotRequired[PoolMaxResults]

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

next_token instance-attribute

next_token: NotRequired[NextToken]

The token for the next page of results.

pool_ids instance-attribute

pool_ids: NotRequired[PublicIpv4PoolIdStringList]

The IDs of the address pools.