Skip to content

Get the CIDRs provisioned to an IPAM pool

Description

Get the CIDRs provisioned to an IPAM pool.

Usage

ec2_get_ipam_pool_cidrs(DryRun, IpamPoolId, 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 the CIDR for.

  • 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(
  IpamPoolCidrs = list(
    list(
      Cidr = "string",
      State = "pending-provision"|"provisioned"|"failed-provision"|"pending-deprovision"|"deprovisioned"|"failed-deprovision"|"pending-import"|"failed-import",
      FailureReason = list(
        Code = "cidr-not-available"|"limit-exceeded",
        Message = "string"
      ),
      IpamPoolCidrId = "string",
      NetmaskLength = 123
    )
  ),
  NextToken = "string"
)

Request syntax

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