Describe Malware Scans

guardduty_describe_malware_scans

R Documentation

Returns a list of malware scans¶

Description¶

Returns a list of malware scans. Each member account can view the malware scans for their own accounts. An administrator can view the malware scans for all the member accounts.

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.

Usage¶

guardduty_describe_malware_scans(DetectorId, NextToken, MaxResults,
  FilterCriteria, SortCriteria)

Arguments¶

DetectorId

[required] The unique ID of the detector that the request is associated with.

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

NextToken

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

MaxResults

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.

FilterCriteria

Represents the criteria to be used in the filter for describing scan entries.

SortCriteria

Represents the criteria used for sorting scan entries. The attributeName is required and it must be scanStartTime.

Value¶

A list with the following syntax:

list(
  Scans = list(
    list(
      DetectorId = "string",
      AdminDetectorId = "string",
      ScanId = "string",
      ScanStatus = "RUNNING"|"COMPLETED"|"FAILED"|"SKIPPED",
      FailureReason = "string",
      ScanStartTime = as.POSIXct(
        "2015-01-01"
      ),
      ScanEndTime = as.POSIXct(
        "2015-01-01"
      ),
      TriggerDetails = list(
        GuardDutyFindingId = "string",
        Description = "string"
      ),
      ResourceDetails = list(
        InstanceArn = "string"
      ),
      ScanResultDetails = list(
        ScanResult = "CLEAN"|"INFECTED"
      ),
      AccountId = "string",
      TotalBytes = 123,
      FileCount = 123,
      AttachedVolumes = list(
        list(
          VolumeArn = "string",
          VolumeType = "string",
          DeviceName = "string",
          VolumeSizeInGB = 123,
          EncryptionType = "string",
          SnapshotArn = "string",
          KmsKeyArn = "string"
        )
      ),
      ScanType = "GUARDDUTY_INITIATED"|"ON_DEMAND"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_malware_scans(
  DetectorId = "string",
  NextToken = "string",
  MaxResults = 123,
  FilterCriteria = list(
    FilterCriterion = list(
      list(
        CriterionKey = "EC2_INSTANCE_ARN"|"SCAN_ID"|"ACCOUNT_ID"|"GUARDDUTY_FINDING_ID"|"SCAN_START_TIME"|"SCAN_STATUS"|"SCAN_TYPE",
        FilterCondition = list(
          EqualsValue = "string",
          GreaterThan = 123,
          LessThan = 123
        )
      )
    )
  ),
  SortCriteria = list(
    AttributeName = "string",
    OrderBy = "ASC"|"DESC"
  )
)