AWS Organizations - Macie Configuration

The Macie Configuration resource for AWS Organizations provides access to certain Amazon Macie configuration settings 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 the delegated Macie administrator for an organization in AWS Organizations, you can use this resource to retrieve or change the setting that determines whether Macie is enabled automatically for accounts that are added to your organization in AWS Organizations. To retrieve or change the setting that determines whether automated sensitive data discovery is also enabled automatically for new accounts, use the Configuration resource for automated sensitive data discovery.

To use this resource, you must be the delegated Macie administrator for an organization in AWS Organizations.

URI

/admin/configuration

HTTP methods

GET

Operation ID: DescribeOrganizationConfiguration

Retrieves the Amazon Macie configuration settings for an organization in AWS Organizations.

PATCH

Operation ID: UpdateOrganizationConfiguration

Updates the Amazon Macie configuration settings for an organization in AWS Organizations.

Schemas

Request bodies

{
  "autoEnable": boolean
}

Response bodies

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

{
}

{
  "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.

ConflictException

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

DescribeOrganizationConfigurationResponse

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

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.

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.

UpdateOrganizationConfigurationRequest

Specifies whether to enable Amazon Macie automatically for accounts that are added to an organization in AWS Organizations, when the accounts are added to the organization.

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:

DescribeOrganizationConfiguration

UpdateOrganizationConfiguration