Skip to content

StartScanJobInput

Source code in docs_src/capo_backup/types/start_scan_job_input.py
class StartScanJobInput(TypedDict, closed=True):
    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>"""
    continuous_scan_end_time: NotRequired["datetime.datetime"]
    """<p>The point in time the scan job will scan up to for a continuous backup.</p>"""
    iam_role_arn: "str"
    """<p>Specifies the IAM role ARN used to create the target recovery point; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"""
    idempotency_token: NotRequired["str"]
    """<p>A customer-chosen string that you can use to distinguish between otherwise identical calls to <code>StartScanJob</code>. Retrying a successful request with the same idempotency token results in a success message with no action taken.</p>"""
    malware_scanner: "capo_backup.types.malware_scanner.MalwareScanner"
    """<p>Specifies the malware scanner used during the scan job. Currently only supports <code>GUARDDUTY</code>.</p>"""
    recovery_point_arn: "str"
    """<p>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.</p>"""
    scan_base_recovery_point_arn: NotRequired["str"]
    """<p>An ARN that uniquely identifies the base recovery point to be used for incremental scanning.</p>"""
    scan_mode: "capo_backup.types.scan_mode.ScanMode"
    """<p>Specifies the scan type use for the scan job.</p> <p>Includes:</p> <ul> <li> <p> <code>FULL_SCAN</code> will scan the entire data lineage within the backup.</p> </li> <li> <p> <code>INCREMENTAL_SCAN</code> will scan the data difference between the target recovery point and base recovery point ARN.</p> </li> </ul>"""
    scanner_role_arn: "str"
    """<p>Specified the IAM scanner role ARN.</p>"""

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

continuous_scan_end_time instance-attribute

continuous_scan_end_time: NotRequired[datetime]

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

iam_role_arn instance-attribute

iam_role_arn: str

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

idempotency_token instance-attribute

idempotency_token: NotRequired[str]

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.

malware_scanner instance-attribute

malware_scanner: MalwareScanner

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

recovery_point_arn instance-attribute

recovery_point_arn: str

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.

scan_base_recovery_point_arn instance-attribute

scan_base_recovery_point_arn: NotRequired[str]

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

scan_mode instance-attribute

scan_mode: ScanMode

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.

scanner_role_arn instance-attribute

scanner_role_arn: str

Specified the IAM scanner role ARN.