LISTAVAILABLERESOURCEMETRICS()`¶

About ListAvailableResourceMetrics¶

Retrieve metrics of the specified types that can be queried for a specified DB instance.

Method Signature¶

METHODS /AWS1/IF_PIE~LISTAVAILABLERESOURCEMETRICS
  IMPORTING
    !IV_SERVICETYPE TYPE /AWS1/PIESERVICETYPE OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PIEIDENTIFIERSTRING OPTIONAL
    !IT_METRICTYPES TYPE /AWS1/CL_PIEMETRICTYPELIST_W=>TT_METRICTYPELIST OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PIENEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PIEMAXRESULTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_pielstavailableresr03
  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_metrictypes` `TYPE /AWS1/CL_PIEMETRICTYPELIST_W=>TT_METRICTYPELIST` `TT_METRICTYPELIST`¶

The types of metrics to return in the response. Valid values in the array include the following:

os (OS counter metrics) - All engines

db (DB load metrics) - All engines except for Amazon DocumentDB

db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB

db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

Optional arguments:¶

`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.

`iv_maxresults` `TYPE /AWS1/PIEMAXRESULTS` `/AWS1/PIEMAXRESULTS`¶

The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_pielstavailableresr03` `/AWS1/CL_PIELSTAVAILABLERESR03`¶

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->listavailableresourcemetrics(
  it_metrictypes = VALUE /aws1/cl_piemetrictypelist_w=>tt_metrictypelist(
    ( new /aws1/cl_piemetrictypelist_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_metrics( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_metric( ).
      lv_description = lo_row_1->get_description( ).
      lv_string = lo_row_1->get_unit( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_PIE=>LISTAVAILABLERESOURCEMETRICS()¶