ScanJob ¶

class ScanJob(TypedDict, closed=True):
    account_id: "str"
    """<p>The account ID that owns the scan job.</p>"""
    backup_vault_arn: "str"
    """<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>"""
    backup_vault_name: "str"
    """<p>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.</p>"""
    completion_date: NotRequired["datetime.datetime"]
    """<p>The date and time that a scan job is completed, in Unix format and Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    continuous_scan_end_time: NotRequired["datetime.datetime"]
    """<p>The point in time the scan job scanned up to for a continuous backup.</p>"""
    continuous_scan_start_time: NotRequired["datetime.datetime"]
    """<p>The point in time the scan job started scan from for a continuous backup.</p>"""
    created_by: "capo_backup.types.scan_job_creator.ScanJobCreator"
    """<p>Contains identifying information about the creation of a scan job.</p>"""
    creation_date: "datetime.datetime"
    """<p>The date and time that a scan job is created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    iam_role_arn: "str"
    """<p>Specifies the IAM role ARN used to create the scan job; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    malware_scanner: "capo_backup.types.malware_scanner.MalwareScanner"
    """<p>The scanning engine used for the scan job. Currently only <code>GUARDDUTY</code> is supported.</p>"""
    recovery_point_arn: "str"
    """<p>An ARN that uniquely identifies the recovery point being scanned; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"""
    resource_arn: "str"
    """<p>An ARN that uniquely identifies the source resource of the recovery point being scanned.</p>"""
    resource_name: "str"
    """<p>The non-unique name of the resource that belongs to the specified backup.</p>"""
    resource_type: "capo_backup.types.scan_resource_type.ScanResourceType"
    """<p>The type of Amazon Web Services resource being scanned; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"""
    scan_base_recovery_point_arn: NotRequired["str"]
    """<p>An ARN that uniquely identifies the base recovery point for scanning. This field is populated when an incremental scan job has taken place.</p>"""
    scan_id: NotRequired["str"]
    """<p>The scan ID generated by the malware scanner for the corresponding scan job.</p>"""
    scan_job_id: "str"
    """<p>The unique identifier that identifies the scan job request to Backup.</p>"""
    scan_mode: "capo_backup.types.scan_mode.ScanMode"
    """<p>Specifies the scan type use for the scan job.</p> <p>Includes:</p> <p> <code>FULL_SCAN</code> will scan the entire data lineage within the backup.</p> <p> <code>INCREMENTAL_SCAN</code> will scan the data difference between the target recovery point and base recovery point ARN.</p>"""
    scan_result: NotRequired["capo_backup.types.scan_result_info.ScanResultInfo"]
    """<p>Contains the scan results information, including the status of threats found during scanning.</p>"""
    scanner_role_arn: "str"
    """<p>Specifies the scanner IAM role ARN used for the scan job.</p>"""
    state: NotRequired["capo_backup.types.scan_state.ScanState"]
    """<p>The current state of the scan job.</p> <p>Valid values: <code>CREATED</code> | <code>RUNNING</code> | <code>COMPLETED</code> | <code>COMPLETED_WITH_ISSUES</code> | <code>FAILED</code> | <code>CANCELED</code>.</p>"""
    status_message: NotRequired["str"]
    """<p>A detailed message explaining the status of the scan job.</p>"""