Describe Ipams

ec2_describe_ipams

R Documentation

Get information about your IPAM pools

Description

Get information about your IPAM pools.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

Usage

ec2_describe_ipams(DryRun, Filters, MaxResults, NextToken, IpamIds)

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 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.
IpamIds	The IDs of the IPAMs you want information on.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Ipams = list(
    list(
      OwnerId = "string",
      IpamId = "string",
      IpamArn = "string",
      IpamRegion = "string",
      PublicDefaultScopeId = "string",
      PrivateDefaultScopeId = "string",
      ScopeCount = 123,
      Description = "string",
      OperatingRegions = list(
        list(
          RegionName = "string"
        )
      ),
      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",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      DefaultResourceDiscoveryId = "string",
      DefaultResourceDiscoveryAssociationId = "string",
      ResourceDiscoveryAssociationCount = 123,
      StateMessage = "string",
      Tier = "free"|"advanced",
      EnablePrivateGua = TRUE|FALSE,
      MeteredAccount = "ipam-owner"|"resource-owner"
    )
  )
)

Request syntax

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