get_members¶
Operation¶
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 |
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 |
Input¶
dataclass
¶
Dataclass for GetMembersInput structure.
Attributes¶
class-attribute
instance-attribute
¶
A list of account IDs of the GuardDuty member accounts that you want to describe.
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¶
dataclass
¶
Dataclass for GetMembersOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
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.