/AWS1/IF_IOT=>STARTDETECTMIGACTIONSTASK()

About StartDetectMitigationActionsTask

Starts a Device Defender ML Detect mitigation actions task.

Requires permission to access the StartDetectMitigationActionsTask action.

Method Signature

METHODS /AWS1/IF_IOT~STARTDETECTMIGACTIONSTASK
  IMPORTING
    !IV_TASKID TYPE /AWS1/IOTMIGACTIONSTASKID OPTIONAL
    !IO_TARGET TYPE REF TO /AWS1/CL_IOTDETECTMIGACTTSKTGT OPTIONAL
    !IT_ACTIONS TYPE /AWS1/CL_IOTDETECTMIGACTTOEX00=>TT_DETECTMIGACTSTOEXECUTELIST OPTIONAL
    !IO_VIOEVENTOCCURRENCERANGE TYPE REF TO /AWS1/CL_IOTVIOEVTOCCURRENCE00 OPTIONAL
    !IV_INCLUDEONLYACTIVEVIOS TYPE /AWS1/IOTNULLABLEBOOLEAN OPTIONAL
    !IV_INCLUDESUPPRESSEDALERTS TYPE /AWS1/IOTNULLABLEBOOLEAN OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/IOTCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotstrtdetectmigact01
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTTASKALRDYEXISTSEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_taskid TYPE /AWS1/IOTMIGACTIONSTASKID /AWS1/IOTMIGACTIONSTASKID

The unique identifier of the task.

io_target TYPE REF TO /AWS1/CL_IOTDETECTMIGACTTSKTGT /AWS1/CL_IOTDETECTMIGACTTSKTGT

Specifies the ML Detect findings to which the mitigation actions are applied.

it_actions TYPE /AWS1/CL_IOTDETECTMIGACTTOEX00=>TT_DETECTMIGACTSTOEXECUTELIST TT_DETECTMIGACTSTOEXECUTELIST

The actions to be performed when a device has unexpected behavior.

iv_clientrequesttoken TYPE /AWS1/IOTCLIENTREQUESTTOKEN /AWS1/IOTCLIENTREQUESTTOKEN

Each mitigation action task must have a unique client request token. If you try to create a new task with the same token as a task that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

Optional arguments:

io_vioeventoccurrencerange TYPE REF TO /AWS1/CL_IOTVIOEVTOCCURRENCE00 /AWS1/CL_IOTVIOEVTOCCURRENCE00

Specifies the time period of which violation events occurred between.

iv_includeonlyactivevios TYPE /AWS1/IOTNULLABLEBOOLEAN /AWS1/IOTNULLABLEBOOLEAN

Specifies to list only active violations.

iv_includesuppressedalerts TYPE /AWS1/IOTNULLABLEBOOLEAN /AWS1/IOTNULLABLEBOOLEAN

Specifies to include suppressed alerts.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotstrtdetectmigact01 /AWS1/CL_IOTSTRTDETECTMIGACT01

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->startdetectmigactionstask(
  io_target = new /aws1/cl_iotdetectmigacttsktgt(
    it_violationids = VALUE /aws1/cl_iottgtvioidsfordete00=>tt_tgtvioidsfordetectmigacts(
      ( new /aws1/cl_iottgtvioidsfordete00( |string| ) )
    )
    iv_behaviorname = |string|
    iv_securityprofilename = |string|
  )
  io_vioeventoccurrencerange = new /aws1/cl_iotvioevtoccurrence00(
    iv_endtime = '20150101000000.0000000'
    iv_starttime = '20150101000000.0000000'
  )
  it_actions = VALUE /aws1/cl_iotdetectmigacttoex00=>tt_detectmigactstoexecutelist(
    ( new /aws1/cl_iotdetectmigacttoex00( |string| ) )
  )
  iv_clientrequesttoken = |string|
  iv_includeonlyactivevios = ABAP_TRUE
  iv_includesuppressedalerts = ABAP_TRUE
  iv_taskid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_mitigationactionstaskid = lo_result->get_taskid( ).
ENDIF.