Skip to content

/AWS1/IF_IOW=>CREATEDESTINATION()

About CreateDestination

Creates a new destination that maps a device message to an AWS IoT rule.

Method Signature

METHODS /AWS1/IF_IOW~CREATEDESTINATION
  IMPORTING
    !IV_NAME TYPE /AWS1/IOWDESTINATIONNAME OPTIONAL
    !IV_EXPRESSIONTYPE TYPE /AWS1/IOWEXPRESSIONTYPE OPTIONAL
    !IV_EXPRESSION TYPE /AWS1/IOWEXPRESSION OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/IOWDESCRIPTION OPTIONAL
    !IV_ROLEARN TYPE /AWS1/IOWROLEARN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_IOWTAG=>TT_TAGLIST OPTIONAL
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/IOWCLIENTREQUESTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_iowcreatedstresponse
  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_name TYPE /AWS1/IOWDESTINATIONNAME /AWS1/IOWDESTINATIONNAME

The name of the new resource.

iv_expressiontype TYPE /AWS1/IOWEXPRESSIONTYPE /AWS1/IOWEXPRESSIONTYPE

The type of value in Expression.

iv_expression TYPE /AWS1/IOWEXPRESSION /AWS1/IOWEXPRESSION

The rule name or topic rule to send messages to.

iv_rolearn TYPE /AWS1/IOWROLEARN /AWS1/IOWROLEARN

The ARN of the IAM Role that authorizes the destination.

Optional arguments:

iv_description TYPE /AWS1/IOWDESCRIPTION /AWS1/IOWDESCRIPTION

The description of the new resource.

it_tags TYPE /AWS1/CL_IOWTAG=>TT_TAGLIST TT_TAGLIST

The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_iowcreatedstresponse /AWS1/CL_IOWCREATEDSTRESPONSE

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_iowtag=>tt_taglist(
    (
      new /aws1/cl_iowtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_clientrequesttoken = |string|
  iv_description = |string|
  iv_expression = |string|
  iv_expressiontype = |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_destinationarn = lo_result->get_arn( ).
  lv_destinationname = lo_result->get_name( ).
ENDIF.