- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
EnableOrganizationAdminAccountCommand
Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { Macie2Client, EnableOrganizationAdminAccountCommand } from "@aws-sdk/client-macie2"; // ES Modules import
// const { Macie2Client, EnableOrganizationAdminAccountCommand } = require("@aws-sdk/client-macie2"); // CommonJS import
const client = new Macie2Client(config);
const input = { // EnableOrganizationAdminAccountRequest
adminAccountId: "STRING_VALUE", // required
clientToken: "STRING_VALUE",
};
const command = new EnableOrganizationAdminAccountCommand(input);
const response = await client.send(command);
// {};
EnableOrganizationAdminAccountCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
adminAccountId Required | string | undefined | The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization. |
clientToken | string | undefined | A unique, case-sensitive token that you provide to ensure the idempotency of the request. |
EnableOrganizationAdminAccountCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | Provides information about an error that occurred due to insufficient access to a specified resource. |
ConflictException | client | Provides information about an error that occurred due to a versioning conflict for a specified resource. |
InternalServerException | server | Provides information about an error that occurred due to an unknown internal server error, exception, or failure. |
ResourceNotFoundException | client | Provides information about an error that occurred because a specified resource wasn't found. |
ServiceQuotaExceededException | client | Provides information about an error that occurred due to one or more service quotas for an account. |
ThrottlingException | client | Provides information about an error that occurred because too many requests were sent during a certain amount of time. |
ValidationException | client | Provides information about an error that occurred due to a syntax error in a request. |
Macie2ServiceException | Base exception class for all service exceptions from Macie2 service. |