DescribePublicIpv4Pools
Describes the specified IPv4 address 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.
- Filter.N
-
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
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.
Type: Array of Filter objects
Required: No
-
- MaxResults
-
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned
nextToken
value.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 10.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
- PoolId.N
-
The IDs of the address pools.
Type: Array of strings
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.Type: String
- publicIpv4PoolSet
-
Information about the address pools.
Type: Array of PublicIpv4Pool objects
- 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: