Skip to content

Scan

Source code in docs_src/capo_guardduty/types/scan.py
class Scan(TypedDict, closed=True):
    detector_id: NotRequired["capo_guardduty.types.detector_id.DetectorId"]
    """<p>The unique ID of the detector that is associated with the request.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    admin_detector_id: NotRequired["capo_guardduty.types.detector_id.DetectorId"]
    """<p>The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the <code>AdminDetectorId</code> will be the same as the one used for <code>DetectorId</code>.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>"""
    scan_id: NotRequired["capo_guardduty.types.non_empty_string.NonEmptyString"]
    """<p>The unique scan ID associated with a scan entry.</p>"""
    scan_status: NotRequired["capo_guardduty.types.scan_status.ScanStatus"]
    """<p>An enum value representing possible scan statuses.</p>"""
    failure_reason: NotRequired["capo_guardduty.types.non_empty_string.NonEmptyString"]
    """<p>Represents the reason for <code>FAILED</code> scan status.</p>"""
    scan_start_time: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp of when the scan was triggered.</p>"""
    scan_end_time: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp of when the scan was finished.</p>"""
    trigger_details: NotRequired["capo_guardduty.types.trigger_details.TriggerDetails"]
    """<p>Specifies the reason why the scan was initiated.</p>"""
    resource_details: NotRequired[
        "capo_guardduty.types.resource_details.ResourceDetails"
    ]
    """<p>Represents the resources that were scanned in the scan entry.</p>"""
    scan_result_details: NotRequired[
        "capo_guardduty.types.scan_result_details.ScanResultDetails"
    ]
    """<p>Represents the result of the scan.</p>"""
    account_id: NotRequired["capo_guardduty.types.account_id.AccountId"]
    """<p>The ID for the account that belongs to the scan.</p>"""
    total_bytes: NotRequired["capo_guardduty.types.positive_long.PositiveLong"]
    """<p>Represents total bytes that were scanned.</p>"""
    file_count: NotRequired["capo_guardduty.types.positive_long.PositiveLong"]
    """<p>Represents the number of files that were scanned.</p>"""
    attached_volumes: NotRequired["capo_guardduty.types.volume_details.VolumeDetails"]
    """<p>List of volumes that were attached to the original instance to be scanned.</p>"""
    scan_type: NotRequired["capo_guardduty.types.scan_type.ScanType"]
    """<p>Specifies the scan type that invoked the malware scan.</p>"""

account_id instance-attribute

account_id: NotRequired[AccountId]

The ID for the account that belongs to the scan.

admin_detector_id instance-attribute

admin_detector_id: NotRequired[DetectorId]

The unique detector ID of the administrator account that the request is associated with. If the account is an administrator, the AdminDetectorId will be the same as the one used for DetectorId.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

attached_volumes instance-attribute

attached_volumes: NotRequired[VolumeDetails]

List of volumes that were attached to the original instance to be scanned.

detector_id instance-attribute

detector_id: NotRequired[DetectorId]

The unique ID of the detector that is associated with the request.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

failure_reason instance-attribute

failure_reason: NotRequired[NonEmptyString]

Represents the reason for FAILED scan status.

file_count instance-attribute

file_count: NotRequired[PositiveLong]

Represents the number of files that were scanned.

resource_details instance-attribute

resource_details: NotRequired[ResourceDetails]

Represents the resources that were scanned in the scan entry.

scan_end_time instance-attribute

scan_end_time: NotRequired[Timestamp]

The timestamp of when the scan was finished.

scan_id instance-attribute

scan_id: NotRequired[NonEmptyString]

The unique scan ID associated with a scan entry.

scan_result_details instance-attribute

scan_result_details: NotRequired[ScanResultDetails]

Represents the result of the scan.

scan_start_time instance-attribute

scan_start_time: NotRequired[Timestamp]

The timestamp of when the scan was triggered.

scan_status instance-attribute

scan_status: NotRequired[ScanStatus]

An enum value representing possible scan statuses.

scan_type instance-attribute

scan_type: NotRequired[ScanType]

Specifies the scan type that invoked the malware scan.

total_bytes instance-attribute

total_bytes: NotRequired[PositiveLong]

Represents total bytes that were scanned.

trigger_details instance-attribute

trigger_details: NotRequired[TriggerDetails]

Specifies the reason why the scan was initiated.