Skip to content

EC2  >  Operations  >  enable_ipam_policy

enable_ipam_policy

Operation

enable_ipam_policy async

enable_ipam_policy(request: EnableIpamPolicyInput | EnableIpamPolicyInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableIpamPolicyOutput
enable_ipam_policy(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableIpamPolicyInputDict]) -> EnableIpamPolicyOutput

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

For more information, see Define public IPv4 allocation strategy with IPAM policies in the Amazon VPC IPAM User Guide.

Parameters:

Name Type Description Default
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
EnableIpamPolicyOutput

An instance of EnableIpamPolicyOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

EnableIpamPolicyInput dataclass

Bases: _SerdeShape

Dataclass for EnableIpamPolicyInput structure.

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

ipam_policy_id class-attribute instance-attribute
ipam_policy_id: str | None = ...

The ID of the IPAM policy to enable.

organization_target_id class-attribute instance-attribute
organization_target_id: str | None = ...

A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.

The ID of the Amazon Web Services Organizations target for which to enable the IPAM policy. This parameter is required only when IPAM is integrated with Amazon Web Services Organizations. When IPAM is not integrated with Amazon Web Services Organizations, omit this parameter and the policy will apply to the current account.

Dictionaries

EnableIpamPolicyInputDict

Bases: TypedDict

Dictionary form of EnableIpamPolicyInput.

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

ipam_policy_id instance-attribute
ipam_policy_id: Required[str]

The ID of the IPAM policy to enable.

organization_target_id instance-attribute
organization_target_id: str | None

A target can be an individual Amazon Web Services account or an entity within an Amazon Web Services Organization to which an IPAM policy can be applied.

The ID of the Amazon Web Services Organizations target for which to enable the IPAM policy. This parameter is required only when IPAM is integrated with Amazon Web Services Organizations. When IPAM is not integrated with Amazon Web Services Organizations, omit this parameter and the policy will apply to the current account.

Output

EnableIpamPolicyOutput dataclass

Bases: _SerdeShape

Dataclass for EnableIpamPolicyOutput structure.

Attributes

ipam_policy_id class-attribute instance-attribute
ipam_policy_id: str | None = ...

The ID of the IPAM policy that was enabled.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.