/AWS1/IF_IOW=>STRTSINGLEWIRELESSDEVIMPTASK()

About StartSingleWirelessDeviceImportTask

Start import task for a single wireless device.

Method Signature

METHODS /AWS1/IF_IOW~STRTSINGLEWIRELESSDEVIMPTASK
  IMPORTING
    !IV_DESTINATIONNAME TYPE /AWS1/IOWDESTINATIONNAME OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/IOWCLIENTREQUESTTOKEN OPTIONAL
    !IV_DEVICENAME TYPE /AWS1/IOWDEVICENAME OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOWTAG=>TT_TAGLIST OPTIONAL
    !IV_POSITIONING TYPE /AWS1/IOWPOSITIONINGCFGSTATUS OPTIONAL
    !IO_SIDEWALK TYPE REF TO /AWS1/CL_IOWSIDEWALKSINGLEST00 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iowstrtsinglewirele01
  RAISING
    /AWS1/CX_IOWACCESSDENIEDEX
    /AWS1/CX_IOWCONFLICTEXCEPTION
    /AWS1/CX_IOWINTERNALSERVEREX
    /AWS1/CX_IOWRESOURCENOTFOUNDEX
    /AWS1/CX_IOWTHROTTLINGEX
    /AWS1/CX_IOWVALIDATIONEX
    /AWS1/CX_IOWCLIENTEXC
    /AWS1/CX_IOWSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_destinationname TYPE /AWS1/IOWDESTINATIONNAME /AWS1/IOWDESTINATIONNAME

The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

io_sidewalk TYPE REF TO /AWS1/CL_IOWSIDEWALKSINGLEST00 /AWS1/CL_IOWSIDEWALKSINGLEST00

The Sidewalk-related parameters for importing a single wireless device.

Optional arguments:

iv_clientrequesttoken TYPE /AWS1/IOWCLIENTREQUESTTOKEN /AWS1/IOWCLIENTREQUESTTOKEN

Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

iv_devicename TYPE /AWS1/IOWDEVICENAME /AWS1/IOWDEVICENAME

The name of the wireless device for which an import task is being started.

it_tags TYPE /AWS1/CL_IOWTAG=>TT_TAGLIST TT_TAGLIST

The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

iv_positioning TYPE /AWS1/IOWPOSITIONINGCFGSTATUS /AWS1/IOWPOSITIONINGCFGSTATUS

The integration status of the Device Location feature for Sidewalk devices.

RETURNING

oo_output TYPE REF TO /aws1/cl_iowstrtsinglewirele01 /AWS1/CL_IOWSTRTSINGLEWIRELE01

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->strtsinglewirelessdevimptask(
  io_sidewalk = new /aws1/cl_iowsidewalksinglest00(
    io_positioning = new /aws1/cl_iowsidewalkposition00( |string| )
    iv_sidewalkmanufacturingsn = |string|
  )
  it_tags = VALUE /aws1/cl_iowtag=>tt_taglist(
    (
      new /aws1/cl_iowtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_destinationname = |string|
  iv_devicename = |string|
  iv_positioning = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_importtaskid = lo_result->get_id( ).
  lv_importtaskarn = lo_result->get_arn( ).
ENDIF.