ListMembers
Lists details about all member accounts for the current GuardDuty administrator account.
Request Syntax
GET /detector/detectorId/member?maxResults=MaxResults&nextToken=NextToken&onlyAssociated=OnlyAssociated HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The unique ID of the detector that is associated with the member.
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
- MaxResults
-
You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
Valid Range: Minimum value of 1. Maximum value of 50.
- NextToken
-
You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
- OnlyAssociated
-
Specifies whether to only return associated members or to return all members (including members who haven't been invited yet or have been disassociated). Member accounts must have been previously associated with the GuardDuty administrator account using
Create Members.
Request Body
The request does not have a request body.
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"
}
],
"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.
- members
-
A list of members.
Note
The values for
emailandinvitedAtare available only if the member accounts are added by invitation.Type: Array of Member objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- nextToken
-
The pagination parameter to be used on the next list operation to retrieve more items.
Type: String
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:
