EnableIpamOrganizationAdminAccountCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { EC2Client, EnableIpamOrganizationAdminAccountCommand } from "@aws-sdk/client-ec2"; // ES Modules import
// const { EC2Client, EnableIpamOrganizationAdminAccountCommand } = require("@aws-sdk/client-ec2"); // CommonJS import
const client = new EC2Client(config);
const input = { // EnableIpamOrganizationAdminAccountRequest
  DryRun: true || false,
  DelegatedAdminAccountId: "STRING_VALUE", // required
};
const command = new EnableIpamOrganizationAdminAccountCommand(input);
const response = await client.send(command);
// { // EnableIpamOrganizationAdminAccountResult
//   Success: true || false,
// };

EnableIpamOrganizationAdminAccountCommand Input

See EnableIpamOrganizationAdminAccountCommandInput for more details

Parameter
Type
Description
DelegatedAdminAccountId
Required
string | undefined

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

DryRun
boolean | undefined

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.

EnableIpamOrganizationAdminAccountCommand Output

See EnableIpamOrganizationAdminAccountCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Success
boolean | undefined

The result of enabling the IPAM account.

Throws

Name
Fault
Details
EC2ServiceException
Base exception class for all service exceptions from EC2 service.