DisableIpamPolicy
Disables 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.
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
- IpamPolicyId
-
The ID of the IPAM policy to disable.
Type: String
Required: Yes
- OrganizationTargetId
-
The ID of the Amazon Organizations target for which to disable the IPAM policy. This parameter is required only when IPAM is integrated with Amazon Organizations. When IPAM is not integrated with Amazon Organizations, omit this parameter and the policy will be disabled for the current account.
A target can be an individual Amazon account or an entity within an Amazon Organization to which an IPAM policy can be applied.
Type: String
Required: No
Response Elements
The following elements are returned by the service.
- requestId
-
The ID of the request.
Type: String
- return
-
Returns true if the IPAM policy was successfully disabled.
Type: Boolean
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: