CREATETASK()`¶

About CreateTask¶

Instructs one or more devices to start a task, such as unlocking or rebooting.

Method Signature¶

METHODS /AWS1/IF_SND~CREATETASK
  IMPORTING
    !IT_TARGETS TYPE /AWS1/CL_SNDTARGETLIST_W=>TT_TARGETLIST OPTIONAL
    !IO_COMMAND TYPE REF TO /AWS1/CL_SNDCOMMAND OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/SNDTASKDESCRIPTIONSTRING OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_SNDTAGMAP_W=>TT_TAGMAP OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/SNDIDEMPOTENCYTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sndcreatetaskoutput
  RAISING
    /AWS1/CX_SNDACCESSDENIEDEX
    /AWS1/CX_SNDINTERNALSERVEREX
    /AWS1/CX_SNDRESOURCENOTFOUNDEX
    /AWS1/CX_SNDSERVICEQUOTAEXCDEX
    /AWS1/CX_SNDTHROTTLINGEX
    /AWS1/CX_SNDVALIDATIONEX
    /AWS1/CX_SNDCLIENTEXC
    /AWS1/CX_SNDSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`it_targets` `TYPE /AWS1/CL_SNDTARGETLIST_W=>TT_TARGETLIST` `TT_TARGETLIST`¶

A list of managed device IDs.

`io_command` `TYPE REF TO /AWS1/CL_SNDCOMMAND` `/AWS1/CL_SNDCOMMAND`¶

The task to be performed. Only one task is executed on a device at a time.

Optional arguments:¶

`iv_description` `TYPE /AWS1/SNDTASKDESCRIPTIONSTRING` `/AWS1/SNDTASKDESCRIPTIONSTRING`¶

A description of the task and its targets.

`it_tags` `TYPE /AWS1/CL_SNDTAGMAP_W=>TT_TAGMAP` `TT_TAGMAP`¶

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

`iv_clienttoken` `TYPE /AWS1/SNDIDEMPOTENCYTOKEN` `/AWS1/SNDIDEMPOTENCYTOKEN`¶

A token ensuring that the action is called only once with the specified details.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_sndcreatetaskoutput` `/AWS1/CL_SNDCREATETASKOUTPUT`¶

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->createtask(
  io_command = new /aws1/cl_sndcommand(
    io_reboot = new /aws1/cl_sndreboot( )
    io_unlock = new /aws1/cl_sndunlock( )
  )
  it_tags = VALUE /aws1/cl_sndtagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_sndtagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_sndtagmap_w( |string| )
        key = |string|
      )
    )
  )
  it_targets = VALUE /aws1/cl_sndtargetlist_w=>tt_targetlist(
    ( new /aws1/cl_sndtargetlist_w( |string| ) )
  )
  iv_clienttoken = |string|
  iv_description = |string|
).

This is an example of reading all possible response values

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

/AWS1/IF_SND=>CREATETASK()¶