DESCRIBEAPPLICATIONSTATUS()`¶

About DescribeApplicationStatus¶

Describes the application status for the specified instances. Returns the aggregated application health status for each instance. The following rules apply:

The instance-level status is derived from all application status checks with the aggregation setting set to included.
Use DescribeApplicationStatusChecks to view the configuration of individual checks.
Use EnableApplicationStatusCheckSuppression to temporarily suppress health check results from affecting the instance-level status.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEAPPLICATIONSTATUS
  IMPORTING
    !IT_INSTANCEIDS TYPE /AWS1/CL_EC2INSTANCEIDLIST_W=>TT_INSTANCEIDLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DESCRAPPSTATMAXRSLTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2descrappstatusrslt
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_instanceids` `TYPE /AWS1/CL_EC2INSTANCEIDLIST_W=>TT_INSTANCEIDLIST` `TT_INSTANCEIDLIST`¶

The IDs of the instances for which to describe application status.

`it_filters` `TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

The filters.

availability-zone-id – The ID of the Availability Zone.

status – The instance-level application status. For valid values and their meanings, see ApplicationStatus.

`iv_maxresults` `TYPE /AWS1/EC2DESCRAPPSTATMAXRSLTS` `/AWS1/EC2DESCRAPPSTATMAXRSLTS`¶

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

`iv_nexttoken` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2descrappstatusrslt` `/AWS1/CL_EC2DESCRAPPSTATUSRSLT`¶

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->describeapplicationstatus(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_instanceids = VALUE /aws1/cl_ec2instanceidlist_w=>tt_instanceidlist(
    ( new /aws1/cl_ec2instanceidlist_w( |string| ) )
  )
  iv_dryrun = ABAP_TRUE
  iv_maxresults = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_applicationstatusesresp = lo_result->get_applicationstatuses( ).
  IF lo_applicationstatusesresp IS NOT INITIAL.
    LOOP AT lo_applicationstatusesresp->get_instances( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_instanceid = lo_row_1->get_instanceid( ).
        lv_string = lo_row_1->get_availabilityzone( ).
        lv_string = lo_row_1->get_availabilityzoneid( ).
        lo_applicationstatus = lo_row_1->get_applicationstatus( ).
        IF lo_applicationstatus IS NOT INITIAL.
          lv_applicationstatusenum = lo_applicationstatus->get_status( ).
          lv_milliseconddatetime = lo_applicationstatus->get_statustimestamp( ).
          lv_milliseconddatetime = lo_applicationstatus->get_statussince( ).
          lv_milliseconddatetime = lo_applicationstatus->get_resumeat( ).
          LOOP AT lo_applicationstatus->get_details( ) into lo_row_2.
            lo_row_3 = lo_row_2.
            IF lo_row_3 IS NOT INITIAL.
              lv_applicationstatuschecki = lo_row_3->get_applicationstatuscheckid( ).
              lv_milliseconddatetime = lo_row_3->get_checkupdatetime( ).
              lv_aggregationstatusenum = lo_row_3->get_aggregation( ).
              lv_applicationstatuschecke = lo_row_3->get_status( ).
              lv_milliseconddatetime = lo_row_3->get_statustimestamp( ).
              lv_milliseconddatetime = lo_row_3->get_statussince( ).
              lo_applicationstatusreason = lo_row_3->get_reason( ).
              IF lo_applicationstatusreason IS NOT INITIAL.
                lv_string = lo_applicationstatusreason->get_code( ).
                lv_integer = lo_applicationstatusreason->get_statuscode( ).
                lv_string = lo_applicationstatusreason->get_protocol( ).
              ENDIF.
            ENDIF.
          ENDLOOP.
        ENDIF.
        LOOP AT lo_row_1->get_tags( ) into lo_row_4.
          lo_row_5 = lo_row_4.
          IF lo_row_5 IS NOT INITIAL.
            lv_string = lo_row_5->get_key( ).
            lv_string = lo_row_5->get_value( ).
          ENDIF.
        ENDLOOP.
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe application status for instances¶

This example describes the application status for the specified instance.

DATA(lo_result) = lo_client->describeapplicationstatus(
  it_instanceids = VALUE /aws1/cl_ec2instanceidlist_w=>tt_instanceidlist(
    ( new /aws1/cl_ec2instanceidlist_w( |i-0123456789abcdef0| ) )
  )
).

To describe application status using filters¶

This example uses a filter to describe impaired application status in a specific Availability Zone.

DATA(lo_result) = lo_client->describeapplicationstatus(
  it_filters = VALUE /aws1/cl_ec2filter=>tt_filterlist(
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |use1-az1| ) )
        )
        iv_name = |availability-zone-id|
      )
    )
    (
      new /aws1/cl_ec2filter(
        it_values = VALUE /aws1/cl_ec2valuestringlist_w=>tt_valuestringlist(
          ( new /aws1/cl_ec2valuestringlist_w( |impaired| ) )
        )
        iv_name = |status|
      )
    )
  )
  iv_maxresults = 10
).

/AWS1/IF_EC2=>DESCRIBEAPPLICATIONSTATUS()¶