Skip to content

send_object_malware_scan

Operation

send_object_malware_scan

send_object_malware_scan(request: SendObjectMalwareScanInput | SendObjectMalwareScanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendObjectMalwareScanInputDict]) -> SendObjectMalwareScanOutput

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.

Parameters:

Name Type Description Default
request SendObjectMalwareScanInput | SendObjectMalwareScanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[SendObjectMalwareScanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SendObjectMalwareScanOutput

An instance of SendObjectMalwareScanOutput.

send_object_malware_scan async

send_object_malware_scan(request: SendObjectMalwareScanInput | SendObjectMalwareScanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendObjectMalwareScanInputDict]) -> SendObjectMalwareScanOutput

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.

Parameters:

Name Type Description Default
request SendObjectMalwareScanInput | SendObjectMalwareScanInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[SendObjectMalwareScanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SendObjectMalwareScanOutput

An instance of SendObjectMalwareScanOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

SendObjectMalwareScanInputDict

Bases: TypedDict

Dictionary form of SendObjectMalwareScanInput.

Attributes

s3_object instance-attribute

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

SendObjectMalwareScanInput dataclass

Bases: _SerdeShape

Dataclass for SendObjectMalwareScanInput structure.

Attributes

s3_object class-attribute instance-attribute
s3_object: S3ObjectForSendObjectMalwareScan | None = ...

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

Output

SendObjectMalwareScanOutput dataclass

Bases: _SerdeShape

Dataclass for SendObjectMalwareScanOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.