Skip to content

Guardduty  >  Operations  >  start_malware_scan

start_malware_scan

Operation

start_malware_scan async 

start_malware_scan(input: StartMalwareScanInput, plugins: list[Plugin] | None = None) -> StartMalwareScanOutput

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account if the resourceArn belongs to an EC2 instance.

When the malware scan starts, you can use the associated scan ID to track the status of the scan. For more information, see ListMalwareScans and GetMalwareScan.

When you use this API, the Amazon Web Services service terms for GuardDuty Malware Protection apply. For more information, see Amazon Web Services service terms for GuardDuty Malware Protection.

Parameters:

Name Type Description Default
input StartMalwareScanInput

An instance of StartMalwareScanInput.

 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
StartMalwareScanOutput

An instance of StartMalwareScanOutput.

Input

StartMalwareScanInput dataclass

Dataclass for StartMalwareScanInput structure.

Attributes

client_token class-attribute instance-attribute 
client_token: str | None = None

The idempotency token for the create request.

resource_arn class-attribute instance-attribute 
resource_arn: str | None = None

Amazon Resource Name (ARN) of the resource for which you invoked the API.

scan_configuration class-attribute instance-attribute 
scan_configuration: StartMalwareScanConfiguration | None = None

Contains information about the configuration to be used for the malware scan.

Output

StartMalwareScanOutput dataclass

Dataclass for StartMalwareScanOutput 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.