Skip to content

/AWS1/IF_DMG=>DESCRIBEEVENTS()

About DescribeEvents

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on DMS events, see Working with Events and Notifications in the Database Migration Service User Guide.

Method Signature

METHODS /AWS1/IF_DMG~DESCRIBEEVENTS
  IMPORTING
    !IV_SOURCEIDENTIFIER TYPE /AWS1/DMGSTRING OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/DMGSOURCETYPE OPTIONAL
    !IV_STARTTIME TYPE /AWS1/DMGTSTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/DMGTSTAMP OPTIONAL
    !IV_DURATION TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
    !IT_EVENTCATEGORIES TYPE /AWS1/CL_DMGEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_DMGFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DMGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgdescreventsrsp
  RAISING
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sourceidentifier TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The identifier of an event source.

iv_sourcetype TYPE /AWS1/DMGSOURCETYPE /AWS1/DMGSOURCETYPE

The type of DMS resource that generates events.

Valid values: replication-instance | replication-task

iv_starttime TYPE /AWS1/DMGTSTAMP /AWS1/DMGTSTAMP

The start time for the events to be listed.

iv_endtime TYPE /AWS1/DMGTSTAMP /AWS1/DMGTSTAMP

The end time for the events to be listed.

iv_duration TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

The duration of the events to be listed.

it_eventcategories TYPE /AWS1/CL_DMGEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST TT_EVENTCATEGORIESLIST

A list of event categories for the source type that you've chosen.

it_filters TYPE /AWS1/CL_DMGFILTER=>TT_FILTERLIST TT_FILTERLIST

Filters applied to events. The only valid filter is replication-instance-id.

iv_maxrecords TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

iv_marker TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

RETURNING

oo_output TYPE REF TO /aws1/cl_dmgdescreventsrsp /AWS1/CL_DMGDESCREVENTSRSP

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->describeevents(
  it_eventcategories = VALUE /aws1/cl_dmgeventcatslist_w=>tt_eventcategorieslist(
    ( new /aws1/cl_dmgeventcatslist_w( |string| ) )
  )
  it_filters = VALUE /aws1/cl_dmgfilter=>tt_filterlist(
    (
      new /aws1/cl_dmgfilter(
        it_values = VALUE /aws1/cl_dmgfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dmgfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_duration = 123
  iv_endtime = '20150101000000.0000000'
  iv_marker = |string|
  iv_maxrecords = 123
  iv_sourceidentifier = |string|
  iv_sourcetype = |string|
  iv_starttime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_marker( ).
  LOOP AT lo_result->get_events( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_sourceidentifier( ).
      lv_sourcetype = lo_row_1->get_sourcetype( ).
      lv_string = lo_row_1->get_message( ).
      LOOP AT lo_row_1->get_eventcategories( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_tstamp = lo_row_1->get_date( ).
    ENDIF.
  ENDLOOP.
ENDIF.