/AWS1/IF_EBN=>DESCRIBEEVENTS()

About DescribeEvents

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Method Signature

METHODS /AWS1/IF_EBN~DESCRIBEEVENTS
  IMPORTING
    !IV_APPLICATIONNAME TYPE /AWS1/EBNAPPLICATIONNAME OPTIONAL
    !IV_VERSIONLABEL TYPE /AWS1/EBNVERSIONLABEL OPTIONAL
    !IV_TEMPLATENAME TYPE /AWS1/EBNCONFTEMPLATENAME OPTIONAL
    !IV_ENVIRONMENTID TYPE /AWS1/EBNENVIRONMENTID OPTIONAL
    !IV_ENVIRONMENTNAME TYPE /AWS1/EBNENVIRONMENTNAME OPTIONAL
    !IV_PLATFORMARN TYPE /AWS1/EBNPLATFORMARN OPTIONAL
    !IV_REQUESTID TYPE /AWS1/EBNREQUESTID OPTIONAL
    !IV_SEVERITY TYPE /AWS1/EBNEVENTSEVERITY OPTIONAL
    !IV_STARTTIME TYPE /AWS1/EBNTIMEFILTERSTART OPTIONAL
    !IV_ENDTIME TYPE /AWS1/EBNTIMEFILTEREND OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/EBNMAXRECORDS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EBNTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ebneventdescsmessage
  RAISING
    /AWS1/CX_EBNCLIENTEXC
    /AWS1/CX_EBNSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_applicationname TYPE /AWS1/EBNAPPLICATIONNAME /AWS1/EBNAPPLICATIONNAME

If specified, Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

iv_versionlabel TYPE /AWS1/EBNVERSIONLABEL /AWS1/EBNVERSIONLABEL

If specified, Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

iv_templatename TYPE /AWS1/EBNCONFTEMPLATENAME /AWS1/EBNCONFTEMPLATENAME

If specified, Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

iv_environmentid TYPE /AWS1/EBNENVIRONMENTID /AWS1/EBNENVIRONMENTID

If specified, Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

iv_environmentname TYPE /AWS1/EBNENVIRONMENTNAME /AWS1/EBNENVIRONMENTNAME

If specified, Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

iv_platformarn TYPE /AWS1/EBNPLATFORMARN /AWS1/EBNPLATFORMARN

The ARN of a custom platform version. If specified, Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.

iv_requestid TYPE /AWS1/EBNREQUESTID /AWS1/EBNREQUESTID

If specified, Elastic Beanstalk restricts the described events to include only those associated with this request ID.

iv_severity TYPE /AWS1/EBNEVENTSEVERITY /AWS1/EBNEVENTSEVERITY

If specified, limits the events returned from this call to include only those with the specified severity or higher.

iv_starttime TYPE /AWS1/EBNTIMEFILTERSTART /AWS1/EBNTIMEFILTERSTART

If specified, Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

iv_endtime TYPE /AWS1/EBNTIMEFILTEREND /AWS1/EBNTIMEFILTEREND

If specified, Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

iv_maxrecords TYPE /AWS1/EBNMAXRECORDS /AWS1/EBNMAXRECORDS

Specifies the maximum number of events that can be returned, beginning with the most recent event.

iv_nexttoken TYPE /AWS1/EBNTOKEN /AWS1/EBNTOKEN

Pagination token. If specified, the events return the next batch of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_ebneventdescsmessage /AWS1/CL_EBNEVENTDESCSMESSAGE

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_applicationname = |string|
  iv_endtime = '20150101000000.0000000'
  iv_environmentid = |string|
  iv_environmentname = |string|
  iv_maxrecords = 123
  iv_nexttoken = |string|
  iv_platformarn = |string|
  iv_requestid = |string|
  iv_severity = |string|
  iv_starttime = '20150101000000.0000000'
  iv_templatename = |string|
  iv_versionlabel = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_events( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_eventdate = lo_row_1->get_eventdate( ).
      lv_eventmessage = lo_row_1->get_message( ).
      lv_applicationname = lo_row_1->get_applicationname( ).
      lv_versionlabel = lo_row_1->get_versionlabel( ).
      lv_configurationtemplatena = lo_row_1->get_templatename( ).
      lv_environmentname = lo_row_1->get_environmentname( ).
      lv_platformarn = lo_row_1->get_platformarn( ).
      lv_requestid = lo_row_1->get_requestid( ).
      lv_eventseverity = lo_row_1->get_severity( ).
    ENDIF.
  ENDLOOP.
  lv_token = lo_result->get_nexttoken( ).
ENDIF.

To view events for an environment

The following operation retrieves events for an environment named my-env:

DATA(lo_result) = lo_client->describeevents( iv_environmentname = |my-env| ) .