Skip to content

get_members

Operation

get_members

get_members(request: GetMembersInput | GetMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMembersInputDict]) -> GetMembersOutput

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

Parameters:

Name Type Description Default
request GetMembersInput | GetMembersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMembersOutput

An instance of GetMembersOutput.

get_members async

get_members(request: GetMembersInput | GetMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMembersInputDict]) -> GetMembersOutput

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

Parameters:

Name Type Description Default
request GetMembersInput | GetMembersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[GetMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMembersOutput

An instance of GetMembersOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetMembersInputDict

Bases: TypedDict

Dictionary form of GetMembersInput.

Attributes

account_ids instance-attribute
account_ids: Required[Sequence[str]]

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

detector_id instance-attribute
detector_id: Required[str]

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.

GetMembersInput dataclass

Bases: _SerdeShape

Dataclass for GetMembersInput structure.

Attributes

account_ids class-attribute instance-attribute
account_ids: list[str] | 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 = ...

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

Bases: _SerdeShape

Dataclass for GetMembersOutput structure.

Attributes

members class-attribute instance-attribute
members: list[Member] | None = ...

A list of members.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.

unprocessed_accounts class-attribute instance-attribute
unprocessed_accounts: list[UnprocessedAccount] | None = ...

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