DESCRIBEAPPSTATUSCHECKS()`¶

About DescribeApplicationStatusChecks¶

Describes one or more application status checks. Returns configuration details for your application status checks, including protocol, port, path, thresholds, and associations. The following rules apply:

If you do not specify any application status check IDs, all checks in your account are returned.
Use DescribeApplicationStatus to see the actual health status of instances.

Method Signature¶

METHODS /AWS1/IF_EC2~DESCRIBEAPPSTATUSCHECKS
  IMPORTING
    !IT_APPLICATIONSTATUSCHECKIDS TYPE /AWS1/CL_EC2APPSTATCHKIDLIST_W=>TT_APPSTATUSCHECKIDLIST OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_EC2FILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EC2DSCAPPTATUSCHXMAXRSLT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_INCLUDEALL TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2dscapptatuschxrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_applicationstatuscheckids` `TYPE /AWS1/CL_EC2APPSTATCHKIDLIST_W=>TT_APPSTATUSCHECKIDLIST` `TT_APPSTATUSCHECKIDLIST`¶

The IDs of the application status checks to describe.

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

The filters.

aggregation – The aggregation setting. Valid values: included and excluded.

`iv_maxresults` `TYPE /AWS1/EC2DSCAPPTATUSCHXMAXRSLT` `/AWS1/EC2DSCAPPTATUSCHXMAXRSLT`¶

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_includeall` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Specifies whether to include recently deleted application status checks that remain available during the deletion grace period. If you omit this parameter or set it to false, the response includes only active checks.

`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_ec2dscapptatuschxrs` `/AWS1/CL_EC2DSCAPPTATUSCHXRS`¶

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->describeappstatuschecks(
  it_applicationstatuscheckids = VALUE /aws1/cl_ec2appstatchkidlist_w=>tt_appstatuscheckidlist(
    ( new /aws1/cl_ec2appstatchkidlist_w( |string| ) )
  )
  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|
      )
    )
  )
  iv_dryrun = ABAP_TRUE
  iv_includeall = 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.
  LOOP AT lo_result->get_applicationstatuschecks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_applicationstatuschecki = lo_row_1->get_applicationstatuscheckid( ).
      lv_aggregationstatusenum = lo_row_1->get_aggregation( ).
      LOOP AT lo_row_1->get_healthcheckpaths( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lo_healthcheckpathsourcere = lo_row_3->get_source( ).
          IF lo_healthcheckpathsourcere IS NOT INITIAL.
            lv_string = lo_healthcheckpathsourcere->get_subnetid( ).
            lv_string = lo_healthcheckpathsourcere->get_securitygroupid( ).
          ENDIF.
          LOOP AT lo_row_3->get_destinations( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_subnetid( ).
              lv_string = lo_row_5->get_securitygroupid( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      lv_networkprotocolenum = lo_row_1->get_protocol( ).
      lv_integer = lo_row_1->get_port( ).
      lv_string = lo_row_1->get_path( ).
      lv_integer = lo_row_1->get_deviceindex( ).
      lv_ipversionenum = lo_row_1->get_ipversion( ).
      lv_ipscopeenum = lo_row_1->get_ipscope( ).
      lv_integer = lo_row_1->get_interval( ).
      lv_integer = lo_row_1->get_timeout( ).
      lv_integer = lo_row_1->get_failurethreshold( ).
      lv_integer = lo_row_1->get_successthreshold( ).
      lv_string = lo_row_1->get_statuscodematcher( ).
      lv_initializationgraceperi = lo_row_1->get_initgraceperiodseconds( ).
      lv_milliseconddatetime = lo_row_1->get_lastupdatedat( ).
      LOOP AT lo_row_1->get_targettagassociations( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_string = lo_row_7->get_key( ).
          lv_string = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_tags( ) into lo_row_8.
        lo_row_9 = lo_row_8.
        IF lo_row_9 IS NOT INITIAL.
          lv_string = lo_row_9->get_key( ).
          lv_string = lo_row_9->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_milliseconddatetime = lo_row_1->get_creationtime( ).
      lv_milliseconddatetime = lo_row_1->get_modifytime( ).
      lv_milliseconddatetime = lo_row_1->get_deletiontime( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

To describe application status checks¶

This example describes the specified application status checks.

DATA(lo_result) = lo_client->describeappstatuschecks(
  it_applicationstatuscheckids = VALUE /aws1/cl_ec2appstatchkidlist_w=>tt_appstatuscheckidlist(
    ( new /aws1/cl_ec2appstatchkidlist_w( |asc-0123456789abcdef0| ) )
  )
).

To describe application status checks using filters¶

This example uses a filter to describe application status checks included in aggregation.

DATA(lo_result) = lo_client->describeappstatuschecks(
  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( |included| ) )
        )
        iv_name = |aggregation|
      )
    )
  )
  iv_maxresults = 10
).

/AWS1/IF_EC2=>DESCRIBEAPPSTATUSCHECKS()¶