Skip to content

GetMalwareScanResponse

Source code in docs_src/capo_guardduty/types/get_malware_scan_response.py
class GetMalwareScanResponse(TypedDict, closed=True):
    scan_id: NotRequired["capo_guardduty.types.non_empty_string.NonEmptyString"]
    """<p>A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.</p>"""
    detector_id: NotRequired["capo_guardduty.types.detector_id.DetectorId"]
    """<p>The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.</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. If the customer is not a GuardDuty customer, this field will not be present.</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>"""
    resource_arn: NotRequired["capo_guardduty.types.non_empty_string.NonEmptyString"]
    """<p>Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.</p>"""
    resource_type: NotRequired[
        "capo_guardduty.types.malware_protection_resource_type.MalwareProtectionResourceType"
    ]
    """<p>The type of resource that was scanned for malware.</p>"""
    scanned_resources_count: NotRequired[
        "capo_guardduty.types.non_negative_integer.NonNegativeInteger"
    ]
    """<p>The total number of resources that were successfully scanned. This is dependent on the resource type.</p>"""
    skipped_resources_count: NotRequired[
        "capo_guardduty.types.non_negative_integer.NonNegativeInteger"
    ]
    """<p>The total number of resources that were skipped during the scan.</p>"""
    failed_resources_count: NotRequired[
        "capo_guardduty.types.non_negative_integer.NonNegativeInteger"
    ]
    """<p>The total number of resources that failed to be scanned.</p>"""
    scanned_resources: NotRequired[
        "capo_guardduty.types.scanned_resources.ScannedResources"
    ]
    """<p>A list of resources along with their metadata that were scanned as part of the malware scan operation.</p>"""
    scan_configuration: NotRequired[
        "capo_guardduty.types.scan_configuration.ScanConfiguration"
    ]
    """<p>Information about the scan configuration used for the malware scan.</p>"""
    scan_category: NotRequired["capo_guardduty.types.scan_category.ScanCategory"]
    """<p>The category of the malware scan, indicating the type of scan performed.</p>"""
    scan_status: NotRequired[
        "capo_guardduty.types.malware_protection_scan_status.MalwareProtectionScanStatus"
    ]
    """<p>A value representing the current status of the malware scan.</p>"""
    scan_status_reason: NotRequired[
        "capo_guardduty.types.scan_status_reason.ScanStatusReason"
    ]
    """<p>Represents the reason for the current scan status, if applicable.</p>"""
    scan_type: NotRequired[
        "capo_guardduty.types.malware_protection_scan_type.MalwareProtectionScanType"
    ]
    """<p>A value representing the initiator of the scan.</p>"""
    scan_started_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp representing when the malware scan was started.</p>"""
    scan_completed_at: NotRequired["capo_guardduty.types.timestamp.Timestamp"]
    """<p>The timestamp representing when the malware scan was completed.</p>"""
    scan_result_details: NotRequired[
        "capo_guardduty.types.get_malware_scan_result_details.GetMalwareScanResultDetails"
    ]
    """<p>Detailed information about the results of the malware scan, if the scan completed.</p>"""

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. If the customer is not a GuardDuty customer, this field will not be present..

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

detector_id instance-attribute

detector_id: NotRequired[DetectorId]

The unique ID of the detector that is associated with the request, if it belongs to an account which is a GuardDuty customer.

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

failed_resources_count instance-attribute

failed_resources_count: NotRequired[NonNegativeInteger]

The total number of resources that failed to be scanned.

resource_arn instance-attribute

resource_arn: NotRequired[NonEmptyString]

Amazon Resource Name (ARN) of the resource on which a malware scan was invoked.

resource_type instance-attribute

resource_type: NotRequired[MalwareProtectionResourceType]

The type of resource that was scanned for malware.

scan_category instance-attribute

scan_category: NotRequired[ScanCategory]

The category of the malware scan, indicating the type of scan performed.

scan_completed_at instance-attribute

scan_completed_at: NotRequired[Timestamp]

The timestamp representing when the malware scan was completed.

scan_configuration instance-attribute

scan_configuration: NotRequired[ScanConfiguration]

Information about the scan configuration used for the malware scan.

scan_id instance-attribute

scan_id: NotRequired[NonEmptyString]

A unique identifier associated with the malware scan. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

scan_result_details instance-attribute

scan_result_details: NotRequired[GetMalwareScanResultDetails]

Detailed information about the results of the malware scan, if the scan completed.

scan_started_at instance-attribute

scan_started_at: NotRequired[Timestamp]

The timestamp representing when the malware scan was started.

scan_status instance-attribute

scan_status: NotRequired[MalwareProtectionScanStatus]

A value representing the current status of the malware scan.

scan_status_reason instance-attribute

scan_status_reason: NotRequired[ScanStatusReason]

Represents the reason for the current scan status, if applicable.

scan_type instance-attribute

scan_type: NotRequired[MalwareProtectionScanType]

A value representing the initiator of the scan.

scanned_resources instance-attribute

scanned_resources: NotRequired[ScannedResources]

A list of resources along with their metadata that were scanned as part of the malware scan operation.

scanned_resources_count instance-attribute

scanned_resources_count: NotRequired[NonNegativeInteger]

The total number of resources that were successfully scanned. This is dependent on the resource type.

skipped_resources_count instance-attribute

skipped_resources_count: NotRequired[NonNegativeInteger]

The total number of resources that were skipped during the scan.