GetMalwareScanSettingsCommand

Suggest an Edit

Returns the details of the malware scan settings.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints .

Example Syntax

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

import { GuardDutyClient, GetMalwareScanSettingsCommand } from "@aws-sdk/client-guardduty"; // ES Modules import
// const { GuardDutyClient, GetMalwareScanSettingsCommand } = require("@aws-sdk/client-guardduty"); // CommonJS import
const client = new GuardDutyClient(config);
const input = { // GetMalwareScanSettingsRequest
  DetectorId: "STRING_VALUE", // required
};
const command = new GetMalwareScanSettingsCommand(input);
const response = await client.send(command);
// { // GetMalwareScanSettingsResponse
//   ScanResourceCriteria: { // ScanResourceCriteria
//     Include: { // ScanCriterion
//       "<keys>": { // ScanCondition
//         MapEquals: [ // MapEquals // required
//           { // ScanConditionPair
//             Key: "STRING_VALUE", // required
//             Value: "STRING_VALUE",
//           },
//         ],
//       },
//     },
//     Exclude: {
//       "<keys>": {
//         MapEquals: [ // required
//           {
//             Key: "STRING_VALUE", // required
//             Value: "STRING_VALUE",
//           },
//         ],
//       },
//     },
//   },
//   EbsSnapshotPreservation: "NO_RETENTION" || "RETENTION_WITH_FINDING",
// };

GetMalwareScanSettingsCommand Input

See GetMalwareScanSettingsCommandInput for more details

Parameter
Type
Description
DetectorId
Required
string | undefined

The unique ID of the detector that is associated with this scan.

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

GetMalwareScanSettingsCommand Output

See GetMalwareScanSettingsCommandOutput for details

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

An enum value representing possible snapshot preservation settings.

ScanResourceCriteria
ScanResourceCriteria | undefined

Represents the criteria to be used in the filter for scanning resources.

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.