Request Parameters Response Elements Errors See Also

DescribeIpamPoolAllocations

Describes IPAM pool allocations. You can describe all allocations owned by you across all pools, or you can describe specific allocations by ID.

If you specify IpamPoolAllocationIds, the results include only the specified allocations. If you do not specify IpamPoolAllocationIds, the results include all allocations owned by you. You can use Filters to narrow the results.

Note

This action returns only allocations directly owned by you. To view all allocations in a pool you own or that has been shared with you, including allocations owned by other accounts, use GetIpamPoolAllocations.

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 is UnauthorizedOperation.

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.N

The IDs of the IPAM pool allocations you want to describe.

Type: Array of strings

Required: No

MaxResults

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.

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

Information about the IPAM pool allocations.

Type: Array of IpamPoolAllocation objects

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

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.