Skip to content

Describes one or more IPAM policies

Description

Describes one or more IPAM policies.

An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to Amazon Web Services resources. Each rule maps an Amazon Web Services service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple Amazon Web Services Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual Amazon Web Services account or an entity within Amazon Web Services Organizations.

Usage

ec2_describe_ipam_policies(DryRun, Filters, MaxResults, NextToken,
  IpamPolicyIds)

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 IPAM policy description.

  • MaxResults

    The maximum number of results to return in a single call.

  • NextToken

    The token for the next page of results.

  • IpamPolicyIds

    The IDs of the IPAM policies to describe.

Value

A list with the following syntax:

list(
  NextToken = "string",
  IpamPolicies = list(
    list(
      OwnerId = "string",
      IpamPolicyId = "string",
      IpamPolicyArn = "string",
      IpamPolicyRegion = "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",
      StateMessage = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      IpamId = "string"
    )
  )
)

Request syntax

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