StopMonitoringMembers - Amazon GuardDuty

StopMonitoringMembers

Stops GuardDuty monitoring for the specified member accounnts. Use the StartMonitoringMembers to restart monitoring for those accounts.

Request Syntax

POST /detector/detectorId/member/stop HTTP/1.1 Content-type: application/json { "accountIds": [ "string" ] }

URI Request Parameters

The request requires the following URI parameters.

detectorId

The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.

Length Constraints: Minimum length of 1. Maximum length of 300.

Request Body

The request accepts the following data in JSON format.

accountIds

A list of account IDs of the GuardDuty member accounts whose findings you want the master account 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 containing the unprocessed account and a result string explaining why it was unprocessed.

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

Bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

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: