PUTRECOMMENDATIONPREFERENCES()`¶

About PutRecommendationPreferences¶

Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Method Signature¶

METHODS /AWS1/IF_COP~PUTRECOMMENDATIONPREFERENCES
  IMPORTING
    !IV_RESOURCETYPE TYPE /AWS1/COPRESOURCETYPE OPTIONAL
    !IO_SCOPE TYPE REF TO /AWS1/CL_COPSCOPE OPTIONAL
    !IV_ENHINFRASTRUCTUREMETRICS TYPE /AWS1/COPENHINFRASTRUCTUREMET OPTIONAL
    !IV_INFERREDWORKLOADTYPES TYPE /AWS1/COPINFERREDWORKLOADTYP00 OPTIONAL
    !IO_EXTERNALMETRICSPREFERENCE TYPE REF TO /AWS1/CL_COPEXTERNALMETPREFE00 OPTIONAL
    !IV_LOOKBACKPERIOD TYPE /AWS1/COPLOOKBACKPERPREFERENCE OPTIONAL
    !IT_UTILIZATIONPREFERENCES TYPE /AWS1/CL_COPUTILIZATIONPREFE00=>TT_UTILIZATIONPREFERENCES OPTIONAL
    !IT_PREFERREDRESOURCES TYPE /AWS1/CL_COPPREFERREDRESOURCE=>TT_PREFERREDRESOURCES OPTIONAL
    !IV_SAVINGSESTIMATIONMODE TYPE /AWS1/COPSAVINGSESTIMATIONMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_copputrecommendatio01
  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_resourcetype` `TYPE /AWS1/COPRESOURCETYPE` `/AWS1/COPRESOURCETYPE`¶

The target resource type of the recommendation preference to create.

The Ec2Instance option encompasses standalone instances and instances that are part of Amazon EC2 Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Amazon EC2 Auto Scaling group.

Optional arguments:¶

`io_scope` `TYPE REF TO /AWS1/CL_COPSCOPE` `/AWS1/CL_COPSCOPE`¶

An object that describes the scope of the recommendation preference to create.

You can create recommendation preferences at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

You cannot create recommendation preferences for Amazon EC2 Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Amazon EC2 Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Amazon EC2 Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Amazon EC2 Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Amazon EC2 Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

`iv_enhinfrastructuremetrics` `TYPE /AWS1/COPENHINFRASTRUCTUREMET` `/AWS1/COPENHINFRASTRUCTUREMET`¶

The status of the enhanced infrastructure metrics recommendation preference to create or update.

Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.

`iv_inferredworkloadtypes` `TYPE /AWS1/COPINFERREDWORKLOADTYP00` `/AWS1/COPINFERREDWORKLOADTYP00`¶

The status of the inferred workload types recommendation preference to create or update.

The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

Specify the Inactive status to deactivate the feature, or specify Active to activate it.

For more information, see Inferred workload types in the Compute Optimizer User Guide.

`io_externalmetricspreference` `TYPE REF TO /AWS1/CL_COPEXTERNALMETPREFE00` `/AWS1/CL_COPEXTERNALMETPREFE00`¶

The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

This preference can only be set for the Ec2Instance resource type.

For more information, see External metrics ingestion in the Compute Optimizer User Guide.

`iv_lookbackperiod` `TYPE /AWS1/COPLOOKBACKPERPREFERENCE` `/AWS1/COPLOOKBACKPERPREFERENCE`¶

The preference to control the number of days the utilization metrics of the Amazon Web Services resource are analyzed. When this preference isn't specified, we use the default value DAYS_14.

You can only set this preference for the Amazon EC2 instance and Amazon EC2 Auto Scaling group resource types.

Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels.

Amazon EC2 Auto Scaling group lookback preferences can only be set at the resource level.

`it_utilizationpreferences` `TYPE /AWS1/CL_COPUTILIZATIONPREFE00=>TT_UTILIZATIONPREFERENCES` `TT_UTILIZATIONPREFERENCES`¶

The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. When this preference isn't specified, we use the following default values.

CPU utilization:

P99_5 for threshold

PERCENT_20 for headroom

Memory utilization:

PERCENT_20 for headroom

You can only set CPU and memory utilization preferences for the Amazon EC2 instance resource type.

