get_enabled_ipam_policy¶
Operation¶
async
¶
get_enabled_ipam_policy(input: GetEnabledIpamPolicyInput, plugins: list[Plugin] | None = None) -> GetEnabledIpamPolicyOutput
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.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetEnabledIpamPolicyInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetEnabledIpamPolicyOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetEnabledIpamPolicyInput structure.
Attributes¶
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for GetEnabledIpamPolicyOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
ipam_policy_enabled: bool | None = ...
Indicates whether the IPAM policy is enabled.
class-attribute
instance-attribute
¶
ipam_policy_id: str | None = ...
The ID of the enabled IPAM policy.
class-attribute
instance-attribute
¶
managed_by: str | None = ...
The entity that manages the IPAM policy.
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.