Skip to content

/AWS1/IF_COP=>GETIDLERECOMMENDATIONS()

About GetIdleRecommendations

Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see Resource requirements in the Compute Optimizer User Guide

Method Signature

METHODS /AWS1/IF_COP~GETIDLERECOMMENDATIONS
  IMPORTING
    !IT_RESOURCEARNS TYPE /AWS1/CL_COPRESOURCEARNS_W=>TT_RESOURCEARNS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/COPNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/COPIDLEMAXRESULTS OPTIONAL
    !IT_FILTERS TYPE /AWS1/CL_COPIDLERECOMMENDATI00=>TT_IDLERECOMMENDATIONFILTERS OPTIONAL
    !IT_ACCOUNTIDS TYPE /AWS1/CL_COPACCOUNTIDS_W=>TT_ACCOUNTIDS OPTIONAL
    !IO_ORDERBY TYPE REF TO /AWS1/CL_COPORDERBY OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_copgetidlerecommend01
  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

Optional arguments:

it_resourcearns TYPE /AWS1/CL_COPRESOURCEARNS_W=>TT_RESOURCEARNS TT_RESOURCEARNS

The ARN that identifies the idle resource.

iv_nexttoken TYPE /AWS1/COPNEXTTOKEN /AWS1/COPNEXTTOKEN

The token to advance to the next page of idle resource recommendations.

iv_maxresults TYPE /AWS1/COPIDLEMAXRESULTS /AWS1/COPIDLEMAXRESULTS

The maximum number of idle resource recommendations to return with a single request.

To retrieve the remaining results, make another request with the returned nextToken value.

it_filters TYPE /AWS1/CL_COPIDLERECOMMENDATI00=>TT_IDLERECOMMENDATIONFILTERS TT_IDLERECOMMENDATIONFILTERS

An array of objects to specify a filter that returns a more specific list of idle resource recommendations.

it_accountids TYPE /AWS1/CL_COPACCOUNTIDS_W=>TT_ACCOUNTIDS TT_ACCOUNTIDS

Return the idle resource recommendations to the specified Amazon Web Services account IDs.

If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.

You can only specify one account ID per request.

io_orderby TYPE REF TO /AWS1/CL_COPORDERBY /AWS1/CL_COPORDERBY

The order to sort the idle resource recommendations.

RETURNING

oo_output TYPE REF TO /aws1/cl_copgetidlerecommend01 /AWS1/CL_COPGETIDLERECOMMEND01

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->getidlerecommendations(
  io_orderby = new /aws1/cl_coporderby(
    iv_dimension = |string|
    iv_order = |string|
  )
  it_accountids = VALUE /aws1/cl_copaccountids_w=>tt_accountids(
    ( new /aws1/cl_copaccountids_w( |string| ) )
  )
  it_filters = VALUE /aws1/cl_copidlerecommendati00=>tt_idlerecommendationfilters(
    (
      new /aws1/cl_copidlerecommendati00(
        it_values = VALUE /aws1/cl_copfiltervalues_w=>tt_filtervalues(
          ( new /aws1/cl_copfiltervalues_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_resourcearns = VALUE /aws1/cl_copresourcearns_w=>tt_resourcearns(
    ( new /aws1/cl_copresourcearns_w( |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.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_idlerecommendations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_resourcearn = lo_row_1->get_resourcearn( ).
      lv_resourceid = lo_row_1->get_resourceid( ).
      lv_idlerecommendationresou = lo_row_1->get_resourcetype( ).
      lv_accountid = lo_row_1->get_accountid( ).
      lv_idlefinding = lo_row_1->get_finding( ).
      lv_idlefindingdescription = lo_row_1->get_findingdescription( ).
      lo_idlesavingsopportunity = lo_row_1->get_savingsopportunity( ).
      IF lo_idlesavingsopportunity IS NOT INITIAL.
        lv_savingsopportunityperce = lo_idlesavingsopportunity->get_savingsopportunityperc00( ).
        lo_idleestimatedmonthlysav = lo_idlesavingsopportunity->get_estimatedmonthlysavings( ).
        IF lo_idleestimatedmonthlysav IS NOT INITIAL.
          lv_currency = lo_idleestimatedmonthlysav->get_currency( ).
          lv_value = lo_idleestimatedmonthlysav->get_value( ).
        ENDIF.
      ENDIF.
      lo_idlesavingsopportunitya = lo_row_1->get_savingsopportunityafrd00( ).
      IF lo_idlesavingsopportunitya IS NOT INITIAL.
        lv_savingsopportunityperce = lo_idlesavingsopportunitya->get_savingsopportunityperc00( ).
        lo_idleestimatedmonthlysav = lo_idlesavingsopportunitya->get_estimatedmonthlysavings( ).
        IF lo_idleestimatedmonthlysav IS NOT INITIAL.
          lv_currency = lo_idleestimatedmonthlysav->get_currency( ).
          lv_value = lo_idleestimatedmonthlysav->get_value( ).
        ENDIF.
      ENDIF.
      LOOP AT lo_row_1->get_utilizationmetrics( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_idlemetricname = lo_row_3->get_name( ).
          lv_metricstatistic = lo_row_3->get_statistic( ).
          lv_metricvalue = lo_row_3->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_lookbackperiodindays = lo_row_1->get_lookbackperiodindays( ).
      lv_lastrefreshtimestamp = lo_row_1->get_lastrefreshtimestamp( ).
      LOOP AT lo_row_1->get_tags( ) into lo_row_4.
        lo_row_5 = lo_row_4.
        IF lo_row_5 IS NOT INITIAL.
          lv_tagkey = lo_row_5->get_key( ).
          lv_tagvalue = lo_row_5->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_errors( ) into lo_row_6.
    lo_row_7 = lo_row_6.
    IF lo_row_7 IS NOT INITIAL.
      lv_identifier = lo_row_7->get_identifier( ).
      lv_code = lo_row_7->get_code( ).
      lv_message = lo_row_7->get_message( ).
      lv_idlerecommendationresou = lo_row_7->get_resourcetype( ).
    ENDIF.
  ENDLOOP.
ENDIF.