GuardDuty / Client / send_object_malware_scan

send_object_malware_scan

GuardDuty.Client.send_object_malware_scan(**kwargs)

Initiates a malware scan for a specific S3 object. This API allows you to perform on-demand malware scanning of individual objects in S3 buckets that have Malware Protection for S3 enabled.

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.

See also: AWS API Documentation

Request Syntax

response = client.send_object_malware_scan(
    S3Object={
        'Bucket': 'string',
        'Key': 'string',
        'VersionId': 'string'
    }
)
Parameters:

S3Object (dict) –

The S3 object information for the object you want to scan. The bucket must have a Malware Protection plan configured to use this API.

  • Bucket (string) –

    The name of the S3 bucket containing the object to scan. The bucket must have GuardDuty Malware Protection enabled.

  • Key (string) –

    The key (name) of the S3 object to scan for malware. This must be the full key path of the object within the bucket.

  • VersionId (string) –

    The version ID of the S3 object to scan. If not specified, the latest version of the object is scanned.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions