Skip to content

Guardduty  >  Operations  >  get_detector

get_detector

Operation

get_detector async

get_detector(input: GetDetectorInput, plugins: list[Plugin] | None = None) -> 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
input GetDetectorInput

An instance of GetDetectorInput.

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
GetDetectorOutput

An instance of GetDetectorOutput.

Input

GetDetectorInput dataclass

Dataclass for GetDetectorInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | None = 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

Dataclass for GetDetectorOutput structure.

Attributes

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

The timestamp of when the detector was created.

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

Describes which data sources are enabled for the detector.

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

Describes the features that have been enabled for the detector.

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

The publishing frequency of the finding.

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

The GuardDuty service role.

status class-attribute instance-attribute
status: DetectorStatus | None = None

The detector status.

tags class-attribute instance-attribute
tags: dict[str, str] | None = None

The tags of the detector resource.

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

The last-updated timestamp for the detector.