EC2 / Client / get_enabled_ipam_policy

get_enabled_ipam_policy¶

EC2.Client.get_enabled_ipam_policy(**kwargs)¶

Gets the enabled 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.

Request Syntax

response = client.get_enabled_ipam_policy(
    DryRun=True|False
)

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.

Return type:

dict

Returns:

Response Syntax

{
    'IpamPolicyEnabled': True|False,
    'IpamPolicyId': 'string',
    'ManagedBy': 'account'|'delegated-administrator-for-ipam'
}

Response Structure

(dict) –
- IpamPolicyEnabled (boolean) –
  
  Indicates whether the IPAM policy is enabled.
- IpamPolicyId (string) –
  
  The ID of the enabled IPAM policy.
- ManagedBy (string) –
  
  The entity that manages the IPAM policy.