Get Ipam Pool Allocations

ec2_get_ipam_pool_allocations

R Documentation

Get a list of all the CIDR allocations in an IPAM pool¶

Description¶

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 Amazon Web Services Region where this IPAM pool is available for allocations.

If you use this action after allocate_ipam_pool_cidr or release_ipam_pool_allocation, note that all EC2 API actions follow an eventual consistency model.

Usage¶

ec2_get_ipam_pool_allocations(DryRun, IpamPoolId, IpamPoolAllocationId,
  Filters, MaxResults, NextToken)

Arguments¶

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.
IpamPoolId: [required] The ID of the IPAM pool you want to see the allocations for.
IpamPoolAllocationId: The ID of the allocation.
Filters: One or more filters for the request. For more information about filtering, see Filtering CLI output.
MaxResults: The maximum number of results you would like returned per page.
NextToken: The token for the next page of results.

Value¶

A list with the following syntax:

list(
  IpamPoolAllocations = list(
    list(
      Cidr = "string",
      IpamPoolAllocationId = "string",
      Description = "string",
      ResourceId = "string",
      ResourceType = "ipam-pool"|"vpc"|"ec2-public-ipv4-pool"|"custom"|"subnet"|"eip",
      ResourceRegion = "string",
      ResourceOwner = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$get_ipam_pool_allocations(
  DryRun = TRUE|FALSE,
  IpamPoolId = "string",
  IpamPoolAllocationId = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)