Backup / Client / start_scan_job

start_scan_job

Backup.Client.start_scan_job(**kwargs)

Starts scanning jobs for specific resources.

See also: AWS API Documentation

Request Syntax

response = client.start_scan_job(
    BackupVaultName='string',
    IamRoleArn='string',
    IdempotencyToken='string',
    MalwareScanner='GUARDDUTY',
    RecoveryPointArn='string',
    ScanBaseRecoveryPointArn='string',
    ScanMode='FULL_SCAN'|'INCREMENTAL_SCAN',
    ScannerRoleArn='string'
)
Parameters:

  • BackupVaultName (string) –

    [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}$

  • IamRoleArn (string) –

    [REQUIRED]

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

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

  • MalwareScanner (string) –

    [REQUIRED]

    Specifies the malware scanner used during the scan job. Currently only supports GUARDDUTY.

  • RecoveryPointArn (string) –

    [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 (string) – An ARN that uniquely identifies the base recovery point to be used for incremental scanning.

  • ScanMode (string) –

    [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 (string) –

    [REQUIRED]

    Specified the IAM scanner role ARN.

Return type:

dict

Returns:

Response Syntax

{
    'CreationDate': datetime(2015, 1, 1),
    'ScanJobId': 'string'
}

Response Structure

  • (dict) –

    • CreationDate (datetime) –

      The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    • ScanJobId (string) –

      Uniquely identifies a request to Backup to back up a resource.

Exceptions