Skip to content

Guardduty  >  Operations  >  archive_findings

archive_findings

Operation

archive_findings async

archive_findings(input: ArchiveFindingsInput, plugins: list[Plugin] | None = None) -> ArchiveFindingsOutput

Archives GuardDuty findings that are specified by the list of finding IDs.

Note

Only the administrator account can archive findings. Member accounts don't have permission to archive findings from their accounts.

Parameters:

Name Type Description Default
input ArchiveFindingsInput

An instance of ArchiveFindingsInput.

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
ArchiveFindingsOutput

An instance of ArchiveFindingsOutput.

Input

ArchiveFindingsInput dataclass

Dataclass for ArchiveFindingsInput 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 archive.

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 archive.

Output

ArchiveFindingsOutput dataclass

Dataclass for ArchiveFindingsOutput structure.