Describe Ipam Pool Allocations

ec2_describe_ipam_pool_allocations

R Documentation

Describes IPAM pool allocations

Description

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.

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

Usage

ec2_describe_ipam_pool_allocations(DryRun, IpamPoolAllocationIds,
  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.
IpamPoolAllocationIds	The IDs of the IPAM pool allocations you want to describe.
Filters	One or more filters for the request. For more information about filtering, see Filtering CLI output.
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.
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"|"anycast-ip-list",
      ResourceRegion = "string",
      ResourceOwner = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_ipam_pool_allocations(
  DryRun = TRUE|FALSE,
  IpamPoolAllocationIds = list(
    "string"
  ),
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)