Skip to content

/AWS1/IF_RUM=>PUTRUMEVENTS()

About PutRumEvents

Sends telemetry events about your application performance and user behavior to CloudWatch RUM. The code snippet that RUM generates for you to add to your application includes PutRumEvents operations to send this data to RUM.

Each PutRumEvents operation can send a batch of events from one user session.

Method Signature

METHODS /AWS1/IF_RUM~PUTRUMEVENTS
  IMPORTING
    !IV_ID TYPE /AWS1/RUMAPPMONITORID OPTIONAL
    !IV_BATCHID TYPE /AWS1/RUMSTRING OPTIONAL
    !IO_APPMONITORDETAILS TYPE REF TO /AWS1/CL_RUMAPPMONITORDETAILS OPTIONAL
    !IO_USERDETAILS TYPE REF TO /AWS1/CL_RUMUSERDETAILS OPTIONAL
    !IT_RUMEVENTS TYPE /AWS1/CL_RUMRUMEVENT=>TT_RUMEVENTLIST OPTIONAL
    !IV_ALIAS TYPE /AWS1/RUMALIAS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_rumputrumeventsrsp
  RAISING
    /AWS1/CX_RUMACCESSDENIEDEX
    /AWS1/CX_RUMINTERNALSERVEREX
    /AWS1/CX_RUMRESOURCENOTFOUNDEX
    /AWS1/CX_RUMTHROTTLINGEX
    /AWS1/CX_RUMVALIDATIONEX
    /AWS1/CX_RUMCLIENTEXC
    /AWS1/CX_RUMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_id TYPE /AWS1/RUMAPPMONITORID /AWS1/RUMAPPMONITORID

The ID of the app monitor that is sending this data.

iv_batchid TYPE /AWS1/RUMSTRING /AWS1/RUMSTRING

A unique identifier for this batch of RUM event data.

io_appmonitordetails TYPE REF TO /AWS1/CL_RUMAPPMONITORDETAILS /AWS1/CL_RUMAPPMONITORDETAILS

A structure that contains information about the app monitor that collected this telemetry information.

io_userdetails TYPE REF TO /AWS1/CL_RUMUSERDETAILS /AWS1/CL_RUMUSERDETAILS

A structure that contains information about the user session that this batch of events was collected from.

it_rumevents TYPE /AWS1/CL_RUMRUMEVENT=>TT_RUMEVENTLIST TT_RUMEVENTLIST

An array of structures that contain the telemetry event data.

Optional arguments:

iv_alias TYPE /AWS1/RUMALIAS /AWS1/RUMALIAS

If the app monitor uses a resource-based policy that requires PutRumEvents requests to specify a certain alias, specify that alias here. This alias will be compared to the rum:alias context key in the resource-based policy. For more information, see Using resource-based policies with CloudWatch RUM.

RETURNING

oo_output TYPE REF TO /aws1/cl_rumputrumeventsrsp /AWS1/CL_RUMPUTRUMEVENTSRSP

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->putrumevents(
  io_appmonitordetails = new /aws1/cl_rumappmonitordetails(
    iv_id = |string|
    iv_name = |string|
    iv_version = |string|
  )
  io_userdetails = new /aws1/cl_rumuserdetails(
    iv_sessionid = |string|
    iv_userid = |string|
  )
  it_rumevents = VALUE /aws1/cl_rumrumevent=>tt_rumeventlist(
    (
      new /aws1/cl_rumrumevent(
        iv_details = |string|
        iv_id = |string|
        iv_metadata = |string|
        iv_timestamp = '20150101000000.0000000'
        iv_type = |string|
      )
    )
  )
  iv_alias = |string|
  iv_batchid = |string|
  iv_id = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.