Guardduty  >  Operations  >  get_members

get_members

Operation

get_members async

get_members(input: GetMembersInput, plugins: list[Plugin] | None = None) -> GetMembersOutput

Retrieves GuardDuty member accounts (of the current GuardDuty administrator account) specified by the account IDs.

Parameters:

Name	Type	Description	Default
input	GetMembersInput	An instance of GetMembersInput.	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
GetMembersOutput	An instance of GetMembersOutput.

Input

GetMembersInput dataclass

Dataclass for GetMembersInput structure.

Attributes

account_ids class-attribute instance-attribute

account_ids: list[str] | None = None

A list of account IDs of the GuardDuty member accounts that you want to describe.

detector_id class-attribute instance-attribute

detector_id: str | None = None

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

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

Output

GetMembersOutput dataclass

Dataclass for GetMembersOutput structure.

Attributes

members class-attribute instance-attribute

members: list[Member] | None = None

A list of members.

unprocessed_accounts class-attribute instance-attribute

unprocessed_accounts: list[UnprocessedAccount] | None = None

A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.