enable_ipam_policy ¶

def enable_ipam_policy(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    ipam_policy_id: Optional["capo_ec2.types.ipam_policy_id.IpamPolicyId"] = None,
    organization_target_id: Optional["capo_ec2.types.string.String"] = None,
) -> "capo_ec2.types.enable_ipam_policy_result.EnableIpamPolicyResult":
    """<p>Enables an IPAM policy.</p> <p>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.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/vpc/latest/ipam/define-public-ipv4-allocation-strategy-with-ipam-policies.html">Define public IPv4 allocation strategy with IPAM policies</a> in the <i>Amazon VPC IPAM User Guide</i>.</p>

    Args:
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        ipam_policy_id: <p>The ID of the IPAM policy to enable.</p>
        organization_target_id: <p>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.</p> <p>The ID of the Amazon Web Services Organizations target for which to enable the IPAM policy. This parameter is required only when IPAM is integrated with Amazon Web Services Organizations. When IPAM is not integrated with Amazon Web Services Organizations, omit this parameter and the policy will apply to the current account.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.enable_ipam_policy_request.EnableIpamPolicyRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.enable_ipam_policy_result.EnableIpamPolicyResult"
    ]:
        import capo_ec2._operations.amazon_ec2.enable_ipam_policy

        output, http_response = (
            capo_ec2._operations.amazon_ec2.enable_ipam_policy.enable_ipam_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("EnableIpamPolicy")
    )
    input_: capo_ec2.types.enable_ipam_policy_request.EnableIpamPolicyRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if ipam_policy_id is not None:
        input_["ipam_policy_id"] = ipam_policy_id
    if organization_target_id is not None:
        input_["organization_target_id"] = organization_target_id

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output