ArchiveFindingsCommand

Suggest an Edit

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

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { GuardDutyClient, ArchiveFindingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
// const { GuardDutyClient, ArchiveFindingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
const client = new GuardDutyClient(config);
const input = { // ArchiveFindingsRequest
  DetectorId: "STRING_VALUE", // required
  FindingIds: [ // FindingIds // required
    "STRING_VALUE",
  ],
};
const command = new ArchiveFindingsCommand(input);
const response = await client.send(command);
// {};

ArchiveFindingsCommand Input

See ArchiveFindingsCommandInput for more details

Parameter
Type
Description
DetectorId
Required
string | undefined

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.

FindingIds
Required
string[] | undefined

The IDs of the findings that you want to archive.

ArchiveFindingsCommand Output

See ArchiveFindingsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

A bad request exception object.

InternalServerErrorException
server

An internal server error exception object.

GuardDutyServiceException
Base exception class for all service exceptions from GuardDuty service.