Skip to content

/AWS1/IF_PIE=>LISTAVAILABLERESOURCEDIM()

About ListAvailableResourceDimensions

Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

Method Signature

METHODS /AWS1/IF_PIE~LISTAVAILABLERESOURCEDIM
  IMPORTING
    !IV_SERVICETYPE TYPE /AWS1/PIESERVICETYPE OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PIEIDENTIFIERSTRING OPTIONAL
    !IT_METRICS TYPE /AWS1/CL_PIEDIMMETRICLIST_W=>TT_DIMENSIONSMETRICLIST OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PIEMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PIENEXTTOKEN OPTIONAL
    !IT_AUTHORIZEDACTIONS TYPE /AWS1/CL_PIEAUTHDACTIONSLIST_W=>TT_AUTHORIZEDACTIONSLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pielstavailableresr01
  RAISING
    /AWS1/CX_PIEINTERNALSVCERROR
    /AWS1/CX_PIEINVALIDARGUMENTEX
    /AWS1/CX_PIENOTAUTHORIZEDEX
    /AWS1/CX_PIECLIENTEXC
    /AWS1/CX_PIESERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_servicetype TYPE /AWS1/PIESERVICETYPE /AWS1/PIESERVICETYPE

The Amazon Web Services service for which Performance Insights returns metrics.

iv_identifier TYPE /AWS1/PIEIDENTIFIERSTRING /AWS1/PIEIDENTIFIERSTRING

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

it_metrics TYPE /AWS1/CL_PIEDIMMETRICLIST_W=>TT_DIMENSIONSMETRICLIST TT_DIMENSIONSMETRICLIST

The types of metrics for which to retrieve dimensions. Valid values include db.load.

Optional arguments:

iv_maxresults TYPE /AWS1/PIEMAXRESULTS /AWS1/PIEMAXRESULTS

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

iv_nexttoken TYPE /AWS1/PIENEXTTOKEN /AWS1/PIENEXTTOKEN

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

it_authorizedactions TYPE /AWS1/CL_PIEAUTHDACTIONSLIST_W=>TT_AUTHORIZEDACTIONSLIST TT_AUTHORIZEDACTIONSLIST

The actions to discover the dimensions you are authorized to access. If you specify multiple actions, then the response will contain the dimensions common for all the actions.

When you don't specify this request parameter or provide an empty list, the response contains all the available dimensions for the target database engine whether or not you are authorized to access them.

RETURNING

oo_output TYPE REF TO /aws1/cl_pielstavailableresr01 /AWS1/CL_PIELSTAVAILABLERESR01

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->listavailableresourcedim(
  it_authorizedactions = VALUE /aws1/cl_pieauthdactionslist_w=>tt_authorizedactionslist(
    ( new /aws1/cl_pieauthdactionslist_w( |string| ) )
  )
  it_metrics = VALUE /aws1/cl_piedimmetriclist_w=>tt_dimensionsmetriclist(
    ( new /aws1/cl_piedimmetriclist_w( |string| ) )
  )
  iv_identifier = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_servicetype = |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_metricdimensions( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_metric( ).
      LOOP AT lo_row_1->get_groups( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_group( ).
          LOOP AT lo_row_3->get_dimensions( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_string = lo_row_5->get_identifier( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.