Guardduty  >  Operations  >  get_malware_scan

get_malware_scan

Operation

get_malware_scan async

get_malware_scan(input: GetMalwareScanInput, plugins: list[Plugin] | None = None) -> GetMalwareScanOutput

Retrieves the detailed information for a specific malware scan. Each member account can view the malware scan details for their own account. An administrator can view malware scan details for all accounts in the organization.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

Parameters:

Name	Type	Description	Default
input	GetMalwareScanInput	An instance of GetMalwareScanInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
GetMalwareScanOutput	An instance of GetMalwareScanOutput.

Input

GetMalwareScanInput dataclass

Dataclass for GetMalwareScanInput structure.

Attributes

scan_id class-attribute instance-attribute

scan_id: str | None = None

A unique identifier that gets generated when you invoke the API without any error. Each malware scan has a corresponding scan ID. Using this scan ID, you can monitor the status of your malware scan.

Output

GetMalwareScanOutput dataclass

Dataclass for GetMalwareScanOutput structure.

Attributes

admin_detector_id class-attribute instance-attribute

admin_detector_id: str | None = None

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 class-attribute instance-attribute

detector_id: str | None = None

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 class-attribute instance-attribute

failed_resources_count: int | None = None

The total number of resources that failed to be scanned.

resource_arn class-attribute instance-attribute

resource_arn: str | None = None

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

resource_type class-attribute instance-attribute

resource_type: MalwareProtectionResourceType | None = None

The type of resource that was scanned for malware.

scan_category class-attribute instance-attribute

scan_category: ScanCategory | None = None

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

scan_completed_at class-attribute instance-attribute

scan_completed_at: datetime | None = None

The timestamp representing when the malware scan was completed.

scan_configuration class-attribute instance-attribute

scan_configuration: ScanConfiguration | None = None

Information about the scan configuration used for the malware scan.

scan_id class-attribute instance-attribute

scan_id: str | None = None

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 class-attribute instance-attribute

scan_result_details: GetMalwareScanResultDetails | None = None

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

scan_started_at class-attribute instance-attribute

scan_started_at: datetime | None = None

The timestamp representing when the malware scan was started.

scan_status class-attribute instance-attribute

scan_status: MalwareProtectionScanStatus | None = None

A value representing the current status of the malware scan.

scan_status_reason class-attribute instance-attribute

scan_status_reason: ScanStatusReason | None = None

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

scan_type class-attribute instance-attribute

scan_type: MalwareProtectionScanType | None = None

A value representing the initiator of the scan.

scanned_resources class-attribute instance-attribute

scanned_resources: list[ScannedResource] | None = None

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

scanned_resources_count class-attribute instance-attribute

scanned_resources_count: int | None = None

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

skipped_resources_count class-attribute instance-attribute

skipped_resources_count: int | None = None

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