Skip to content

ScanJobSummary

Source code in docs_src/capo_backup/types/scan_job_summary.py
class ScanJobSummary(TypedDict, closed=True):
    region: NotRequired["capo_backup.types.region.Region"]
    """<p>The Amazon Web Services Region where the scan jobs were executed.</p>"""
    account_id: NotRequired["capo_backup.types.account_id.AccountId"]
    """<p>The account ID that owns the scan jobs included in this summary.</p>"""
    state: NotRequired["capo_backup.types.scan_job_status.ScanJobStatus"]
    """<p>The state of the scan jobs included in this summary.</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>"""
    resource_type: NotRequired["capo_backup.types.resource_type.ResourceType"]
    """<p>The type of Amazon Web Services resource for the scan jobs included in this summary.</p>"""
    count: "capo_backup.types.integer.integer"
    """<p>The number of scan jobs that match the specified criteria.</p>"""
    start_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The value of time in number format of a job start time.</p> <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    end_time: NotRequired["capo_backup.types.timestamp.timestamp"]
    """<p>The value of time in number format of a job end time.</p> <p>This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"""
    malware_scanner: NotRequired["capo_backup.types.malware_scanner.MalwareScanner"]
    """<p>Specifies the malware scanner used during the scan job. Currently only supports <code>GUARDDUTY</code>.</p>"""
    scan_result_status: NotRequired[
        "capo_backup.types.scan_result_status.ScanResultStatus"
    ]
    """<p>The scan result status for the scan jobs included in this summary.</p> <p>Valid values: <code>THREATS_FOUND</code> | <code>NO_THREATS_FOUND</code>.</p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The account ID that owns the scan jobs included in this summary.

count instance-attribute

count: integer

The number of scan jobs that match the specified criteria.

end_time instance-attribute

end_time: NotRequired[timestamp]

The value of time in number format of a job end time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

malware_scanner instance-attribute

malware_scanner: NotRequired[MalwareScanner]

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

region instance-attribute

region: NotRequired[Region]

The Amazon Web Services Region where the scan jobs were executed.

resource_type instance-attribute

resource_type: NotRequired[ResourceType]

The type of Amazon Web Services resource for the scan jobs included in this summary.

scan_result_status instance-attribute

scan_result_status: NotRequired[ScanResultStatus]

The scan result status for the scan jobs included in this summary.

Valid values: THREATS_FOUND | NO_THREATS_FOUND.

start_time instance-attribute

start_time: NotRequired[timestamp]

The value of time in number format of a job start time.

This value is the time in Unix format, Coordinated Universal Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

state instance-attribute

state: NotRequired[ScanJobStatus]

The state of the scan jobs included in this summary.

Valid values: CREATED | RUNNING | COMPLETED | COMPLETED_WITH_ISSUES | FAILED | CANCELED.