Skip to content

Get Ipam Policy Organization Targets

ec2_get_ipam_policy_organization_targets R Documentation

Gets the Amazon Web Services Organizations targets for an IPAM policy

Description

Gets the Amazon Web Services Organizations targets for an IPAM policy.

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.

A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.

Usage

ec2_get_ipam_policy_organization_targets(DryRun, MaxResults, NextToken,
  IpamPolicyId, Filters)

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.

MaxResults

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

NextToken

The token for the next page of results.

IpamPolicyId

[required] The ID of the IPAM policy for which to get Amazon Web Services Organizations targets.

Filters

One or more filters for the Amazon Web Services Organizations targets.

Value

A list with the following syntax:

list(
  OrganizationTargets = list(
    list(
      OrganizationTargetId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

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