Guardduty  >  Operations  >  list_members

list_members

Operation

list_members async

list_members(input: ListMembersInput, plugins: list[Plugin] | None = None) -> ListMembersOutput

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

Parameters:

Name	Type	Description	Default
input	ListMembersInput	An instance of ListMembersInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
ListMembersOutput	An instance of ListMembersOutput.

Input

ListMembersInput dataclass

Dataclass for ListMembersInput structure.

Attributes

detector_id class-attribute instance-attribute

detector_id: str | None = None

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 ListDetectors API.

max_results class-attribute instance-attribute

max_results: int | None = None

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.

next_token class-attribute instance-attribute

next_token: str | None = None

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.

only_associated class-attribute instance-attribute

only_associated: str | None = None

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 .

Output

ListMembersOutput dataclass

Dataclass for ListMembersOutput structure.

Attributes

members class-attribute instance-attribute

members: list[Member] | None = None

A list of members.

Note

The values for email and invitedAt are available only if the member accounts are added by invitation.

next_token class-attribute instance-attribute

next_token: str | None = None

The pagination parameter to be used on the next list operation to retrieve more items.