Describe Ipam Pools

ec2_describe_ipam_pools

R Documentation

Get information about your IPAM pools

Description

Get information about your IPAM pools.

Usage

ec2_describe_ipam_pools(DryRun, Filters, MaxResults, NextToken,
  IpamPoolIds)

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.

Filters

One or more filters for the request. For more information about filtering, see Filtering CLI output.

MaxResults

The maximum number of results to return in the request.

NextToken

The token for the next page of results.

IpamPoolIds

The IDs of the IPAM pools you would like information on.

Value

A list with the following syntax:

list(
  NextToken = "string",
  IpamPools = list(
    list(
      OwnerId = "string",
      IpamPoolId = "string",
      SourceIpamPoolId = "string",
      IpamPoolArn = "string",
      IpamScopeArn = "string",
      IpamScopeType = "public"|"private",
      IpamArn = "string",
      IpamRegion = "string",
      Locale = "string",
      PoolDepth = 123,
      State = "create-in-progress"|"create-complete"|"create-failed"|"modify-in-progress"|"modify-complete"|"modify-failed"|"delete-in-progress"|"delete-complete"|"delete-failed"|"isolate-in-progress"|"isolate-complete"|"restore-in-progress",
      StateMessage = "string",
      Description = "string",
      AutoImport = TRUE|FALSE,
      PubliclyAdvertisable = TRUE|FALSE,
      AddressFamily = "ipv4"|"ipv6",
      AllocationMinNetmaskLength = 123,
      AllocationMaxNetmaskLength = 123,
      AllocationDefaultNetmaskLength = 123,
      AllocationResourceTags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      AwsService = "ec2",
      PublicIpSource = "amazon"|"byoip",
      SourceResource = list(
        ResourceId = "string",
        ResourceType = "vpc",
        ResourceRegion = "string",
        ResourceOwner = "string"
      )
    )
  )
)

Request syntax

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