Skip to content

EC2  >  Operations  >  describe_ipv6_pools

describe_ipv6_pools

Operation

describe_ipv6_pools async

describe_ipv6_pools(request: DescribeIpv6PoolsInput | DescribeIpv6PoolsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeIpv6PoolsOutput
describe_ipv6_pools(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpv6PoolsInputDict]) -> DescribeIpv6PoolsOutput

Describes your IPv6 address pools.

Parameters:

Name Type Description Default
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

Returns:

Type Description
DescribeIpv6PoolsOutput

An instance of DescribeIpv6PoolsOutput.

Input

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

Model

DescribeIpv6PoolsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpv6PoolsInput structure.

Attributes
dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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

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 IPv6 address pools.

Dictionaries

DescribeIpv6PoolsInputDict

Bases: TypedDict

Dictionary form of DescribeIpv6PoolsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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

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 IPv6 address pools.

Output

DescribeIpv6PoolsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpv6PoolsOutput structure.

Attributes

ipv6_pools class-attribute instance-attribute
ipv6_pools: list[Ipv6Pool] | None = ...

Information about the IPv6 address pools.

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.

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.