Skip to content

/AWS1/IF_IOX=>CREATEDESTINATION()

About CreateDestination

Create a destination. IoT managed integrations uses the destination to determine where to deliver notifications for a device.

Method Signature

METHODS /AWS1/IF_IOX~CREATEDESTINATION
  IMPORTING
    !IV_DELIVERYDESTINATIONARN TYPE /AWS1/IOXDELIVERYDSTARN OPTIONAL
    !IV_DELIVERYDESTINATIONTYPE TYPE /AWS1/IOXDELIVERYDSTTYPE OPTIONAL
    !IV_NAME TYPE /AWS1/IOXDESTINATIONNAME OPTIONAL
    !IV_ROLEARN TYPE /AWS1/IOXDELIVERYDSTROLEARN OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/IOXCLIENTTOKEN OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOXDSTDESCRIPTION OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOXTAGSMAP_W=>TT_TAGSMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ioxcreatedstresponse
  RAISING
    /AWS1/CX_IOXACCESSDENIEDEX
    /AWS1/CX_IOXCONFLICTEXCEPTION
    /AWS1/CX_IOXINTERNALSERVEREX
    /AWS1/CX_IOXTHROTTLINGEX
    /AWS1/CX_IOXVALIDATIONEX
    /AWS1/CX_IOXCLIENTEXC
    /AWS1/CX_IOXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_deliverydestinationarn TYPE /AWS1/IOXDELIVERYDSTARN /AWS1/IOXDELIVERYDSTARN

The Amazon Resource Name (ARN) of the customer-managed destination.

iv_deliverydestinationtype TYPE /AWS1/IOXDELIVERYDSTTYPE /AWS1/IOXDELIVERYDSTTYPE

The destination type for the customer-managed destination.

iv_name TYPE /AWS1/IOXDESTINATIONNAME /AWS1/IOXDESTINATIONNAME

The name of the customer-managed destination.

iv_rolearn TYPE /AWS1/IOXDELIVERYDSTROLEARN /AWS1/IOXDELIVERYDSTROLEARN

The Amazon Resource Name (ARN) of the delivery destination role.

Optional arguments:

iv_clienttoken TYPE /AWS1/IOXCLIENTTOKEN /AWS1/IOXCLIENTTOKEN

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

iv_description TYPE /AWS1/IOXDSTDESCRIPTION /AWS1/IOXDSTDESCRIPTION

The description of the customer-managed destination.

it_tags TYPE /AWS1/CL_IOXTAGSMAP_W=>TT_TAGSMAP TT_TAGSMAP

A set of key/value pairs that are used to manage the destination.

RETURNING

oo_output TYPE REF TO /aws1/cl_ioxcreatedstresponse /AWS1/CL_IOXCREATEDSTRESPONSE

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->createdestination(
  it_tags = VALUE /aws1/cl_ioxtagsmap_w=>tt_tagsmap(
    (
      VALUE /aws1/cl_ioxtagsmap_w=>ts_tagsmap_maprow(
        key = |string|
        value = new /aws1/cl_ioxtagsmap_w( |string| )
      )
    )
  )
  iv_clienttoken = |string|
  iv_deliverydestinationarn = |string|
  iv_deliverydestinationtype = |string|
  iv_description = |string|
  iv_name = |string|
  iv_rolearn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_destinationname = lo_result->get_name( ).
ENDIF.