stop_monitoring_members¶
Operation¶
stop_monitoring_members
async
¶
stop_monitoring_members(input: StopMonitoringMembersInput, plugins: list[Plugin] | None = None) -> StopMonitoringMembersOutput
Stops GuardDuty monitoring for the specified member accounts. Use the
StartMonitoringMembers operation to restart monitoring for those
accounts.
With autoEnableOrganizationMembers configuration for your organization
set to ALL, you'll receive an error if you attempt to stop monitoring
the member accounts in your organization.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
StopMonitoringMembersInput
|
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 |
|---|---|
StopMonitoringMembersOutput
|
An instance of |
Input¶
StopMonitoringMembersInput
dataclass
¶
Dataclass for StopMonitoringMembersInput structure.
Attributes¶
account_ids
class-attribute
instance-attribute
¶
account_ids: list[str] | None = None
A list of account IDs for the member accounts to stop monitoring.
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
Output¶
StopMonitoringMembersOutput
dataclass
¶
Dataclass for StopMonitoringMembersOutput structure.
Attributes¶
unprocessed_accounts
class-attribute
instance-attribute
¶
unprocessed_accounts: list[UnprocessedAccount] | None = None
A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.