Start Malware Scan

guardduty_start_malware_scan

R Documentation

Initiates the malware scan

Description

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance.

When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see list_malware_scans and get_malware_scan.

When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.

Usage

guardduty_start_malware_scan(ResourceArn, ClientToken,
  ScanConfiguration)

Arguments

ResourceArn	[required] Amazon Resource Name (ARN) of the resource for which you invoked the API.
ClientToken	The idempotency token for the create request.
ScanConfiguration	Contains information about the configuration to be used for the malware scan.

Value

A list with the following syntax:

list(
  ScanId = "string"
)

Request syntax

svc$start_malware_scan(
  ResourceArn = "string",
  ClientToken = "string",
  ScanConfiguration = list(
    Role = "string",
    IncrementalScanDetails = list(
      BaselineResourceArn = "string"
    ),
    RecoveryPoint = list(
      BackupVaultName = "string",
      ContinuousScanDetails = list(
        StartTime = as.POSIXct(
          "2015-01-01"
        ),
        EndTime = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)