UpdateDetector - Amazon GuardDuty

UpdateDetector

Updates the Amazon GuardDuty detector specified by the detectorId.

Request Syntax

POST /detector/detectorId HTTP/1.1 Content-type: application/json { "enable": boolean, "findingPublishingFrequency": "string" }

URI Request Parameters

The request requires the following URI parameters.

detectorId

The unique ID of the detector to update.

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

Request Body

The request accepts the following data in JSON format.

enable

Specifies whether the detector is enabled or not enabled.

Type: Boolean

Required: No

findingPublishingFrequency

A enum value that specifies how frequently findings are exported, such as to CloudWatch Events.

Type: String

Valid Values: FIFTEEN_MINUTES | ONE_HOUR | SIX_HOURS

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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: