List Members

guardduty_list_members

R Documentation

Lists details about all member accounts for the current GuardDuty administrator account¶

Description¶

Lists details about all member accounts for the current GuardDuty administrator account.

Usage¶

guardduty_list_members(DetectorId, MaxResults, NextToken,
  OnlyAssociated)

Arguments¶

DetectorId

[required] The unique ID of the detector that is associated with the member.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the list_detectors API.

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.

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⁠ .

Value¶

A list with the following syntax:

list(
  Members = list(
    list(
      AccountId = "string",
      DetectorId = "string",
      MasterId = "string",
      Email = "string",
      RelationshipStatus = "string",
      InvitedAt = "string",
      UpdatedAt = "string",
      AdministratorId = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_members(
  DetectorId = "string",
  MaxResults = 123,
  NextToken = "string",
  OnlyAssociated = "string"
)