Member Status
The Member Status resource provides access to the status of Amazon Macie for a member account in an organization. If you're the delegated Macie administrator for an organization in AWS Organizations, you can use this resource to manage the status of Macie for a member account in your organization. For more information, see Managing multiple accounts with AWS Organizations in the Amazon Macie User Guide.
If you suspend Macie for an account, Macie stops performing all activities and cancels all classification jobs for that account. However, the service retains the session identifier, settings, and resources for the account. For example, the account's findings remain intact and aren't affected for up to 90 days. If you later re-enable Macie for the account, Macie resumes all activities for the account. For more information, see Managing member accounts for an organization 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.
Name | Type | Required | Description |
---|---|---|---|
id | String | True | The unique identifier for the Amazon Macie resource that the request applies to. |
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 the input doesn't satisfy the constraints specified by the service. |
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
{ "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.
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 Amazon Macie for a member account.
Property | Type | Required | Description |
---|---|---|---|
status | True | Specifies the new status for the account. Valid values are: |
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: