Skip to content

get_member_detectors

Operation

get_member_detectors

get_member_detectors(request: GetMemberDetectorsInput | GetMemberDetectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMemberDetectorsInputDict]) -> GetMemberDetectorsOutput

Describes which data sources are enabled for the member account's detector.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
request GetMemberDetectorsInput | GetMemberDetectorsInputDict | 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[GetMemberDetectorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMemberDetectorsOutput

An instance of GetMemberDetectorsOutput.

get_member_detectors async

get_member_detectors(request: GetMemberDetectorsInput | GetMemberDetectorsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMemberDetectorsInputDict]) -> GetMemberDetectorsOutput

Describes which data sources are enabled for the member account's detector.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
request GetMemberDetectorsInput | GetMemberDetectorsInputDict | 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[GetMemberDetectorsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMemberDetectorsOutput

An instance of GetMemberDetectorsOutput.

Input

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

GetMemberDetectorsInputDict

Bases: TypedDict

Dictionary form of GetMemberDetectorsInput.

Attributes

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

A list of member account IDs.

detector_id instance-attribute
detector_id: Required[str]

The detector ID for the administrator account.

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

GetMemberDetectorsInput dataclass

Bases: _SerdeShape

Dataclass for GetMemberDetectorsInput structure.

Attributes

account_ids class-attribute instance-attribute
account_ids: list[str] | None = ...

A list of member account IDs.

detector_id class-attribute instance-attribute
detector_id: str | None = ...

The detector ID for the administrator account.

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

Output

GetMemberDetectorsOutput dataclass

Bases: _SerdeShape

Dataclass for GetMemberDetectorsOutput structure.

Attributes

member_data_source_configurations class-attribute instance-attribute
member_data_source_configurations: list[MemberDataSourceConfiguration] | None = ...

An object that describes which data sources are enabled for a member account.

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 member account IDs that were unable to be processed along with an explanation for why they were not processed.