Skip to content

EC2  >  Operations  >  describe_ipam_pools

describe_ipam_pools

Operation

describe_ipam_pools async

describe_ipam_pools(request: DescribeIpamPoolsInput | DescribeIpamPoolsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeIpamPoolsOutput
describe_ipam_pools(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeIpamPoolsInputDict]) -> DescribeIpamPoolsOutput

Get information about your IPAM 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
DescribeIpamPoolsOutput

An instance of DescribeIpamPoolsOutput.

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

DescribeIpamPoolsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamPoolsInput structure.

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

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.

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

One or more filters for the request. For more information about filtering, see Filtering CLI output.

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

The IDs of the IPAM pools you would like information on.

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

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

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

The token for the next page of results.

Dictionaries

DescribeIpamPoolsInputDict

Bases: TypedDict

Dictionary form of DescribeIpamPoolsInput.

Attributes
dry_run instance-attribute
dry_run: bool | None

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.

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

One or more filters for the request. For more information about filtering, see Filtering CLI output.

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

The IDs of the IPAM pools you would like information on.

max_results instance-attribute
max_results: int | None

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

next_token instance-attribute
next_token: str | None

The token for the next page of results.

Output

DescribeIpamPoolsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeIpamPoolsOutput structure.

Attributes

ipam_pools class-attribute instance-attribute
ipam_pools: list[IpamPool] | None = ...

Information about the IPAM 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.