GetMembers - Amazon Detective


Returns the membership details for specified member accounts for a behavior graph.

Request Syntax

POST /graph/members/get HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "GraphArn": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The list of AWS account identifiers for the member account for which to return member details. You can request details for up to 50 member accounts at a time.

You cannot use GetMembers to retrieve information about member accounts that were removed from the behavior graph.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]+$

Required: Yes


The ARN of the behavior graph for which to request the member details.

Type: String

Pattern: ^arn:aws[-\w]{0,10}?:detective:[-\w]{2,20}?:\d{12}?:graph:[abcdef\d]{32}?$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MemberDetails": [ { "AccountId": "string", "AdministratorId": "string", "DatasourcePackageIngestStates": { "string" : "string" }, "DisabledReason": "string", "EmailAddress": "string", "GraphArn": "string", "InvitationType": "string", "InvitedTime": "string", "MasterId": "string", "PercentOfGraphUtilization": number, "PercentOfGraphUtilizationUpdatedTime": "string", "Status": "string", "UpdatedTime": "string", "VolumeUsageByDatasourcePackage": { "string" : { "VolumeUsageInBytes": number, "VolumeUsageUpdateTime": "string" } }, "VolumeUsageInBytes": number, "VolumeUsageUpdatedTime": "string" } ], "UnprocessedAccounts": [ { "AccountId": "string", "Reason": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The member account details that Detective is returning in response to the request.

Type: Array of MemberDetail objects


The requested member accounts for which Detective was unable to return member details.

For each account, provides the reason why the request could not be processed.

Type: Array of UnprocessedAccount objects


For information about the errors that are common to all actions, see Common Errors.


The request issuer does not have permission to access this resource or perform this operation.

HTTP Status Code: 403


The request was valid but failed because of a problem with the service.

HTTP Status Code: 500


The request refers to a nonexistent resource.

HTTP Status Code: 404


The request parameters are invalid.

HTTP Status Code: 400



This example illustrates one usage of GetMembers.

Sample Request

POST /graph/members/get HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 128 Authorization: AUTHPARAMS X-Amz-Date: 20200127T193018Z User-Agent: aws-cli/1.14.29 Python/2.7.9 Windows/8 botocore/1.8.33 { "AccountIds": [ "444455556666" ], "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" }


This example illustrates one usage of GetMembers.

Sample Response

HTTP/1.1 200 OK Content-Type: application/json Content-Length: 332 Date: Mon, 27 Jan 2020 23:07:46 GMT x-amzn-RequestId: 397d0549-0092-11e8-a0ee-a7f9aa6e7572 Connection: Keep-alive { "MemberDetails": [ { "AccountId": "444455556666", "AdministratorId": "111122223333", "EmailAddress": "", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899", "InvitedTime": "2020-01-24T12:35:0.1587Z", "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": "2020-01-24T12:35:0.1587Z" } ], "UnprocessedAccounts": [ ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: