get_detector¶
Operation¶
get_detector
¶
get_detector(request: GetDetectorInput | GetDetectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDetectorInputDict]) -> GetDetectorOutput
Retrieves a GuardDuty detector specified by the detectorId.
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
|
GetDetectorInput | GetDetectorInputDict | 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[GetDetectorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDetectorOutput
|
An instance of |
get_detector
async
¶
get_detector(request: GetDetectorInput | GetDetectorInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetDetectorInputDict]) -> GetDetectorOutput
Retrieves a GuardDuty detector specified by the detectorId.
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
|
GetDetectorInput | GetDetectorInputDict | 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[GetDetectorInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetDetectorOutput
|
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.
GetDetectorInputDict
¶
Bases: TypedDict
Dictionary form of GetDetectorInput.
Attributes¶
detector_id
instance-attribute
¶
The unique ID of the detector that you want to get.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
GetDetectorInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDetectorInput structure.
Attributes¶
detector_id
class-attribute
instance-attribute
¶
detector_id: str | None = ...
The unique ID of the detector that you want to get.
To find the detectorId in the current Region, see the Settings page in
the GuardDuty console, or run the
ListDetectors
API.
Output¶
GetDetectorOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetDetectorOutput structure.
Attributes¶
created_at
class-attribute
instance-attribute
¶
created_at: str | None = ...
The timestamp of when the detector was created.
data_sources
class-attribute
instance-attribute
¶
data_sources: DataSourceConfigurationsResult | None = ...
Describes which data sources are enabled for the detector.
features
class-attribute
instance-attribute
¶
features: list[DetectorFeatureConfigurationResult] | None = ...
Describes the features that have been enabled for the detector.
finding_publishing_frequency
class-attribute
instance-attribute
¶
finding_publishing_frequency: str | None = ...
The publishing frequency of the finding.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
service_role
class-attribute
instance-attribute
¶
service_role: str | None = ...
The GuardDuty service role.
tags
class-attribute
instance-attribute
¶
The tags of the detector resource.