Skip to content

/AWS1/IF_PIE=>DESCRIBEDIMENSIONKEYS()

About DescribeDimensionKeys

For a specific time period, retrieve the top N dimension keys for a metric.

Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

Method Signature

METHODS /AWS1/IF_PIE~DESCRIBEDIMENSIONKEYS
  IMPORTING
    !IV_SERVICETYPE TYPE /AWS1/PIESERVICETYPE OPTIONAL
    !IV_IDENTIFIER TYPE /AWS1/PIEIDENTIFIERSTRING OPTIONAL
    !IV_STARTTIME TYPE /AWS1/PIEISOTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/PIEISOTIMESTAMP OPTIONAL
    !IV_METRIC TYPE /AWS1/PIEREQUESTSTRING OPTIONAL
    !IV_PERIODINSECONDS TYPE /AWS1/PIEINTEGER OPTIONAL
    !IO_GROUPBY TYPE REF TO /AWS1/CL_PIEDIMENSIONGROUP OPTIONAL
    !IT_ADDITIONALMETRICS TYPE /AWS1/CL_PIEADDLMETRICSLIST_W=>TT_ADDITIONALMETRICSLIST OPTIONAL
    !IO_PARTITIONBY TYPE REF TO /AWS1/CL_PIEDIMENSIONGROUP OPTIONAL
    !IT_FILTER TYPE /AWS1/CL_PIEMETRICQUERYFILTM00=>TT_METRICQUERYFILTERMAP OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/PIEMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/PIENEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_piedscdimensionkeys01
  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 will return metrics. Valid values are as follows:

  • RDS

  • DOCDB

iv_identifier TYPE /AWS1/PIEIDENTIFIERSTRING /AWS1/PIEIDENTIFIERSTRING

An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

iv_starttime TYPE /AWS1/PIEISOTIMESTAMP /AWS1/PIEISOTIMESTAMP

The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

The value for StartTime must be earlier than the value for EndTime.

iv_endtime TYPE /AWS1/PIEISOTIMESTAMP /AWS1/PIEISOTIMESTAMP

The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

The value for EndTime must be later than the value for StartTime.

iv_metric TYPE /AWS1/PIEREQUESTSTRING /AWS1/PIEREQUESTSTRING

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - A scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - The raw number of active sessions for the database engine.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

io_groupby TYPE REF TO /AWS1/CL_PIEDIMENSIONGROUP /AWS1/CL_PIEDIMENSIONGROUP

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

Optional arguments:

iv_periodinseconds TYPE /AWS1/PIEINTEGER /AWS1/PIEINTEGER

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

  • 1 (one second)

  • 60 (one minute)

  • 300 (five minutes)

  • 3600 (one hour)

  • 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

it_additionalmetrics TYPE /AWS1/CL_PIEADDLMETRICSLIST_W=>TT_ADDITIONALMETRICSLIST TT_ADDITIONALMETRICSLIST

Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

The only supported statistic function is .avg.

io_partitionby TYPE REF TO /AWS1/CL_PIEDIMENSIONGROUP /AWS1/CL_PIEDIMENSIONGROUP

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

it_filter TYPE /AWS1/CL_PIEMETRICQUERYFILTM00=>TT_METRICQUERYFILTERMAP TT_METRICQUERYFILTERMAP

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

  • A single filter for any other dimension in this dimension group.

The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

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.

RETURNING

oo_output TYPE REF TO /aws1/cl_piedscdimensionkeys01 /AWS1/CL_PIEDSCDIMENSIONKEYS01

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->describedimensionkeys(
  io_groupby = new /aws1/cl_piedimensiongroup(
    it_dimensions = VALUE /aws1/cl_piesanitizedstrlist_w=>tt_sanitizedstringlist(
      ( new /aws1/cl_piesanitizedstrlist_w( |string| ) )
    )
    iv_group = |string|
    iv_limit = 123
  )
  io_partitionby = new /aws1/cl_piedimensiongroup(
    it_dimensions = VALUE /aws1/cl_piesanitizedstrlist_w=>tt_sanitizedstringlist(
      ( new /aws1/cl_piesanitizedstrlist_w( |string| ) )
    )
    iv_group = |string|
    iv_limit = 123
  )
  it_additionalmetrics = VALUE /aws1/cl_pieaddlmetricslist_w=>tt_additionalmetricslist(
    ( new /aws1/cl_pieaddlmetricslist_w( |string| ) )
  )
  it_filter = VALUE /aws1/cl_piemetricqueryfiltm00=>tt_metricqueryfiltermap(
    (
      VALUE /aws1/cl_piemetricqueryfiltm00=>ts_metricqueryfiltermap_maprow(
        value = new /aws1/cl_piemetricqueryfiltm00( |string| )
        key = |string|
      )
    )
  )
  iv_endtime = '20150101000000.0000000'
  iv_identifier = |string|
  iv_maxresults = 123
  iv_metric = |string|
  iv_nexttoken = |string|
  iv_periodinseconds = 123
  iv_servicetype = |string|
  iv_starttime = '20150101000000.0000000'
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_isotimestamp = lo_result->get_alignedstarttime( ).
  lv_isotimestamp = lo_result->get_alignedendtime( ).
  LOOP AT lo_result->get_partitionkeys( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      LOOP AT lo_row_1->get_dimensions( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_requeststring = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_keys( ) into lo_row_3.
    lo_row_4 = lo_row_3.
    IF lo_row_4 IS NOT INITIAL.
      LOOP AT lo_row_4->get_dimensions( ) into ls_row_2.
        lv_key = ls_row_2-key.
        lo_value = ls_row_2-value.
        IF lo_value IS NOT INITIAL.
          lv_requeststring = lo_value->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_double = lo_row_4->get_total( ).
      LOOP AT lo_row_4->get_additionalmetrics( ) into ls_row_5.
        lv_key = ls_row_5-key.
        lo_value_1 = ls_row_5-value.
        IF lo_value_1 IS NOT INITIAL.
          lv_double = lo_value_1->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_4->get_partitions( ) into lo_row_6.
        lo_row_7 = lo_row_6.
        IF lo_row_7 IS NOT INITIAL.
          lv_double = lo_row_7->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.