Skip to content

/AWS1/IF_DOD=>DESCRIBEEVENTS()

About DescribeEvents

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Method Signature

METHODS /AWS1/IF_DOD~DESCRIBEEVENTS
  IMPORTING
    !IV_SOURCEIDENTIFIER TYPE /AWS1/DODSTRING OPTIONAL
    !IV_SOURCETYPE TYPE /AWS1/DODSOURCETYPE OPTIONAL
    !IV_STARTTIME TYPE /AWS1/DODTSTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/DODTSTAMP OPTIONAL
    !IV_DURATION TYPE /AWS1/DODINTEGEROPTIONAL OPTIONAL
    !IT_EVENTCATEGORIES TYPE /AWS1/CL_DODEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DODINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DODSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dodeventsmessage
  RAISING
    /AWS1/CX_DODCLIENTEXC
    /AWS1/CX_DODSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sourceidentifier TYPE /AWS1/DODSTRING /AWS1/DODSTRING

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

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

iv_sourcetype TYPE /AWS1/DODSOURCETYPE /AWS1/DODSOURCETYPE

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

iv_starttime TYPE /AWS1/DODTSTAMP /AWS1/DODTSTAMP

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

Example: 2009-07-08T18:00Z

iv_endtime TYPE /AWS1/DODTSTAMP /AWS1/DODTSTAMP

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

Example: 2009-07-08T18:00Z

iv_duration TYPE /AWS1/DODINTEGEROPTIONAL /AWS1/DODINTEGEROPTIONAL

The number of minutes to retrieve events for.

Default: 60

it_eventcategories TYPE /AWS1/CL_DODEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST TT_EVENTCATEGORIESLIST

A list of event categories that trigger notifications for an event notification subscription.

it_filters TYPE /AWS1/CL_DODFILTER=>TT_FILTERLIST TT_FILTERLIST

This parameter is not currently supported.

iv_maxrecords TYPE /AWS1/DODINTEGEROPTIONAL /AWS1/DODINTEGEROPTIONAL

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (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/DODSTRING /AWS1/DODSTRING

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_dodeventsmessage /AWS1/CL_DODEVENTSMESSAGE

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_dodeventcatslist_w=>tt_eventcategorieslist(
    ( new /aws1/cl_dodeventcatslist_w( |string| ) )
  )
  it_filters = VALUE /aws1/cl_dodfilter=>tt_filterlist(
    (
      new /aws1/cl_dodfilter(
        it_values = VALUE /aws1/cl_dodfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dodfiltervaluelist_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( ).
      lv_string = lo_row_1->get_sourcearn( ).
    ENDIF.
  ENDLOOP.
ENDIF.