EC2 / Client / get_ipam_policy_allocation_rules

get_ipam_policy_allocation_rules

EC2.Client.get_ipam_policy_allocation_rules(**kwargs)

Gets the allocation rules 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 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.

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.

See also: AWS API Documentation

Request Syntax

response = client.get_ipam_policy_allocation_rules(
    DryRun=True|False,
    IpamPolicyId='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Locale='string',
    ResourceType='alb'|'eip'|'rds'|'rnat',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • DryRun (boolean) – 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 is UnauthorizedOperation.

  • IpamPolicyId (string) –

    [REQUIRED]

    The ID of the IPAM policy for which to get allocation rules.

  • Filters (list) –

    One or more filters for the allocation rules.

    • (dict) –

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

      If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

      For more information, see List and filter using the CLI and API in the Amazon EC2 User Guide.

      • Name (string) –

        The name of the filter. Filter names are case-sensitive.

      • Values (list) –

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

        • (string) –

  • Locale (string) – The locale for which to get the allocation rules.

  • ResourceType (string) –

    The resource type for which to get the allocation rules.

    The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

    • Elastic IP addresses

  • MaxResults (integer) – The maximum number of results to return in a single call.

  • NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPolicyDocuments': [
        {
            'IpamPolicyId': 'string',
            'Locale': 'string',
            'ResourceType': 'alb'|'eip'|'rds'|'rnat',
            'AllocationRules': [
                {
                    'SourceIpamPoolId': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • IpamPolicyDocuments (list) –

      The IPAM policy documents containing the allocation rules.

      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.

      • (dict) –

        Information about an IPAM policy.

        • IpamPolicyId (string) –

          The ID of the IPAM policy.

        • Locale (string) –

          The locale of the IPAM policy document.

        • ResourceType (string) –

          The resource type of the IPAM policy document.

          The Amazon Web Services service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include:

          • Elastic IP addresses

        • AllocationRules (list) –

          The allocation rules in the IPAM policy document.

          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.

          • (dict) –

            Information about an IPAM policy allocation rule.

            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.

            • SourceIpamPoolId (string) –

              The ID of the source IPAM pool for the allocation rule.

              An IPAM pool is a collection of IP addresses in IPAM that can be allocated to Amazon Web Services resources.

    • NextToken (string) –

      The token to use to retrieve the next page of results.