Backup / Client / describe_scan_job

describe_scan_job

Backup.Client.describe_scan_job(**kwargs)

Returns scan job details for the specified ScanJobID.

See also: AWS API Documentation

Request Syntax

response = client.describe_scan_job(
    ScanJobId='string'
)
Parameters:

ScanJobId (string) –

[REQUIRED]

Uniquely identifies a request to Backup to scan a resource.

Return type:

dict

Returns:

Response Syntax

{
    'AccountId': 'string',
    'BackupVaultArn': 'string',
    'BackupVaultName': 'string',
    'CompletionDate': datetime(2015, 1, 1),
    'CreatedBy': {
        'BackupPlanArn': 'string',
        'BackupPlanId': 'string',
        'BackupPlanVersion': 'string',
        'BackupRuleId': 'string'
    },
    'CreationDate': datetime(2015, 1, 1),
    'IamRoleArn': 'string',
    'MalwareScanner': 'GUARDDUTY',
    'RecoveryPointArn': 'string',
    'ResourceArn': 'string',
    'ResourceName': 'string',
    'ResourceType': 'EBS'|'EC2'|'S3',
    'ScanBaseRecoveryPointArn': 'string',
    'ScanId': 'string',
    'ScanJobId': 'string',
    'ScanMode': 'FULL_SCAN'|'INCREMENTAL_SCAN',
    'ScanResult': {
        'ScanResultStatus': 'NO_THREATS_FOUND'|'THREATS_FOUND'
    },
    'ScannerRoleArn': 'string',
    'State': 'CANCELED'|'COMPLETED'|'COMPLETED_WITH_ISSUES'|'CREATED'|'FAILED'|'RUNNING',
    'StatusMessage': 'string'
}

Response Structure

  • (dict) –

    • AccountId (string) –

      Returns the account ID that owns the scan job.

      Pattern: ^[0-9]{12}$

    • BackupVaultArn (string) –

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault

    • BackupVaultName (string) –

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

    • CompletionDate (datetime) –

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

    • CreatedBy (dict) –

      Contains identifying information about the creation of a scan job, including the backup plan and rule that initiated the scan.

      • BackupPlanArn (string) –

        An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

      • BackupPlanId (string) –

        The ID of the backup plan.

      • BackupPlanVersion (string) –

        Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

      • BackupRuleId (string) –

        Uniquely identifies the backup rule that initiated the scan job.

    • CreationDate (datetime) –

      The date and time that a backup index finished creation, 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.

    • IamRoleArn (string) –

      An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:iam::123456789012:role/S3Access.

    • MalwareScanner (string) –

      The scanning engine used for the corresponding scan job. Currently only GUARDUTY is supported.

    • RecoveryPointArn (string) –

      An ARN that uniquely identifies the target recovery point for scanning.; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

    • ResourceArn (string) –

      An ARN that uniquely identifies the source resource of the corresponding recovery point ARN.

    • ResourceName (string) –

      The non-unique name of the resource that belongs to the specified backup.

    • ResourceType (string) –

      The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.

      Pattern: ^[a-zA-Z0-9\-\_\.]{1,50}$

    • ScanBaseRecoveryPointArn (string) –

      An ARN that uniquely identifies the base recovery point for scanning. This field will only be populated when an incremental scan job has taken place.

    • ScanId (string) –

      The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.

    • ScanJobId (string) –

      The scan job ID that uniquely identified the request to Backup.

    • ScanMode (string) –

      Specifies the scan type used for the scan job.

    • ScanResult (dict) –

      Contains the ScanResultsStatus for the scanning job and returns THREATS_FOUND or NO_THREATS_FOUND for completed jobs.

      • ScanResultStatus (string) –

        The status of the scan results.

        Valid values: THREATS_FOUND | NO_THREATS_FOUND.

    • ScannerRoleArn (string) –

      Specifies the scanner IAM role ARN used to for the scan job.

    • State (string) –

      The current state of a scan job.

    • StatusMessage (string) –

      A detailed message explaining the status of the job to back up a resource.

Exceptions