Skip to content

start_monitoring_members

Operation

start_monitoring_members

start_monitoring_members(request: StartMonitoringMembersInput | StartMonitoringMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartMonitoringMembersInputDict]) -> StartMonitoringMembersOutput

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

Parameters:

Name Type Description Default
request StartMonitoringMembersInput | StartMonitoringMembersInputDict | 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[StartMonitoringMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartMonitoringMembersOutput

An instance of StartMonitoringMembersOutput.

start_monitoring_members async

start_monitoring_members(request: StartMonitoringMembersInput | StartMonitoringMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartMonitoringMembersInputDict]) -> StartMonitoringMembersOutput

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

Parameters:

Name Type Description Default
request StartMonitoringMembersInput | StartMonitoringMembersInputDict | 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[StartMonitoringMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StartMonitoringMembersOutput

An instance of StartMonitoringMembersOutput.

Input

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

StartMonitoringMembersInputDict

Bases: TypedDict

Dictionary form of StartMonitoringMembersInput.

Attributes

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

A list of account IDs of the GuardDuty member accounts to start monitoring.

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.

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

StartMonitoringMembersInput dataclass

Bases: _SerdeShape

Dataclass for StartMonitoringMembersInput structure.

Attributes

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

A list of account IDs of the GuardDuty member accounts to start monitoring.

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

The unique ID of the detector of the GuardDuty administrator account associated with the member accounts to monitor.

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

Output

StartMonitoringMembersOutput dataclass

Bases: _SerdeShape

Dataclass for StartMonitoringMembersOutput structure.

Attributes

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.