Skip to content

get_findings

Operation

get_findings

get_findings(request: GetFindingsInput | GetFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFindingsInputDict]) -> GetFindingsOutput

Describes Amazon GuardDuty findings specified by finding IDs.

Parameters:

Name Type Description Default
request GetFindingsInput | GetFindingsInputDict | 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[GetFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFindingsOutput

An instance of GetFindingsOutput.

get_findings async

get_findings(request: GetFindingsInput | GetFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFindingsInputDict]) -> GetFindingsOutput

Describes Amazon GuardDuty findings specified by finding IDs.

Parameters:

Name Type Description Default
request GetFindingsInput | GetFindingsInputDict | 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[GetFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFindingsOutput

An instance of GetFindingsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetFindingsInputDict

Bases: TypedDict

Dictionary form of GetFindingsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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 instance-attribute
finding_ids: Required[Sequence[str]]

The IDs of the findings that you want to retrieve.

sort_criteria instance-attribute
sort_criteria: SortCriteria | SortCriteriaDict | None

Represents the criteria used for sorting findings.

GetFindingsInput dataclass

Bases: _SerdeShape

Dataclass for GetFindingsInput structure.

Attributes

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

The IDs of the findings that you want to retrieve.

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

Represents the criteria used for sorting findings.

Output

GetFindingsOutput dataclass

Bases: _SerdeShape

Dataclass for GetFindingsOutput structure.

Attributes

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

A list of findings.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.