get_ipam_policy_allocation_rules ¶

def get_ipam_policy_allocation_rules(
    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,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    locale: Optional["capo_ec2.types.string.String"] = None,
    resource_type: Optional[
        "capo_ec2.types.ipam_policy_resource_type.IpamPolicyResourceType"
    ] = None,
    max_results: Optional["capo_ec2.types.ipam_max_results.IpamMaxResults"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.get_ipam_policy_allocation_rules_result.GetIpamPolicyAllocationRulesResult":
    """<p>Gets the allocation rules for 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>Allocation rules are optional configurations within an IPAM policy that map Amazon Web Services resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.</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 for which to get allocation rules.</p>
        filters: <p>One or more filters for the allocation rules.</p>
        locale: <p>The locale for which to get the allocation rules.</p>
        resource_type: <p>The resource type for which to get the allocation rules.</p> <p>The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:</p> <ul> <li> <p>Elastic IP addresses</p> </li> </ul>
        max_results: <p>The maximum number of results to return in a single call.</p>
        next_token: <p>The token for the next page of results.</p>

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

    def _handler(
        req: "OperationRequest[capo_ec2.types.get_ipam_policy_allocation_rules_request.GetIpamPolicyAllocationRulesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.get_ipam_policy_allocation_rules_result.GetIpamPolicyAllocationRulesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.get_ipam_policy_allocation_rules

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIpamPolicyAllocationRules")
    )
    input_: capo_ec2.types.get_ipam_policy_allocation_rules_request.GetIpamPolicyAllocationRulesRequest = {}
    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 filters is not None:
        input_["filters"] = filters
    if locale is not None:
        input_["locale"] = locale
    if resource_type is not None:
        input_["resource_type"] = resource_type
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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