Skip to content

describe_public_ipv4_pools

Operation

describe_public_ipv4_pools

describe_public_ipv4_pools(request: DescribePublicIpv4PoolsInput | DescribePublicIpv4PoolsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePublicIpv4PoolsInputDict]) -> DescribePublicIpv4PoolsOutput

Describes the specified IPv4 address pools.

Parameters:

Name Type Description Default
request DescribePublicIpv4PoolsInput | DescribePublicIpv4PoolsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribePublicIpv4PoolsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribePublicIpv4PoolsOutput

An instance of DescribePublicIpv4PoolsOutput.

describe_public_ipv4_pools async

describe_public_ipv4_pools(request: DescribePublicIpv4PoolsInput | DescribePublicIpv4PoolsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribePublicIpv4PoolsInputDict]) -> DescribePublicIpv4PoolsOutput

Describes the specified IPv4 address pools.

Parameters:

Name Type Description Default
request DescribePublicIpv4PoolsInput | DescribePublicIpv4PoolsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[DescribePublicIpv4PoolsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DescribePublicIpv4PoolsOutput

An instance of DescribePublicIpv4PoolsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DescribePublicIpv4PoolsInputDict

Bases: TypedDict

Dictionary form of DescribePublicIpv4PoolsInput.

Attributes

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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.

max_results instance-attribute
max_results: int | None

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: str | None

The token for the next page of results.

pool_ids instance-attribute
pool_ids: Sequence[str] | None

The IDs of the address pools.

DescribePublicIpv4PoolsInput dataclass

Bases: _SerdeShape

Dataclass for DescribePublicIpv4PoolsInput structure.

Attributes

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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.

max_results class-attribute instance-attribute
max_results: int | None = ...

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 class-attribute instance-attribute
next_token: str | None = ...

The token for the next page of results.

pool_ids class-attribute instance-attribute
pool_ids: list[str] | None = ...

The IDs of the address pools.

Output

DescribePublicIpv4PoolsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribePublicIpv4PoolsOutput structure.

Attributes

next_token class-attribute instance-attribute
next_token: str | None = ...

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

public_ipv4_pools class-attribute instance-attribute
public_ipv4_pools: list[PublicIpv4Pool] | None = ...

Information about the address pools.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.