Skip to content

EC2  >  Operations  >  enable_ipam_organization_admin_account

enable_ipam_organization_admin_account

Operation

enable_ipam_organization_admin_account async

enable_ipam_organization_admin_account(request: EnableIpamOrganizationAdminAccountInput | EnableIpamOrganizationAdminAccountInputDict, /, *, plugins: list[Plugin] | None = None) -> EnableIpamOrganizationAdminAccountOutput
enable_ipam_organization_admin_account(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableIpamOrganizationAdminAccountInputDict]) -> EnableIpamOrganizationAdminAccountOutput

Enable an Organizations member account as the IPAM admin account. You cannot select the Organizations management account as the IPAM admin account. For more information, see Enable integration with Organizations 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
EnableIpamOrganizationAdminAccountOutput

An instance of EnableIpamOrganizationAdminAccountOutput.

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

EnableIpamOrganizationAdminAccountInput dataclass

Bases: _SerdeShape

Dataclass for EnableIpamOrganizationAdminAccountInput structure.

Attributes
delegated_admin_account_id class-attribute instance-attribute
delegated_admin_account_id: str | None = ...

The Organizations member account ID that you want to enable as the IPAM account.

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.

Dictionaries

EnableIpamOrganizationAdminAccountInputDict

Bases: TypedDict

Dictionary form of EnableIpamOrganizationAdminAccountInput.

Attributes
delegated_admin_account_id instance-attribute
delegated_admin_account_id: Required[str]

The Organizations member account ID that you want to enable as the IPAM account.

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.

Output

EnableIpamOrganizationAdminAccountOutput dataclass

Bases: _SerdeShape

Dataclass for EnableIpamOrganizationAdminAccountOutput structure.

Attributes

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.

success class-attribute instance-attribute
success: bool | None = ...

The result of enabling the IPAM account.