Skip to content

GuardDuty  >  Operations  >  get_findings

get_findings

Operation

get_findings async 

get_findings(input: GetFindingsInput, plugins: list[Plugin] | None = None) -> GetFindingsOutput

Describes Amazon GuardDuty findings specified by finding IDs.

Parameters:

Name Type Description Default
input GetFindingsInput

An instance of GetFindingsInput.

 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
GetFindingsOutput

An instance of GetFindingsOutput.

Input

GetFindingsInput dataclass

Dataclass for GetFindingsInput structure.

Attributes

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

The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

finding_ids class-attribute instance-attribute 
finding_ids: list[str] | None = None

The IDs of the findings that you want to retrieve.

sort_criteria class-attribute instance-attribute 
sort_criteria: SortCriteria | None = None

Represents the criteria used for sorting findings.

Output

GetFindingsOutput dataclass

Dataclass for GetFindingsOutput structure.

Attributes

findings class-attribute instance-attribute 
findings: list[Finding] | None = None

A list of findings.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.