Skip to content

/AWS1/IF_DAX=>DESCRIBEEVENTS()

About DescribeEvents

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Method Signature

METHODS /AWS1/IF_DAX~DESCRIBEEVENTS
  IMPORTING
    !IV_SOURCENAME TYPE /AWS1/DAXSTRING OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/DAXSOURCETYPE OPTIONAL
    !IV_STARTTIME TYPE /AWS1/DAXTSTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/DAXTSTAMP OPTIONAL
    !IV_DURATION TYPE /AWS1/DAXINTEGEROPTIONAL OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/DAXINTEGEROPTIONAL OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/DAXSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_daxdescreventsrsp
  RAISING
    /AWS1/CX_DAXINVPRMCOMBINATIO00
    /AWS1/CX_DAXINVPARAMVALUEEX
    /AWS1/CX_DAXSVCLNKROLENOTFND00
    /AWS1/CX_DAXCLIENTEXC
    /AWS1/CX_DAXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sourcename TYPE /AWS1/DAXSTRING /AWS1/DAXSTRING

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

iv_sourcetype TYPE /AWS1/DAXSOURCETYPE /AWS1/DAXSOURCETYPE

The event source to retrieve events for. If no value is specified, all events are returned.

iv_starttime TYPE /AWS1/DAXTSTAMP /AWS1/DAXTSTAMP

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

iv_endtime TYPE /AWS1/DAXTSTAMP /AWS1/DAXTSTAMP

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

iv_duration TYPE /AWS1/DAXINTEGEROPTIONAL /AWS1/DAXINTEGEROPTIONAL

The number of minutes' worth of events to retrieve.

iv_maxresults TYPE /AWS1/DAXINTEGEROPTIONAL /AWS1/DAXINTEGEROPTIONAL

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

The value for MaxResults must be between 20 and 100.

iv_nexttoken TYPE /AWS1/DAXSTRING /AWS1/DAXSTRING

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

RETURNING

oo_output TYPE REF TO /aws1/cl_daxdescreventsrsp /AWS1/CL_DAXDESCREVENTSRSP

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(
  iv_duration = 123
  iv_endtime = '20150101000000.0000000'
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_sourcename = |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_nexttoken( ).
  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_sourcename( ).
      lv_sourcetype = lo_row_1->get_sourcetype( ).
      lv_string = lo_row_1->get_message( ).
      lv_tstamp = lo_row_1->get_date( ).
    ENDIF.
  ENDLOOP.
ENDIF.