AWS Organizations - Macie Configuration - Amazon Macie

AWS Organizations - Macie Configuration

The Macie Configuration resource for AWS Organizations provides access to the 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 Amazon Macie 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 information about and update the Macie configuration settings for your organization. This includes the setting that determines whether Macie is enabled automatically for new accounts when the accounts are added to your organization in AWS Organizations. 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.

Responses
Status codeResponse modelDescription
200DescribeOrganizationConfigurationResponse

The request succeeded.

400ValidationException

The request failed because the input doesn't satisfy the constraints specified by the service.

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.

PATCH

Operation ID: UpdateOrganizationConfiguration

Updates the Amazon Macie configuration settings 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 the input doesn't satisfy the constraints specified by the service.

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

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

PropertyTypeRequiredDescription
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.

PropertyTypeRequiredDescription
message

string

False

The explanation of the error that occurred.

DescribeOrganizationConfigurationResponse

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

PropertyTypeRequiredDescription
autoEnable

boolean

False

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

maxAccountLimitReached

boolean

False

Specifies whether the maximum number of Amazon Macie member accounts are part of the 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.

PropertyTypeRequiredDescription
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.

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.

UpdateOrganizationConfigurationRequest

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

PropertyTypeRequiredDescription
autoEnable

boolean

True

Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in AWS Organizations.

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:

DescribeOrganizationConfiguration

UpdateOrganizationConfiguration