AWS Organizations - Macie Administrator

The Macie Administrator resource for AWS Organizations provides settings for designating the delegated Amazon Macie administrator account for an organization in AWS Organizations. AWS Organizations is a global account management service that enables AWS administrators to consolidate and centrally manage multiple AWS accounts. For more information about this service, see the AWS Organizations User Guide. For information about integrating Macie with AWS Organizations, see Managing multiple accounts with AWS Organizations in the Amazon Macie User Guide.

If you're a user of the AWS Organizations management account for an organization, you can use this resource to designate the delegated Macie administrator account for your organization. You can also use this resource to retrieve information about and change that designation. Note that an organization can have only one delegated Macie administrator account at a time.

To use this resource, you must be a user of the AWS Organizations management account for your organization.

URI

/admin

HTTP methods

DELETE

Operation ID: DisableOrganizationAdminAccount

Disables an account as the delegated Amazon Macie administrator account for an organization in AWS Organizations.

GET

Operation ID: ListOrganizationAdminAccounts

Retrieves information about the delegated Amazon Macie administrator account for an organization in AWS Organizations.

POST

Operation ID: EnableOrganizationAdminAccount

Designates an account as the delegated Amazon Macie administrator account for an organization in AWS Organizations.

Schemas

Request bodies

{
  "adminAccountId": "string",
  "clientToken": "string"
}

{
  "adminAccountId": "string",
  "clientToken": "string"
}

Response bodies

{
}

{
}

{
  "adminAccounts": [
    {
      "accountId": "string",
      "status": enum
    }
  ],
  "nextToken": "string"
}

{
  "adminAccounts": [
    {
      "accountId": "string",
      "status": enum
    }
  ],
  "nextToken": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

Properties

AccessDeniedException

Provides information about an error that occurred due to insufficient access to a specified resource.

AdminAccount

Provides information about the delegated Amazon Macie administrator account for an organization in AWS Organizations.

AdminStatus

The current status of an account as the delegated Amazon Macie administrator account for an organization in AWS Organizations. Possible values are:

ConflictException

Provides information about an error that occurred due to a versioning conflict for a specified resource.

Empty

The request succeeded and there isn't any content to include in the body of the response (No Content).

EnableOrganizationAdminAccountRequest

Specifies an account to designate as the delegated Amazon Macie administrator account for an organization in AWS Organizations. To submit this request, you must be a user of the AWS Organizations management account.

InternalServerException

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ListOrganizationAdminAccountsResponse

Provides information about the delegated Amazon Macie administrator accounts for an organization in AWS Organizations.

ResourceNotFoundException

Provides information about an error that occurred because a specified resource wasn't found.

ServiceQuotaExceededException

Provides information about an error that occurred due to one or more service quotas for an account.

ThrottlingException

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException

Provides information about an error that occurred due to a syntax error in a request.

See also

For more information about using this API in one of the language-specific AWS SDKs and references, see the following:

DisableOrganizationAdminAccount

ListOrganizationAdminAccounts

EnableOrganizationAdminAccount