GuardDuty / Client / stop_monitoring_members

stop_monitoring_members#

GuardDuty.Client.stop_monitoring_members(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.stop_monitoring_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    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.

  • AccountIds (list) –

    [REQUIRED]

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

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • UnprocessedAccounts (list) –

      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.

      • (dict) –

        Contains information about the accounts that weren’t processed.

        • AccountId (string) –

          The Amazon Web Services account ID.

        • Result (string) –

          A reason why the account hasn’t been processed.

Exceptions