update_detector¶
Operation¶
update_detector
¶
update_detector(request: UpdateDetectorInput | UpdateDetectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDetectorInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateDetectorInput | UpdateDetectorInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateDetectorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateDetectorOutput
|
An instance of |
update_detector
async
¶
update_detector(request: UpdateDetectorInput | UpdateDetectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDetectorInputDict]) -> 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 |
|---|---|---|---|
request
|
UpdateDetectorInput | UpdateDetectorInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[UpdateDetectorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateDetectorOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
UpdateDetectorInputDict
¶
Bases: TypedDict
Dictionary form of UpdateDetectorInput.
Attributes¶
data_sources
instance-attribute
¶
data_sources: DataSourceConfigurations | DataSourceConfigurationsDict | 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
instance-attribute
¶
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: bool | None
Specifies whether the detector is enabled or not enabled.
features
instance-attribute
¶
features: Sequence[DetectorFeatureConfiguration | DetectorFeatureConfigurationDict] | None
Provides the features that will be updated for the detector.
UpdateDetectorInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateDetectorInput structure.
Attributes¶
data_sources
class-attribute
instance-attribute
¶
data_sources: DataSourceConfigurations | 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 = ...
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 = ...
Specifies whether the detector is enabled or not enabled.
features
class-attribute
instance-attribute
¶
features: list[DetectorFeatureConfiguration] | None = ...
Provides the features that will be updated for the detector.
Output¶
UpdateDetectorOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateDetectorOutput structure.