Skip to content

/AWS1/IF_IOT=>CREATEPROVISIONINGTEMPLATE()

About CreateProvisioningTemplate

Creates a provisioning template.

Requires permission to access the CreateProvisioningTemplate action.

Method Signature

METHODS /AWS1/IF_IOT~CREATEPROVISIONINGTEMPLATE
  IMPORTING
    !IV_TEMPLATENAME TYPE /AWS1/IOTTEMPLATENAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOTTEMPLATEDESCRIPTION OPTIONAL
    !IV_TEMPLATEBODY TYPE /AWS1/IOTTEMPLATEBODY OPTIONAL
    !IV_ENABLED TYPE /AWS1/IOTENABLED2 OPTIONAL
    !IV_PROVISIONINGROLEARN TYPE /AWS1/IOTROLEARN OPTIONAL
    !IO_PREPROVISIONINGHOOK TYPE REF TO /AWS1/CL_IOTPROVISIONINGHOOK OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST OPTIONAL
    !IV_TYPE TYPE /AWS1/IOTTEMPLATETYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iotcreateprovtmplrsp
  RAISING
    /AWS1/CX_IOTINTERNALFAILUREEX
    /AWS1/CX_IOTINVALIDREQUESTEX
    /AWS1/CX_IOTLIMITEXCEEDEDEX
    /AWS1/CX_IOTRESRCALRDYEXISTSEX
    /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_templatename TYPE /AWS1/IOTTEMPLATENAME /AWS1/IOTTEMPLATENAME

The name of the provisioning template.

iv_templatebody TYPE /AWS1/IOTTEMPLATEBODY /AWS1/IOTTEMPLATEBODY

The JSON formatted contents of the provisioning template.

iv_provisioningrolearn TYPE /AWS1/IOTROLEARN /AWS1/IOTROLEARN

The role ARN for the role associated with the provisioning template. This IoT role grants permission to provision a device.

Optional arguments:

iv_description TYPE /AWS1/IOTTEMPLATEDESCRIPTION /AWS1/IOTTEMPLATEDESCRIPTION

The description of the provisioning template.

iv_enabled TYPE /AWS1/IOTENABLED2 /AWS1/IOTENABLED2

True to enable the provisioning template, otherwise false.

io_preprovisioninghook TYPE REF TO /AWS1/CL_IOTPROVISIONINGHOOK /AWS1/CL_IOTPROVISIONINGHOOK

Creates a pre-provisioning hook template. Only supports template of type FLEET_PROVISIONING. For more information about provisioning template types, see type.

it_tags TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata which can be used to manage the provisioning template.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

iv_type TYPE /AWS1/IOTTEMPLATETYPE /AWS1/IOTTEMPLATETYPE

The type you define in a provisioning template. You can create a template with only one type. You can't change the template type after its creation. The default value is FLEET_PROVISIONING. For more information about provisioning template, see: Provisioning template.

RETURNING

oo_output TYPE REF TO /aws1/cl_iotcreateprovtmplrsp /AWS1/CL_IOTCREATEPROVTMPLRSP

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->createprovisioningtemplate(
  io_preprovisioninghook = new /aws1/cl_iotprovisioninghook(
    iv_payloadversion = |string|
    iv_targetarn = |string|
  )
  it_tags = VALUE /aws1/cl_iottag=>tt_taglist(
    (
      new /aws1/cl_iottag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_description = |string|
  iv_enabled = ABAP_TRUE
  iv_provisioningrolearn = |string|
  iv_templatebody = |string|
  iv_templatename = |string|
  iv_type = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_templatearn = lo_result->get_templatearn( ).
  lv_templatename = lo_result->get_templatename( ).
  lv_templateversionid = lo_result->get_defaultversionid( ).
ENDIF.