STARTMALWARESCAN()`¶

About StartMalwareScan¶

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.

Method Signature¶

METHODS /AWS1/IF_GDY~STARTMALWARESCAN
  IMPORTING
    !IV_RESOURCEARN TYPE /AWS1/GDYRESOURCEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/GDYCLIENTTOKEN OPTIONAL
    !IO_SCANCONFIGURATION TYPE REF TO /AWS1/CL_GDYSTRTMALWARESCANC00 OPTIONAL
  PREFERRED PARAMETER iv_resourcearn
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gdystrtmalwarescanrsp
  RAISING
    /AWS1/CX_GDYBADREQUESTEX
    /AWS1/CX_GDYCONFLICTEXCEPTION
    /AWS1/CX_GDYINTERNALSERVERER00
    /AWS1/CX_GDYCLIENTEXC
    /AWS1/CX_GDYSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_resourcearn` `TYPE /AWS1/GDYRESOURCEARN` `/AWS1/GDYRESOURCEARN`¶

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

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/GDYCLIENTTOKEN` `/AWS1/GDYCLIENTTOKEN`¶

The idempotency token for the create request.

`io_scanconfiguration` `TYPE REF TO /AWS1/CL_GDYSTRTMALWARESCANC00` `/AWS1/CL_GDYSTRTMALWARESCANC00`¶

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

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gdystrtmalwarescanrsp` `/AWS1/CL_GDYSTRTMALWARESCANRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->startmalwarescan(
  io_scanconfiguration = new /aws1/cl_gdystrtmalwarescanc00(
    io_incrementalscandetails = new /aws1/cl_gdyincrementalscand00( |string| )
    io_recoverypoint = new /aws1/cl_gdyrecoverypoint( |string| )
    iv_role = |string|
  )
  iv_clienttoken = |string|
  iv_resourcearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nonemptystring = lo_result->get_scanid( ).
ENDIF.

/AWS1/IF_GDY=>STARTMALWARESCAN()¶