Skip to content

/AWS1/IF_COP=>GETEC2RECOMMENDATIONPROJEC00()

About GetEC2RecommendationProjectedMetrics

Returns the projected utilization metrics of Amazon EC2 instance recommendations.

The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.

Method Signature

METHODS /AWS1/IF_COP~GETEC2RECOMMENDATIONPROJEC00
  IMPORTING
    !IV_INSTANCEARN TYPE /AWS1/COPINSTANCEARN OPTIONAL
    !IV_STAT TYPE /AWS1/COPMETRICSTATISTIC OPTIONAL
    !IV_PERIOD TYPE /AWS1/COPPERIOD OPTIONAL
    !IV_STARTTIME TYPE /AWS1/COPTIMESTAMP OPTIONAL
    !IV_ENDTIME TYPE /AWS1/COPTIMESTAMP OPTIONAL
    !IO_RECOMMENDATIONPREFERENCES TYPE REF TO /AWS1/CL_COPRECOMMENDATIONPR01 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_copgetec2recommenda01
  RAISING
    /AWS1/CX_COPACCESSDENIEDEX
    /AWS1/CX_COPINTERNALSERVEREX
    /AWS1/CX_COPINVPARAMVALUEEX
    /AWS1/CX_COPMISSINGAUTHNTOKEN
    /AWS1/CX_COPOPTINREQUIREDEX
    /AWS1/CX_COPRESOURCENOTFOUNDEX
    /AWS1/CX_COPSERVICEUNAVAILEX
    /AWS1/CX_COPTHROTTLINGEX
    /AWS1/CX_COPCLIENTEXC
    /AWS1/CX_COPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instancearn TYPE /AWS1/COPINSTANCEARN /AWS1/COPINSTANCEARN

The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.

iv_stat TYPE /AWS1/COPMETRICSTATISTIC /AWS1/COPMETRICSTATISTIC

The statistic of the projected metrics.

iv_period TYPE /AWS1/COPPERIOD /AWS1/COPPERIOD

The granularity, in seconds, of the projected metrics data points.

iv_starttime TYPE /AWS1/COPTIMESTAMP /AWS1/COPTIMESTAMP

The timestamp of the first projected metrics data point to return.

iv_endtime TYPE /AWS1/COPTIMESTAMP /AWS1/COPTIMESTAMP

The timestamp of the last projected metrics data point to return.

Optional arguments:

io_recommendationpreferences TYPE REF TO /AWS1/CL_COPRECOMMENDATIONPR01 /AWS1/CL_COPRECOMMENDATIONPR01

An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.

RETURNING

oo_output TYPE REF TO /aws1/cl_copgetec2recommenda01 /AWS1/CL_COPGETEC2RECOMMENDA01

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->getec2recommendationprojec00(
  io_recommendationpreferences = new /aws1/cl_coprecommendationpr01(
    it_cpuvendorarchitectures = VALUE /aws1/cl_copcpuvendorarchite00=>tt_cpuvendorarchitectures(
      ( new /aws1/cl_copcpuvendorarchite00( |string| ) )
    )
  )
  iv_endtime = '20150101000000.0000000'
  iv_instancearn = |string|
  iv_period = 123
  iv_starttime = '20150101000000.0000000'
  iv_stat = |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_recommendedoptionproje00( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_recommendedinstancetype = lo_row_1->get_recommendedinstancetype( ).
      lv_rank = lo_row_1->get_rank( ).
      LOOP AT lo_row_1->get_projectedmetrics( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_metricname = lo_row_3->get_name( ).
          LOOP AT lo_row_3->get_timestamps( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_timestamp = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          LOOP AT lo_row_3->get_values( ) into lo_row_6.
            lo_row_7 = lo_row_6.
            IF lo_row_7 IS NOT INITIAL.
              lv_metricvalue = lo_row_7->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
ENDIF.