Skip to content

stop_monitoring_members

Operation

stop_monitoring_members

stop_monitoring_members(request: StopMonitoringMembersInput | StopMonitoringMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopMonitoringMembersInputDict]) -> 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
request StopMonitoringMembersInput | StopMonitoringMembersInputDict | 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[StopMonitoringMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopMonitoringMembersOutput

An instance of StopMonitoringMembersOutput.

stop_monitoring_members async

stop_monitoring_members(request: StopMonitoringMembersInput | StopMonitoringMembersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StopMonitoringMembersInputDict]) -> 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
request StopMonitoringMembersInput | StopMonitoringMembersInputDict | 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[StopMonitoringMembersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
StopMonitoringMembersOutput

An instance of StopMonitoringMembersOutput.

Input

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

StopMonitoringMembersInputDict

Bases: TypedDict

Dictionary form of StopMonitoringMembersInput.

Attributes

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

A list of account IDs for the member accounts to stop monitoring.

detector_id instance-attribute
detector_id: Required[str]

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.

StopMonitoringMembersInput dataclass

Bases: _SerdeShape

Dataclass for StopMonitoringMembersInput structure.

Attributes

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

A list of account IDs for the member accounts to stop monitoring.

detector_id class-attribute instance-attribute
detector_id: str | 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

Bases: _SerdeShape

Dataclass for StopMonitoringMembersOutput 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 an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.