StopMonitoringMembers
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.
Request Syntax
POST /detector/detectorId/member/stop HTTP/1.1
Content-type: application/json
{
"accountIds": [ "string" ]
}URI Request Parameters
The request uses the following URI parameters.
- detectorId
-
The unique ID of the detector associated with the GuardDuty administrator account that is monitoring member accounts.
To find the
detectorIdin the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.Length Constraints: Minimum length of 1. Maximum length of 300.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- accountIds
-
A list of account IDs for the member accounts to stop monitoring.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 50 items.
Length Constraints: Fixed length of 12.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"unprocessedAccounts": [
{
"accountId": "string",
"result": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- unprocessedAccounts
-
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.
Type: Array of UnprocessedAccount objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
A bad request exception object.
HTTP Status Code: 400
- InternalServerErrorException
-
An internal server error exception object.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
