Skip to content

/AWS1/IF_IOT=>CREATEOTAUPDATE()

About CreateOTAUpdate

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

Method Signature

METHODS /AWS1/IF_IOT~CREATEOTAUPDATE
  IMPORTING
    !IV_OTAUPDATEID TYPE /AWS1/IOTOTAUPDATEID OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOTOTAUPDATEDESCRIPTION OPTIONAL
    !IT_TARGETS TYPE /AWS1/CL_IOTTARGETS_W=>TT_TARGETS OPTIONAL
    !IT_PROTOCOLS TYPE /AWS1/CL_IOTPROTOCOLS_W=>TT_PROTOCOLS OPTIONAL
    !IV_TARGETSELECTION TYPE /AWS1/IOTTARGETSELECTION OPTIONAL
    !IO_AWSJOBEXECSROLLOUTCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBEXESRLTCFG OPTIONAL
    !IO_AWSJOBPRESIGNEDURLCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBPRESIGURLCFG OPTIONAL
    !IO_AWSJOBABORTCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBABORTCONFIG OPTIONAL
    !IO_AWSJOBTIMEOUTCONFIG TYPE REF TO /AWS1/CL_IOTAWSJOBTMOUTCONFIG OPTIONAL
    !IT_FILES TYPE /AWS1/CL_IOTOTAUPDATEFILE=>TT_OTAUPDATEFILES OPTIONAL
    !IV_ROLEARN TYPE /AWS1/IOTROLEARN OPTIONAL
    !IT_ADDITIONALPARAMETERS TYPE /AWS1/CL_IOTADDLPARAMETERMAP_W=>TT_ADDITIONALPARAMETERMAP OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotcreateotaupdatersp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTRESRCALRDYEXISTSEX
    /AWS1/CX_IOTRESOURCENOTFOUNDEX
    /AWS1/CX_IOTSERVICEUNAVAILEX
    /AWS1/CX_IOTTHROTTLINGEX
    /AWS1/CX_IOTUNAUTHORIZEDEX
    /AWS1/CX_IOTCLIENTEXC
    /AWS1/CX_IOTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_otaupdateid TYPE /AWS1/IOTOTAUPDATEID /AWS1/IOTOTAUPDATEID

The ID of the OTA update to be created.

it_targets TYPE /AWS1/CL_IOTTARGETS_W=>TT_TARGETS TT_TARGETS

The devices targeted to receive OTA updates.

it_files TYPE /AWS1/CL_IOTOTAUPDATEFILE=>TT_OTAUPDATEFILES TT_OTAUPDATEFILES

The files to be streamed by the OTA update.

iv_rolearn TYPE /AWS1/IOTROLEARN /AWS1/IOTROLEARN

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

Optional arguments:

iv_description TYPE /AWS1/IOTOTAUPDATEDESCRIPTION /AWS1/IOTOTAUPDATEDESCRIPTION

The description of the OTA update.

it_protocols TYPE /AWS1/CL_IOTPROTOCOLS_W=>TT_PROTOCOLS TT_PROTOCOLS

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

iv_targetselection TYPE /AWS1/IOTTARGETSELECTION /AWS1/IOTTARGETSELECTION

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

io_awsjobexecsrolloutconfig TYPE REF TO /AWS1/CL_IOTAWSJOBEXESRLTCFG /AWS1/CL_IOTAWSJOBEXESRLTCFG

Configuration for the rollout of OTA updates.

io_awsjobpresignedurlconfig TYPE REF TO /AWS1/CL_IOTAWSJOBPRESIGURLCFG /AWS1/CL_IOTAWSJOBPRESIGURLCFG

Configuration information for pre-signed URLs.

io_awsjobabortconfig TYPE REF TO /AWS1/CL_IOTAWSJOBABORTCONFIG /AWS1/CL_IOTAWSJOBABORTCONFIG

The criteria that determine when and how a job abort takes place.

io_awsjobtimeoutconfig TYPE REF TO /AWS1/CL_IOTAWSJOBTMOUTCONFIG /AWS1/CL_IOTAWSJOBTMOUTCONFIG

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

it_additionalparameters TYPE /AWS1/CL_IOTADDLPARAMETERMAP_W=>TT_ADDITIONALPARAMETERMAP TT_ADDITIONALPARAMETERMAP

A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.

