DescribeIpamPools
Get information about your IPAM pools.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- DryRun
-
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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
One or more filters for the request. For more information about filtering, see Filtering CLI output.
Type: Array of Filter objects
Required: No
- IpamPoolId.N
-
The IDs of the IPAM pools you would like information on.
Type: Array of strings
Required: No
- MaxResults
-
The maximum number of results to return in the request.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- ipamPoolSet
-
Information about the IPAM pools.
Type: Array of IpamPool objects
- nextToken
-
The token to use to retrieve the next page of results. This value is
nullwhen there are no more results to return.Type: String
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
