Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateDetector

Updates the Amazon GuardDuty detector specified by the detectorId.

Request Syntax


POST /detector/detectorId HTTP/1.1
Content-type: application/json

{
   "dataSources": { 
      "kubernetes": { 
         "auditLogs": { 
            "enable": boolean
         }
      },
      "s3Logs": { 
         "enable": boolean
      }
   },
   "enable": boolean,
   "findingPublishingFrequency": "string"
}

URI Request Parameters

The request uses the following URI parameters.

detectorId

The unique ID of the detector to update.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

dataSources

Describes which data sources will be updated.

Type: DataSourceConfigurations object

Required: No

enable

Specifies whether the detector is enabled or not enabled.

Type: Boolean

Required: No

findingPublishingFrequency

An 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

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500