Member
The Member resource provides information about an individual account that's currently associated with your Amazon Macie account, typically a Macie administrator account. This information includes details such as the AWS account ID for the account and the current status of the relationship between your accounts. If you sent a Macie membership invitation to an account, this resource also indicates when you sent that invitation and the email address that you sent it to. For information about the relationship between administrator and member accounts, see Managing multiple accounts in the Amazon Macie User Guide.
You can use the Member resource to retrieve information about an account that's associated with your Macie account. You can also use this resource to delete an existing association between your Macie account and another account. To use this resource, you have to specify the AWS account ID for the account that your request applies to. To find this ID, you can use the Members resource.
URI
/members/
id
HTTP methods
DELETE
Operation ID: DeleteMember
Deletes the association between an Amazon Macie administrator account and an 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. The association was deleted 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. |
GET
Operation ID: GetMember
Retrieves information about an account that's associated with an Amazon Macie administrator 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 | GetMemberResponse | The request succeeded. |
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
Response bodies
{ }
{ "accountId": "string", "administratorAccountId": "string", "arn": "string", "email": "string", "invitedAt": "string", "masterAccountId": "string", "relationshipStatus": enum, "tags": { }, "updatedAt": "string" }
{ "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).
GetMemberResponse
Provides information about an account that's associated with an Amazon Macie administrator account.
Property | Type | Required | Description |
---|---|---|---|
accountId | string | False | The AWS account ID for the account. |
administratorAccountId | string | False | The AWS account ID for the administrator account. |
arn | string | False | The Amazon Resource Name (ARN) of the account. |
email | string | False | The email address for the account. This value is null if the account is associated with the administrator account through AWS Organizations. |
invitedAt | string Format: date-time | False | The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie membership invitation hasn't been sent to the account. |
masterAccountId | string | False | (Deprecated) The AWS account ID for the administrator account. This
property has been replaced by the |
relationshipStatus | False | The current status of the relationship between the account and the administrator account. | |
tags | False | A map of key-value pairs that specifies which tags (keys and values) are associated with the account in Amazon Macie. | |
updatedAt | string Format: date-time | False | The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account. |
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. |
RelationshipStatus
The current status of the relationship between an account and an associated Amazon Macie administrator account. Possible values are:
Enabled
Paused
Invited
Created
Removed
Resigned
EmailVerificationInProgress
EmailVerificationFailed
RegionDisabled
AccountSuspended
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. |
TagMap
A string-to-string map of key-value pairs that specifies the tags (keys and values) for an Amazon Macie resource.
Property | Type | Required | Description |
---|---|---|---|
| string | False |
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. |
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: