AWS Organizations - Macie Administrator - Amazon Macie

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 Amazon Macie 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

GET

Operation ID: ListOrganizationAdminAccounts

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

Query parameters
NameTypeRequiredDescription
nextTokenStringFalse

The nextToken string that specifies which page of results to return in a paginated response.

maxResultsStringFalse

The maximum number of items to include in each page of a paginated response.

Responses
Status codeResponse modelDescription
200ListOrganizationAdminAccountsResponse

The request succeeded.

400ValidationException

The request failed because it contains a syntax error.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

409ConflictException

The request failed because it conflicts with the current state of the specified resource.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

POST

Operation ID: EnableOrganizationAdminAccount

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

Responses
Status codeResponse modelDescription
200Empty Schema

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

400ValidationException

The request failed because it contains a syntax error.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

409ConflictException

The request failed because it conflicts with the current state of the specified resource.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

DELETE

Operation ID: DisableOrganizationAdminAccount

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

Query parameters
NameTypeRequiredDescription
adminAccountIdStringTrue

The AWS account ID of the delegated Amazon Macie administrator account.

Responses
Status codeResponse modelDescription
200Empty Schema

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

400ValidationException

The request failed because it contains a syntax error.

402ServiceQuotaExceededException

The request failed because fulfilling the request would exceed one or more service quotas for your account.

403AccessDeniedException

The request was denied because you don't have sufficient access to the specified resource.

404ResourceNotFoundException

The request failed because the specified resource wasn't found.

409ConflictException

The request failed because it conflicts with the current state of the specified resource.

429ThrottlingException

The request failed because you sent too many requests during a certain amount of time.

500InternalServerException

The request failed due to an unknown internal server error, exception, or failure.

Schemas

Request bodies

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

Response bodies

{ "nextToken": "string", "adminAccounts": [ { "accountId": "string", "status": enum } ] }
{ }
{ "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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

AdminAccount

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

PropertyTypeRequiredDescription
accountId

string

False

The AWS account ID for the account.

status

AdminStatus

False

The current status of the account as the delegated Amazon Macie administrator account for the organization.

AdminStatus

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

  • ENABLED

  • DISABLING_IN_PROGRESS

ConflictException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

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.

PropertyTypeRequiredDescription
adminAccountId

string

True

The AWS account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

clientToken

string

False

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

InternalServerException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ListOrganizationAdminAccountsResponse

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

PropertyTypeRequiredDescription
adminAccounts

Array of type AdminAccount

False

An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

nextToken

string

False

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

ResourceNotFoundException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ServiceQuotaExceededException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ThrottlingException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

ValidationException

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

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

See also

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

ListOrganizationAdminAccounts

EnableOrganizationAdminAccount

DisableOrganizationAdminAccount