Member Account Status - Amazon Macie

Member Account Status

The Member Account Status resource provides access to the status of an Amazon Macie member account in your Macie organization. If you're a user of a Macie master account, you can use this resource to suspend (pause) a member account. If you suspend an account, Macie stops performing all activities for the account. However, it retains the session identifier, settings, and resources for the account.

As a user of a Macie master account, you can also use this resource to re-enable a member account that you previously suspended. When you re-enable an account, Macie resumes all activities for the account.

URI

/macie/members/id

HTTP Methods

PATCH

Operation ID: UpdateMemberSession

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

Path Parameters
Name Type Required Description
id String True

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

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

{ "status": enum }

Response Bodies

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.

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.

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.

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.

UpdateMemberSessionRequest

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

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

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:

UpdateMemberSession