Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

GetMembers

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.

AccountIds

The list of AWS account identifiers for the member account for which to return member details.

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

GraphArn

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",
         "DisabledReason": "string",
         "EmailAddress": "string",
         "GraphArn": "string",
         "InvitedTime": number,
         "MasterId": "string",
         "PercentOfGraphUtilization": number,
         "PercentOfGraphUtilizationUpdatedTime": number,
         "Status": "string",
         "UpdatedTime": number
      }
   ],
   "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.

MemberDetails

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

Type: Array of MemberDetail objects

UnprocessedAccounts

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

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

This example illustrates one usage of GetMembers.

Sample Request


POST /graph/members/get HTTP/1.1
Host: api.detective.us-west-2.amazonaws.com
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"
}

Example

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",
  "EmailAddress": "mmajor@example.com",
  "GraphArn": "arn:aws:detective:us-east-1:111122223333:graph:027c7c4610ea4aacaf0b883093cab899",
  "InvitedTime": 1579826107000,
  "MasterId": "111122223333",
  "Status": "INVITED",
  "UpdatedTime": 1579826107000
 }
 ],
 "UnprocessedAccounts": [ ]
}