AWS Organization Administration - Amazon Macie

AWS Organization Administration

The AWS Organization Administration resource provides access to the Amazon Macie configuration settings for an AWS organization. This includes the setting that determines whether Macie is enabled automatically for accounts that are added to an AWS organization. To use this resource, you must be the delegated Macie administrator for your AWS organization.

An AWS organization is a set of AWS accounts that are managed as a group by using the AWS Organizations service. AWS Organizations is an account management service that enables administrators to consolidate and centrally manage multiple AWS accounts as a single organization. To learn more about this service, see the AWS Organizations User Guide.

If you're the delegated Macie administrator for an AWS organization, you can use this resource to retrieve information about and update the Macie configuration settings for the organization.

URI

/admin/configuration

HTTP Methods

GET

Operation ID: DescribeOrganizationConfiguration

Retrieves the Amazon Macie configuration settings for an AWS organization.

Responses
Status Code Response Model Description
200 DescribeOrganizationConfigurationResponse

The request succeeded.

400 ValidationException

The request failed because it contains a syntax error.

402 ServiceQuotaExceededException

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

403 AccessDeniedException

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

404 ResourceNotFoundException

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

409 ConflictException

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

429 ThrottlingException

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

500 InternalServerException

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

PATCH

Operation ID: UpdateOrganizationConfiguration

Updates the Amazon Macie configuration settings for an AWS organization.

Responses
Status Code Response Model Description
200 Empty Schema

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

400 ValidationException

The request failed because it contains a syntax error.

402 ServiceQuotaExceededException

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

403 AccessDeniedException

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

404 ResourceNotFoundException

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

409 ConflictException

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

429 ThrottlingException

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

500 InternalServerException

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

Schemas

Request Bodies

Example PATCH

{ "autoEnable": boolean }

Response Bodies

Example DescribeOrganizationConfigurationResponse

{ "autoEnable": boolean, "maxAccountLimitReached": boolean }

Example Empty Schema

{ }

Example ValidationException

{ "message": "string" }

Example ServiceQuotaExceededException

{ "message": "string" }

Example AccessDeniedException

{ "message": "string" }

Example ResourceNotFoundException

{ "message": "string" }

Example ConflictException

{ "message": "string" }

Example ThrottlingException

{ "message": "string" }

Example InternalServerException

{ "message": "string" }

Properties

AccessDeniedException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ConflictException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

DescribeOrganizationConfigurationResponse

Provides information about the Amazon Macie configuration settings for an AWS organization.

Property Type Required Description
autoEnable

boolean

False

Specifies whether Amazon Macie is enabled automatically for accounts that are added to the AWS organization.

maxAccountLimitReached

boolean

False

Specifies whether the maximum number of Amazon Macie member accounts are part of the AWS organization.

Empty

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

InternalServerException

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

Property Type Required Description
message

string

False

The explanation of the error that occurred.

ResourceNotFoundException

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

Property Type Required Description
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.

Property Type Required Description
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.

Property Type Required Description
message

string

False

The explanation of the error that occurred.

UpdateOrganizationConfigurationRequest

Specifies whether Amazon Macie is enabled automatically for accounts that are added to an AWS organization.

Property Type Required Description
autoEnable

boolean

True

Specifies whether Amazon Macie is enabled automatically for each account, when the account is added to the AWS organization.

ValidationException

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

Property Type Required Description
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:

DescribeOrganizationConfiguration

UpdateOrganizationConfiguration