The threshold setting isn’t available for memory utilization.

`it_preferredresources` `TYPE /AWS1/CL_COPPREFERREDRESOURCE=>TT_PREFERREDRESOURCES` `TT_PREFERREDRESOURCES`¶

The preference to control which resource type values are considered when generating rightsizing recommendations. You can specify this preference as a combination of include and exclude lists. You must specify either an includeList or excludeList. If the preference is an empty set of resource type values, an error occurs.

You can only set this preference for the Amazon EC2 instance and Amazon EC2 Auto Scaling group resource types.

`iv_savingsestimationmode` `TYPE /AWS1/COPSAVINGSESTIMATIONMODE` `/AWS1/COPSAVINGSESTIMATIONMODE`¶

The status of the savings estimation mode preference to create or update.

Specify the AfterDiscounts status to activate the preference, or specify BeforeDiscounts to deactivate the preference.

Only the account manager or delegated administrator of your organization can activate this preference.

For more information, see Savings estimation mode in the Compute Optimizer User Guide.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_copputrecommendatio01` `/AWS1/CL_COPPUTRECOMMENDATIO01`¶

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->putrecommendationpreferences(
  io_externalmetricspreference = new /aws1/cl_copexternalmetprefe00( |string| )
  io_scope = new /aws1/cl_copscope(
    iv_name = |string|
    iv_value = |string|
  )
  it_preferredresources = VALUE /aws1/cl_coppreferredresource=>tt_preferredresources(
    (
      new /aws1/cl_coppreferredresource(
        it_excludelist = VALUE /aws1/cl_coppreferredresrcva00=>tt_preferredresourcevalues(
          ( new /aws1/cl_coppreferredresrcva00( |string| ) )
        )
        it_includelist = VALUE /aws1/cl_coppreferredresrcva00=>tt_preferredresourcevalues(
          ( new /aws1/cl_coppreferredresrcva00( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  it_utilizationpreferences = VALUE /aws1/cl_coputilizationprefe00=>tt_utilizationpreferences(
    (
      new /aws1/cl_coputilizationprefe00(
        io_metricparameters = new /aws1/cl_copcustizablemetric00(
          iv_headroom = |string|
          iv_threshold = |string|
        )
        iv_metricname = |string|
      )
    )
  )
  iv_enhinfrastructuremetrics = |string|
  iv_inferredworkloadtypes = |string|
  iv_lookbackperiod = |string|
  iv_resourcetype = |string|
  iv_savingsestimationmode = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
ENDIF.

/AWS1/IF_COP=>PUTRECOMMENDATIONPREFERENCES()¶

About PutRecommendationPreferences¶

Method Signature¶

IMPORTING¶

Required arguments:¶

iv_resourcetype TYPE /AWS1/COPRESOURCETYPE /AWS1/COPRESOURCETYPE¶

Optional arguments:¶

io_scope TYPE REF TO /AWS1/CL_COPSCOPE /AWS1/CL_COPSCOPE¶

iv_enhinfrastructuremetrics TYPE /AWS1/COPENHINFRASTRUCTUREMET /AWS1/COPENHINFRASTRUCTUREMET¶

iv_inferredworkloadtypes TYPE /AWS1/COPINFERREDWORKLOADTYP00 /AWS1/COPINFERREDWORKLOADTYP00¶

io_externalmetricspreference TYPE REF TO /AWS1/CL_COPEXTERNALMETPREFE00 /AWS1/CL_COPEXTERNALMETPREFE00¶

iv_lookbackperiod TYPE /AWS1/COPLOOKBACKPERPREFERENCE /AWS1/COPLOOKBACKPERPREFERENCE¶

it_utilizationpreferences TYPE /AWS1/CL_COPUTILIZATIONPREFE00=>TT_UTILIZATIONPREFERENCES TT_UTILIZATIONPREFERENCES¶

it_preferredresources TYPE /AWS1/CL_COPPREFERREDRESOURCE=>TT_PREFERREDRESOURCES TT_PREFERREDRESOURCES¶

iv_savingsestimationmode TYPE /AWS1/COPSAVINGSESTIMATIONMODE /AWS1/COPSAVINGSESTIMATIONMODE¶