DESCRIBETAGS()`¶

About DescribeTags¶

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

tagKey
tagValue
configurationId

Also, all configuration items associated with your user that have tags can be listed if you call DescribeTags as is without passing any parameters.

Method Signature¶

METHODS /AWS1/IF_ADS~DESCRIBETAGS
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_ADSTAGFILTER=>TT_TAGFILTERS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/ADSINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/ADSNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_adsdescrtagsresponse
  RAISING
    /AWS1/CX_ADSAUTHERROREXCEPTION
    /AWS1/CX_ADSHOMEREGIONNOTSETEX
    /AWS1/CX_ADSINVALIDPARAMETEREX
    /AWS1/CX_ADSINVPARAMVALUEEX
    /AWS1/CX_ADSRESOURCENOTFOUNDEX
    /AWS1/CX_ADSSERVERINTERNALER00
    /AWS1/CX_ADSCLIENTEXC
    /AWS1/CX_ADSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_ADSTAGFILTER=>TT_TAGFILTERS` `TT_TAGFILTERS`¶

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

`iv_maxresults` `TYPE /AWS1/ADSINTEGER` `/AWS1/ADSINTEGER`¶

The total number of items to return in a single page of output. The maximum value is 100.

`iv_nexttoken` `TYPE /AWS1/ADSNEXTTOKEN` `/AWS1/ADSNEXTTOKEN`¶

A token to start the list. Use this token to get the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_adsdescrtagsresponse` `/AWS1/CL_ADSDESCRTAGSRESPONSE`¶

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->describetags(
  it_filters = VALUE /aws1/cl_adstagfilter=>tt_tagfilters(
    (
      new /aws1/cl_adstagfilter(
        it_values = VALUE /aws1/cl_adsfiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_adsfiltervalues_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  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_tags( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_configurationitemtype = lo_row_1->get_configurationtype( ).
      lv_configurationid = lo_row_1->get_configurationid( ).
      lv_tagkey = lo_row_1->get_key( ).
      lv_tagvalue = lo_row_1->get_value( ).
      lv_timestamp = lo_row_1->get_timeofcreation( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_ADS=>DESCRIBETAGS()¶