GetEnabledIpamPolicy
Gets the enabled IPAM policy.
An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS 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 AWS 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 AWS account or an entity within AWS Organizations.
Request Parameters
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
Response Elements
The following elements are returned by the service.
- ipamPolicyEnabled
-
Indicates whether the IPAM policy is enabled.
Type: Boolean
- ipamPolicyId
-
The ID of the enabled IPAM policy.
Type: String
- managedBy
-
The entity that manages the IPAM policy.
Type: String
Valid Values:
account | delegated-administrator-for-ipam - 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 AWS SDKs, see the following:
