GetIpamPoolAllocations
Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the AWS Region where this IPAM pool is available for allocations.
Note
If you use this action after AllocateIpamPoolCidr or ReleaseIpamPoolAllocation, note that all EC2 API actions follow an eventual consistency model.
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
- IpamPoolAllocationId
-
The ID of the allocation.
Type: String
Required: No
- IpamPoolId
-
The ID of the IPAM pool you want to see the allocations for.
Type: String
Required: Yes
- MaxResults
-
The maximum number of results you would like returned per page.
Type: Integer
Valid Range: Minimum value of 1000. Maximum value of 100000.
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.
- ipamPoolAllocationSet
-
The IPAM pool allocations you want information on.
Type: Array of IpamPoolAllocation 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:
