Skip to content

Start Scan Job

backup_start_scan_job R Documentation

Starts scanning jobs for specific resources

Description

Starts scanning jobs for specific resources.

Usage

backup_start_scan_job(BackupVaultName, ContinuousScanEndTime,
  IamRoleArn, IdempotencyToken, MalwareScanner, RecoveryPointArn,
  ScanBaseRecoveryPointArn, ScanMode, ScannerRoleArn)

Arguments

BackupVaultName

[required] The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Amazon Web Services Region where they are created.

Pattern: ⁠^[a-zA-Z0-9\-_]{2,50}$⁠
ContinuousScanEndTime

The point in time the scan job will scan up to for a continuous backup.
IamRoleArn

[required] Specifies the IAM role ARN used to create the target recovery point; for example, ⁠arn:aws:iam::123456789012:role/S3Access⁠.
IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to start_scan_job. Retrying a successful request with the same idempotency token results in a success message with no action taken.
MalwareScanner

[required] Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.
RecoveryPointArn

[required] An Amazon Resource Name (ARN) that uniquely identifies a recovery point. This is your target recovery point for a full scan. If you are running an incremental scan, this will be your a recovery point which has been created after your base recovery point selection.
ScanBaseRecoveryPointArn

An ARN that uniquely identifies the base recovery point to be used for incremental scanning.
ScanMode

[required] Specifies the scan type use for the scan job.

Includes:

  • FULL_SCAN will scan the entire data lineage within the backup.

  • INCREMENTAL_SCAN will scan the data difference between the target recovery point and base recovery point ARN.
ScannerRoleArn

[required] Specified the IAM scanner role ARN.

Value

A list with the following syntax:

list(
  CreationDate = as.POSIXct(
    "2015-01-01"
  ),
  ScanJobId = "string"
)

Request syntax

svc$start_scan_job(
  BackupVaultName = "string",
  ContinuousScanEndTime = as.POSIXct(
    "2015-01-01"
  ),
  IamRoleArn = "string",
  IdempotencyToken = "string",
  MalwareScanner = "GUARDDUTY",
  RecoveryPointArn = "string",
  ScanBaseRecoveryPointArn = "string",
  ScanMode = "FULL_SCAN"|"INCREMENTAL_SCAN",
  ScannerRoleArn = "string"
)