GetIpamPolicyOrganizationTargets
Gets the Amazon 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 resources. Each rule maps an Amazon 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 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 account or an entity within Amazon Organizations.
A target can be an individual Amazon account or an entity within an Amazon Organization to which an IPAM policy can be applied.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- Filter.N
-
One or more filters for the Amazon Organizations targets.
Type: Array of Filter objects
Required: No
- IpamPolicyId
-
The ID of the IPAM policy for which to get Amazon Organizations targets.
Type: String
Required: Yes
- MaxResults
-
The maximum number of results to return in a single call.
Type: Integer
Valid Range: Minimum value of 5. Maximum value of 1000.
Required: No
- NextToken
-
The token for the next page of results.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- nextToken
-
The token to use to retrieve the next page of results.
Type: String
- organizationTargetSet
-
The Amazon Organizations targets for an IPAM policy.
Type: Array of IpamPolicyOrganizationTarget objects
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: