Skip to content

DescribeScanJobOutput

Source code in docs_src/capo_backup/types/describe_scan_job_output.py
class DescribeScanJobOutput(TypedDict, closed=True):
    account_id: "str"
    """<p>Returns the account ID that owns the scan job.</p> <p>Pattern: <code>^[0-9]{12}$</code> </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"
    r"""<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> <p>Pattern: <code>^[a-zA-Z0-9\-\_\.]{2,50}$</code> </p>"""
    completion_date: NotRequired["datetime.datetime"]
    """<p>The date and time that a backup index finished creation, 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"
    creation_date: "datetime.datetime"
    """<p>The date and time that a backup index finished creation, 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>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; 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 corresponding scan job. Currently only <code>GUARDUTY</code> is supported.</p>"""
    recovery_point_arn: "str"
    """<p>An ARN that uniquely identifies the target recovery point for scanning.; 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 corresponding recovery point ARN.</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"
    r"""<p>The type of Amazon Web Services Resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume.</p> <p>Pattern: <code>^[a-zA-Z0-9\-\_\.]{1,50}$</code> </p>"""
    scan_base_recovery_point_arn: NotRequired["str"]
    """<p>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.</p>"""
    scan_id: NotRequired["str"]
    """<p>The scan ID generated by Amazon GuardDuty for the corresponding Scan Job ID request from Backup.</p>"""
    scan_job_id: "str"
    """<p>The scan job ID that uniquely identified the request to Backup.</p>"""
    scan_mode: "capo_backup.types.scan_mode.ScanMode"
    """<p>Specifies the scan type used for the scan job.</p>"""
    scan_result: NotRequired["capo_backup.types.scan_result_info.ScanResultInfo"]
    """<p> Contains the <code>ScanResultsStatus</code> for the scanning job and returns <code>THREATS_FOUND</code> or <code>NO_THREATS_FOUND</code> for completed jobs.</p>"""
    scanner_role_arn: "str"
    """<p>Specifies the scanner IAM role ARN used to for the scan job.</p>"""
    state: "capo_backup.types.scan_state.ScanState"
    """<p>The current state of a scan job.</p>"""
    status_message: NotRequired["str"]
    """<p>A detailed message explaining the status of the job to back up a resource.</p>"""

account_id instance-attribute

account_id: str

Returns the account ID that owns the scan job.

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

backup_vault_arn instance-attribute

backup_vault_arn: str

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

backup_vault_name instance-attribute

backup_vault_name: str

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

completion_date instance-attribute

completion_date: NotRequired[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.

continuous_scan_end_time instance-attribute

continuous_scan_end_time: NotRequired[datetime]

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

continuous_scan_start_time instance-attribute

continuous_scan_start_time: NotRequired[datetime]

The point in time the scan job started scan from for a continuous backup.

created_by instance-attribute

created_by: ScanJobCreator

creation_date instance-attribute

creation_date: 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.

iam_role_arn instance-attribute

iam_role_arn: str

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

malware_scanner instance-attribute

malware_scanner: MalwareScanner

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

recovery_point_arn instance-attribute

recovery_point_arn: str

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.

resource_arn instance-attribute

resource_arn: str

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

resource_name instance-attribute

resource_name: str

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

resource_type instance-attribute

resource_type: ScanResourceType

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

scan_base_recovery_point_arn instance-attribute

scan_base_recovery_point_arn: NotRequired[str]

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.

scan_id instance-attribute

scan_id: NotRequired[str]

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

scan_job_id instance-attribute

scan_job_id: str

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

scan_mode instance-attribute

scan_mode: ScanMode

Specifies the scan type used for the scan job.

scan_result instance-attribute

scan_result: NotRequired[ScanResultInfo]

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

scanner_role_arn instance-attribute

scanner_role_arn: str

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

state instance-attribute

state: ScanState

The current state of a scan job.

status_message instance-attribute

status_message: NotRequired[str]

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