Request Parameters Response Elements Errors See Also

GetIpamPolicyAllocationRules

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 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.

Allocation rules are optional configurations within an IPAM policy that map AWS resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses.

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 is UnauthorizedOperation.

Type: Boolean

Required: No

Filter.N

One or more filters for the allocation rules.

Type: Array of Filter objects

Required: No

IpamPolicyId

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

Type: String

Required: Yes

Locale

The locale for which to get the allocation rules.

Type: String

Required: No

MaxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 1000.

Required: No

NextToken

The token for the next page of results.

Type: String

Required: No

ResourceType

The resource type for which to get the allocation rules.

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

Elastic IP addresses

Type: String

Valid Values: alb | eip | rds | rnat

Required: No

Response Elements

The following elements are returned by the service.

ipamPolicyDocumentSet

The IPAM policy documents containing the allocation rules.

Type: Array of IpamPolicyDocument objects

nextToken

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

Type: String

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.