GetMembers
Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.
Request Syntax
POST /detector/detectorId/member/get HTTP/1.1
Content-type: application/json
{
"accountIds": [ "string" ]
}URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The unique ID of the detector of the GuardDuty account whose members you want to retrieve.
To find the
detectorIdin the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- accountIds
-
A list of account IDs of the GuardDuty member accounts that you want to describe.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Fixed length of 12.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"members": [
{
"accountId": "string",
"administratorId": "string",
"detectorId": "string",
"email": "string",
"invitedAt": "string",
"masterId": "string",
"relationshipStatus": "string",
"updatedAt": "string"
}
],
"unprocessedAccounts": [
{
"accountId": "string",
"result": "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.
- members
-
A list of members.
Type: Array of Member objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- unprocessedAccounts
-
A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.
Type: Array of UnprocessedAccount objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
