create_detector¶
Operation¶
async
¶
create_detector(input: CreateDetectorInput, plugins: list[Plugin] | None = None) -> CreateDetectorOutput
Creates a single GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region. All data sources are enabled in a new detector by default.
-
When you don't specify any
features, with an exception toRUNTIME_MONITORING, all the optional features are enabled by default. -
When you specify some of the
features, any feature that is not specified in the API call gets enabled by default, with an exception toRUNTIME_MONITORING.
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
|
CreateDetectorInput
|
An instance of |
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 |
|---|---|
CreateDetectorOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for CreateDetectorInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = None
The idempotency token for the create request.
class-attribute
instance-attribute
¶
data_sources: DataSourceConfigurations | None = None
Describes which data sources will be enabled for the detector.
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.
class-attribute
instance-attribute
¶
enable: bool | None = None
A Boolean value that specifies whether the detector is to be enabled.
class-attribute
instance-attribute
¶
features: list[DetectorFeatureConfiguration] | None = None
A list of features that will be configured for the detector.
class-attribute
instance-attribute
¶
finding_publishing_frequency: FindingPublishingFrequency | None = None
A value that specifies how frequently updated findings are exported.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The tags to be added to a new detector resource.
Output¶
dataclass
¶
Dataclass for CreateDetectorOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
detector_id: str | None = None
The unique ID of the created detector.
class-attribute
instance-attribute
¶
unprocessed_data_sources: UnprocessedDataSourcesResult | None = None
Specifies the data sources that couldn't be enabled when GuardDuty was enabled for the first time.