Skip to content

UpdateDetectorRequest

Source code in docs_src/capo_guardduty/types/update_detector_request.py
class UpdateDetectorRequest(TypedDict, closed=True):
    detector_id: "capo_guardduty.types.detector_id.DetectorId"
    """<p>The unique ID of the detector to update.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    enable: NotRequired["capo_guardduty.types.boolean.Boolean"]
    """<p>Specifies whether the detector is enabled or not enabled.</p>"""
    finding_publishing_frequency: NotRequired[
        "capo_guardduty.types.finding_publishing_frequency.FindingPublishingFrequency"
    ]
    """<p>An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.</p>"""
    data_sources: NotRequired[
        "capo_guardduty.types.data_source_configurations.DataSourceConfigurations"
    ]
    """<p>Describes which data sources will be updated.</p> <p>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 <a href="https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_regions.html">Regions and endpoints</a>.</p>"""
    features: NotRequired[
        "capo_guardduty.types.detector_feature_configurations.DetectorFeatureConfigurations"
    ]
    """<p>Provides the features that will be updated for the detector.</p>"""

data_sources instance-attribute

data_sources: NotRequired[DataSourceConfigurations]

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 instance-attribute

detector_id: DetectorId

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 instance-attribute

enable: NotRequired[Boolean]

Specifies whether the detector is enabled or not enabled.

features instance-attribute

features: NotRequired[DetectorFeatureConfigurations]

Provides the features that will be updated for the detector.

finding_publishing_frequency instance-attribute

finding_publishing_frequency: NotRequired[FindingPublishingFrequency]

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