Get Malware Scan

guardduty_get_malware_scan

R Documentation

Retrieves the detailed information for a specific malware scan

Description

Retrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization.

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_get_malware_scan(ScanId)

Arguments

ScanId

[required] A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

Value

A list with the following syntax:

list(
  ScanId = "string",
  DetectorId = "string",
  AdminDetectorId = "string",
  ResourceArn = "string",
  ResourceType = "EBS_RECOVERY_POINT"|"EBS_SNAPSHOT"|"EBS_VOLUME"|"EC2_AMI"|"EC2_INSTANCE"|"EC2_RECOVERY_POINT"|"S3_RECOVERY_POINT"|"S3_BUCKET"|"S3_POINT_IN_TIME_RECOVERY",
  ScannedResourcesCount = 123,
  SkippedResourcesCount = 123,
  FailedResourcesCount = 123,
  ScannedResources = list(
    list(
      ScannedResourceArn = "string",
      ScannedResourceType = "EBS_RECOVERY_POINT"|"EBS_SNAPSHOT"|"EBS_VOLUME"|"EC2_AMI"|"EC2_INSTANCE"|"EC2_RECOVERY_POINT"|"S3_RECOVERY_POINT"|"S3_BUCKET"|"S3_POINT_IN_TIME_RECOVERY",
      ScannedResourceStatus = "RUNNING"|"COMPLETED"|"COMPLETED_WITH_ISSUES"|"FAILED"|"SKIPPED",
      ScanStatusReason = "ACCESS_DENIED"|"RESOURCE_NOT_FOUND"|"SNAPSHOT_SIZE_LIMIT_EXCEEDED"|"RESOURCE_UNAVAILABLE"|"INCONSISTENT_SOURCE"|"INCREMENTAL_NO_DIFFERENCE"|"NO_EBS_VOLUMES_FOUND"|"UNSUPPORTED_PRODUCT_CODE_TYPE"|"AMI_SNAPSHOT_LIMIT_EXCEEDED"|"UNRELATED_RESOURCES"|"BASE_RESOURCE_NOT_SCANNED"|"BASE_CREATED_AFTER_TARGET"|"UNSUPPORTED_FOR_INCREMENTAL"|"UNSUPPORTED_AMI"|"UNSUPPORTED_SNAPSHOT"|"UNSUPPORTED_COMPOSITE_RECOVERY_POINT"|"ALL_FILES_SKIPPED_OR_FAILED",
      ResourceDetails = list(
        EbsVolume = list(
          VolumeArn = "string",
          VolumeType = "string",
          DeviceName = "string",
          VolumeSizeInGB = 123,
          EncryptionType = "string",
          SnapshotArn = "string",
          KmsKeyArn = "string"
        ),
        EbsSnapshot = list(
          DeviceName = "string"
        )
      )
    )
  ),
  ScanConfiguration = list(
    Role = "string",
    TriggerDetails = list(
      GuardDutyFindingId = "string",
      Description = "string",
      TriggerType = "BACKUP"|"GUARDDUTY"
    ),
    IncrementalScanDetails = list(
      BaselineResourceArn = "string"
    ),
    RecoveryPoint = list(
      BackupVaultName = "string",
      ContinuousScanDetails = list(
        StartTime = as.POSIXct(
          "2015-01-01"
        ),
        EndTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  ),
  ScanCategory = "FULL_SCAN"|"INCREMENTAL_SCAN",
  ScanStatus = "RUNNING"|"COMPLETED"|"COMPLETED_WITH_ISSUES"|"FAILED"|"SKIPPED",
  ScanStatusReason = "ACCESS_DENIED"|"RESOURCE_NOT_FOUND"|"SNAPSHOT_SIZE_LIMIT_EXCEEDED"|"RESOURCE_UNAVAILABLE"|"INCONSISTENT_SOURCE"|"INCREMENTAL_NO_DIFFERENCE"|"NO_EBS_VOLUMES_FOUND"|"UNSUPPORTED_PRODUCT_CODE_TYPE"|"AMI_SNAPSHOT_LIMIT_EXCEEDED"|"UNRELATED_RESOURCES"|"BASE_RESOURCE_NOT_SCANNED"|"BASE_CREATED_AFTER_TARGET"|"UNSUPPORTED_FOR_INCREMENTAL"|"UNSUPPORTED_AMI"|"UNSUPPORTED_SNAPSHOT"|"UNSUPPORTED_COMPOSITE_RECOVERY_POINT"|"ALL_FILES_SKIPPED_OR_FAILED",
  ScanType = "BACKUP_INITIATED"|"ON_DEMAND"|"GUARDDUTY_INITIATED",
  ScanStartedAt = as.POSIXct(
    "2015-01-01"
  ),
  ScanCompletedAt = as.POSIXct(
    "2015-01-01"
  ),
  ScanResultDetails = list(
    ScanResultStatus = "NO_THREATS_FOUND"|"THREATS_FOUND",
    SkippedFileCount = 123,
    FailedFileCount = 123,
    ThreatFoundFileCount = 123,
    TotalFileCount = 123,
    TotalBytes = 123,
    UniqueThreatCount = 123,
    Threats = list(
      list(
        Name = "string",
        Source = "AMAZON"|"BITDEFENDER",
        Count = 123,
        Hash = "string",
        ItemDetails = list(
          list(
            ResourceArn = "string",
            ItemPath = "string",
            Hash = "string",
            AdditionalInfo = list(
              VersionId = "string",
              DeviceName = "string"
            )
          )
        )
      )
    )
  )
)

Request syntax

svc$get_malware_scan(
  ScanId = "string"
)