Amazon Detective
API Reference (API Version 2018-10-26)

ListMembers

Amazon Detective is currently in preview.

Retrieves the list of member accounts for a behavior graph. Does not return member accounts that were removed from the behavior graph.

Request Syntax

POST /graph/members/list HTTP/1.1 Content-type: application/json { "GraphArn": "string", "MaxResults": number, "NextToken": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GraphArn

The ARN of the behavior graph for which to retrieve the list of member accounts.

Type: String

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

Required: Yes

MaxResults

The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 200.

Required: No

NextToken

For requests to retrieve the next page of member account results, the pagination token that was returned with the previous page of results. The initial request does not include a pagination token.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "MemberDetails": [ { "AccountId": "string", "EmailAddress": "string", "GraphArn": "string", "InvitedTime": number, "MasterId": "string", "Status": "string", "UpdatedTime": number } ], "NextToken": "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.

MemberDetails

The list of member accounts in the behavior graph.

The results include member accounts that did not pass verification and member accounts that have not yet accepted the invitation to the behavior graph. The results do not include member accounts that were removed from the behavior graph.

Type: Array of MemberDetail objects

NextToken

If there are more member accounts remaining in the results, then this is the pagination token to use to request the next page of member accounts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

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

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The request refers to a nonexistent resource.

HTTP Status Code: 404

ValidationException

The request parameters are invalid.

HTTP Status Code: 400

Examples

Example

Sample Request

POST /graph/members/list HTTP/1.1 Host: api.detective.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 94 Authorization: AUTHPARAMS X-Amz-Date: 20200124T193018Z User-Agent: aws-cli/1.14.29 Python/2.7.9 Windows/8 botocore/1.8.33 { "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899" }

Example

Sample Response

HTTP/1.1 200 OK Content-Type: application/json Content-Length: 586 Date: Fri, 24 Jan 2020 23:07:46 GMT x-amzn-RequestId: 397d0549-0092-11e8-a0ee-a7f9aa6e7572 Connection: Keep-alive { "MemberDetails": [ { "AccountId": "444455556666", "EmailAddress": "mmajor@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "INVITED", "UpdatedTime": 1579826107000 }, { "AccountId": "123456789012", "EmailAddress": "jstiles@example.com", "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899", "InvitedTime": 1579826107000, "MasterId": "111122223333", "Status": "ENABLED", "UpdatedTime": 1579973711000 } ] }

See Also

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