STARTINSTANCEONBOARDINGJOB()`¶

About StartInstanceOnboardingJob¶

Onboard the specific Amazon Connect instance to Connect Campaigns.

Method Signature¶

METHODS /AWS1/IF_CN2~STARTINSTANCEONBOARDINGJOB
  IMPORTING
    !IV_CONNECTINSTANCEID TYPE /AWS1/CN2INSTANCEID OPTIONAL
    !IO_ENCRYPTIONCONFIG TYPE REF TO /AWS1/CL_CN2ENCRYPTIONCONFIG OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cn2strtinstonboardi01
  RAISING
    /AWS1/CX_CN2ACCESSDENIEDEX
    /AWS1/CX_CN2CONFLICTEXCEPTION
    /AWS1/CX_CN2INTERNALSERVEREX
    /AWS1/CX_CN2RESOURCENOTFOUNDEX
    /AWS1/CX_CN2THROTTLINGEX
    /AWS1/CX_CN2VALIDATIONEX
    /AWS1/CX_CN2CLIENTEXC
    /AWS1/CX_CN2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_connectinstanceid` `TYPE /AWS1/CN2INSTANCEID` `/AWS1/CN2INSTANCEID`¶

Amazon Connect Instance Id

`io_encryptionconfig` `TYPE REF TO /AWS1/CL_CN2ENCRYPTIONCONFIG` `/AWS1/CL_CN2ENCRYPTIONCONFIG`¶

Encryption config for Connect Instance. Note that sensitive data will always be encrypted. If disabled, service will perform encryption with its own key. If enabled, a KMS key id needs to be provided and KMS charges will apply. KMS is only type supported

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cn2strtinstonboardi01` `/AWS1/CL_CN2STRTINSTONBOARDI01`¶

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->startinstanceonboardingjob(
  io_encryptionconfig = new /aws1/cl_cn2encryptionconfig(
    iv_enabled = ABAP_TRUE
    iv_encryptiontype = |string|
    iv_keyarn = |string|
  )
  iv_connectinstanceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_instanceonboardingjobst = lo_result->get_cnctinstonboardingjobs00( ).
  IF lo_instanceonboardingjobst IS NOT INITIAL.
    lv_instanceid = lo_instanceonboardingjobst->get_connectinstanceid( ).
    lv_instanceonboardingjobst_1 = lo_instanceonboardingjobst->get_status( ).
    lv_instanceonboardingjobfa = lo_instanceonboardingjobst->get_failurecode( ).
  ENDIF.
ENDIF.

/AWS1/IF_CN2=>STARTINSTANCEONBOARDINGJOB()¶