STARTAUDITMIGACTIONSTASK()`¶

About StartAuditMitigationActionsTask¶

Starts a task that applies a set of mitigation actions to the specified target.

Requires permission to access the StartAuditMitigationActionsTask action.

Method Signature¶

METHODS /AWS1/IF_IOT~STARTAUDITMIGACTIONSTASK
  IMPORTING
    !IV_TASKID TYPE /AWS1/IOTMIGACTIONSTASKID OPTIONAL
    !IO_TARGET TYPE REF TO /AWS1/CL_IOTAUDMIGACTSTASKTGT OPTIONAL
    !IT_AUDITCHECKTOACTSMAPPING TYPE /AWS1/CL_IOTMIGACTNAMELIST_W=>TT_AUDITCHECKTOACTIONSMAPPING OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/IOTCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotstrtaudmigacttsk01
  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`¶

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

`io_target` `TYPE REF TO /AWS1/CL_IOTAUDMIGACTSTASKTGT` `/AWS1/CL_IOTAUDMIGACTSTASKTGT`¶

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a specific set of findings.

`it_auditchecktoactsmapping` `TYPE /AWS1/CL_IOTMIGACTNAMELIST_W=>TT_AUDITCHECKTOACTIONSMAPPING` `TT_AUDITCHECKTOACTIONSMAPPING`¶

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your Amazon Web Services accounts.

`iv_clientrequesttoken` `TYPE /AWS1/IOTCLIENTREQUESTTOKEN` `/AWS1/IOTCLIENTREQUESTTOKEN`¶

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_iotstrtaudmigacttsk01` `/AWS1/CL_IOTSTRTAUDMIGACTTSK01`¶

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->startauditmigactionstask(
  io_target = new /aws1/cl_iotaudmigactstasktgt(
    it_auditchecktorcfilter = VALUE /aws1/cl_iotrsnfornoncplncco00=>tt_auditchecktorcfilter(
      (
        VALUE /aws1/cl_iotrsnfornoncplncco00=>ts_auditchecktorcfilter_maprow(
          key = |string|
          value = VALUE /aws1/cl_iotrsnfornoncplncco00=>tt_reasonfornoncompliancecodes(
            ( new /aws1/cl_iotrsnfornoncplncco00( |string| ) )
          )
        )
      )
    )
    it_findingids = VALUE /aws1/cl_iotfindingids_w=>tt_findingids(
      ( new /aws1/cl_iotfindingids_w( |string| ) )
    )
    iv_audittaskid = |string|
  )
  it_auditchecktoactsmapping = VALUE /aws1/cl_iotmigactnamelist_w=>tt_auditchecktoactionsmapping(
    (
      VALUE /aws1/cl_iotmigactnamelist_w=>ts_auditchecktoactsmap_maprow(
        key = |string|
        value = VALUE /aws1/cl_iotmigactnamelist_w=>tt_mitigationactionnamelist(
          ( new /aws1/cl_iotmigactnamelist_w( |string| ) )
        )
      )
    )
  )
  iv_clientrequesttoken = |string|
  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.

/AWS1/IF_IOT=>STARTAUDITMIGACTIONSTASK()¶