GuardDuty / Client / start_malware_scan

start_malware_scan#

GuardDuty.Client.start_malware_scan(**kwargs)#

Initiates the malware scan. Invoking this API will automatically create the Service-linked role in the corresponding account.

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

See also: AWS API Documentation

Request Syntax

response = client.start_malware_scan(
    ResourceArn='string'
)
Parameters:

ResourceArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ScanId': 'string'
}

Response Structure

  • (dict) –

    • ScanId (string) –

      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.

Exceptions