Skip to content

archive_findings

Operation

archive_findings

archive_findings(request: ArchiveFindingsInput | ArchiveFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ArchiveFindingsInputDict]) -> 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
request ArchiveFindingsInput | ArchiveFindingsInputDict | 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[ArchiveFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ArchiveFindingsOutput

An instance of ArchiveFindingsOutput.

archive_findings async

archive_findings(request: ArchiveFindingsInput | ArchiveFindingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ArchiveFindingsInputDict]) -> 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
request ArchiveFindingsInput | ArchiveFindingsInputDict | 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[ArchiveFindingsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ArchiveFindingsOutput

An instance of ArchiveFindingsOutput.

Input

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

ArchiveFindingsInputDict

Bases: TypedDict

Dictionary form of ArchiveFindingsInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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

The IDs of the findings that you want to archive.

ArchiveFindingsInput dataclass

Bases: _SerdeShape

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

The IDs of the findings that you want to archive.

Output

ArchiveFindingsOutput dataclass

Bases: _SerdeShape

Dataclass for ArchiveFindingsOutput structure.

Attributes

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.