it_tags TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata which can be used to manage updates.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotcreateotaupdatersp /AWS1/CL_IOTCREATEOTAUPDATERSP

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->createotaupdate(
  io_awsjobabortconfig = new /aws1/cl_iotawsjobabortconfig(
    it_abortcriterialist = VALUE /aws1/cl_iotawsjobabortcrit=>tt_awsjobabortcriterialist(
      (
        new /aws1/cl_iotawsjobabortcrit(
          iv_action = |string|
          iv_failuretype = |string|
          iv_minnumberofexecutedthings = 123
          iv_thresholdpercentage = '0.1'
        )
      )
    )
  )
  io_awsjobexecsrolloutconfig = new /aws1/cl_iotawsjobexesrltcfg(
    io_exponentialrate = new /aws1/cl_iotawsjobexprloutrate(
      io_rateincreasecriteria = new /aws1/cl_iotawsjobrateinccrit(
        iv_numberofnotifiedthings = 123
        iv_numberofsucceededthings = 123
      )
      iv_baserateperminute = 123
      iv_incrementfactor = '0.1'
    )
    iv_maximumperminute = 123
  )
  io_awsjobpresignedurlconfig = new /aws1/cl_iotawsjobpresigurlcfg( 123 )
  io_awsjobtimeoutconfig = new /aws1/cl_iotawsjobtmoutconfig( 123 )
  it_additionalparameters = VALUE /aws1/cl_iotaddlparametermap_w=>tt_additionalparametermap(
    (
      VALUE /aws1/cl_iotaddlparametermap_w=>ts_addlparametermap_maprow(
        value = new /aws1/cl_iotaddlparametermap_w( |string| )
        key = |string|
      )
    )
  )
  it_files = VALUE /aws1/cl_iototaupdatefile=>tt_otaupdatefiles(
    (
      new /aws1/cl_iototaupdatefile(
        io_codesigning = new /aws1/cl_iotcodesigning(
          io_customcodesigning = new /aws1/cl_iotcustomcodesigning(
            io_certificatechain = new /aws1/cl_iotcodesigningcrtch00(
              iv_certificatename = |string|
              iv_inlinedocument = |string|
            )
            io_signature = new /aws1/cl_iotcodesigningsig( '5347567362473873563239796247513D' )
            iv_hashalgorithm = |string|
            iv_signaturealgorithm = |string|
          )
          io_startsigningjobparameter = new /aws1/cl_iotstrtsigningjobparm(
            io_destination = new /aws1/cl_iotdestination(
              io_s3destination = new /aws1/cl_iots3destination(
                iv_bucket = |string|
                iv_prefix = |string|
              )
            )
            io_signingprofileparameter = new /aws1/cl_iotsigningpflparam(
              iv_certificatearn = |string|
              iv_certificatepathondevice = |string|
              iv_platform = |string|
            )
            iv_signingprofilename = |string|
          )
          iv_awssignerjobid = |string|
        )
        io_filelocation = new /aws1/cl_iotfilelocation(
          io_s3location = new /aws1/cl_iots3location(
            iv_bucket = |string|
            iv_key = |string|
            iv_version = |string|
          )
          io_stream = new /aws1/cl_iotstream(
            iv_fileid = 123
            iv_streamid = |string|
          )
        )
        it_attributes = VALUE /aws1/cl_iotattributesmap_w=>tt_attributesmap(
          (
            VALUE /aws1/cl_iotattributesmap_w=>ts_attributesmap_maprow(
              key = |string|
              value = new /aws1/cl_iotattributesmap_w( |string| )
            )
          )
        )
        iv_filename = |string|
        iv_filetype = 123
        iv_fileversion = |string|
      )
    )
  )
  it_protocols = VALUE /aws1/cl_iotprotocols_w=>tt_protocols(
    ( new /aws1/cl_iotprotocols_w( |string| ) )
  )
  it_tags = VALUE /aws1/cl_iottag=>tt_taglist(
    (
      new /aws1/cl_iottag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_targets = VALUE /aws1/cl_iottargets_w=>tt_targets(
    ( new /aws1/cl_iottargets_w( |string| ) )
  )
  iv_description = |string|
  iv_otaupdateid = |string|
  iv_rolearn = |string|
  iv_targetselection = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_otaupdateid = lo_result->get_otaupdateid( ).
  lv_awsiotjobid = lo_result->get_awsiotjobid( ).
  lv_otaupdatearn = lo_result->get_otaupdatearn( ).
  lv_awsiotjobarn = lo_result->get_awsiotjobarn( ).
  lv_otaupdatestatus = lo_result->get_otaupdatestatus( ).
ENDIF.