Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-171,1822,9897.4 MB

Get information about your IPAM pools.

get/#Action=DescribeIpamPools

Query parameters

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Namestring

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

Valuesstring[]

The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an <code>OR</code>, and the request returns all results that match any of the specified values.

One or more filters for the request. For more information about filtering, see <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html">Filtering CLI output</a>.

MaxResultsinteger

The maximum number of results to return in the request.

NextTokenstring

The token for the next page of results.

IpamPoolIdstring[]

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

Action'DescribeIpamPools' required
Version'2016-11-15' required

Response

Success