Skip to content

Guardduty  >  Operations  >  update_detector

update_detector

Operation

update_detector async

update_detector(input: UpdateDetectorInput, plugins: list[Plugin] | None = None) -> UpdateDetectorOutput

Updates the GuardDuty detector specified by the detector ID.

Specifying both EKS Runtime Monitoring (EKS_RUNTIME_MONITORING) and Runtime Monitoring (RUNTIME_MONITORING) will cause an error. You can add only one of these two features because Runtime Monitoring already includes the threat detection for Amazon EKS resources. For more information, see Runtime Monitoring.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name Type Description Default
input UpdateDetectorInput

An instance of UpdateDetectorInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
UpdateDetectorOutput

An instance of UpdateDetectorOutput.

Input

UpdateDetectorInput dataclass

Dataclass for UpdateDetectorInput structure.

Attributes

data_sources class-attribute instance-attribute
data_sources: DataSourceConfigurations | None = None

Describes which data sources will be updated.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

detector_id class-attribute instance-attribute
detector_id: str | None = None

The unique ID of the detector to update.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

enable class-attribute instance-attribute
enable: bool | None = None

Specifies whether the detector is enabled or not enabled.

features class-attribute instance-attribute
features: list[DetectorFeatureConfiguration] | None = None

Provides the features that will be updated for the detector.

finding_publishing_frequency class-attribute instance-attribute
finding_publishing_frequency: FindingPublishingFrequency | None = None

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

Output

UpdateDetectorOutput dataclass

Dataclass for UpdateDetectorOutput structure.