Member Status - Amazon Macie

Member Status

The Member Status resource provides access to the status of Amazon Macie for a member account in an AWS Organizations organization. If you're the delegated Macie administrator for an organization in AWS Organizations, you can use this resource to suspend (pause) or re-enable Macie for a member account in your organization.

If you suspend Macie for an account, Macie stops performing all activities for the account and Macie cancels all classification jobs for the account. However, the service retains the session identifier, settings, and resources for the account. If you subsequently re-enable Macie for the account, Macie resumes all activities for the account. For more information, see Suspending or disabling Amazon Macie in the Amazon Macie User Guide.

URI

/macie/members/id

HTTP methods

PATCH

Operation ID: UpdateMemberSession

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

Path parameters
NameTypeRequiredDescription
idStringTrue

The unique identifier for the Amazon Macie resource or account that the request applies to.

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

{ "status": enum }

Response bodies

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

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.

MacieStatus

The status of an Amazon Macie account. Valid values are:

  • PAUSED

  • ENABLED

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.

UpdateMemberSessionRequest

Suspends (pauses) or re-enables Amazon Macie for a member account.

PropertyTypeRequiredDescription
status

MacieStatus

True

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

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:

UpdateMemberSession