Request Syntax Request Parameters Response Elements Errors See Also

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 AWS Compute Optimizer User Guide.

Request Syntax


{
   "enhancedInfrastructureMetrics": "string",
   "externalMetricsPreference": { 
      "source": "string"
   },
   "inferredWorkloadTypes": "string",
   "lookBackPeriod": "string",
   "preferredResources": [ 
      { 
         "excludeList": [ "string" ],
         "includeList": [ "string" ],
         "name": "string"
      }
   ],
   "resourceType": "string",
   "savingsEstimationMode": "string",
   "scope": { 
      "name": "string",
      "value": "string"
   },
   "utilizationPreferences": [ 
      { 
         "metricName": "string",
         "metricParameters": { 
            "headroom": "string",
            "threshold": "string"
         }
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

enhancedInfrastructureMetrics

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 AWS Compute Optimizer User Guide.

Type: String

Valid Values: Active | Inactive

Required: No

externalMetricsPreference

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 AWS Compute Optimizer User Guide.

Type: ExternalMetricsPreference object

Required: No

inferredWorkloadTypes

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

Note

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 AWS Compute Optimizer User Guide.

Type: String

Valid Values: Active | Inactive

Required: No

lookBackPeriod

The preference to control the number of days the utilization metrics of the AWS 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 Auto Scaling group resource types.

Note

Amazon EC2 instance lookback preferences can be set at the organization, account, and resource levels.
Auto Scaling group lookback preferences can only be set at the resource level.

Type: String

Valid Values: DAYS_14 | DAYS_32 | DAYS_93

Required: No

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.

Note

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

Type: Array of PreferredResource objects

Required: No

resourceType

The target resource type of the recommendation preference to create.

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

Type: String

Valid Values: Ec2Instance | AutoScalingGroup | RdsDBInstance

Required: Yes

savingsEstimationMode

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 AWS Compute Optimizer User Guide.

Type: String

Valid Values: AfterDiscounts | BeforeDiscounts

Required: No

scope

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 AWS Compute Optimizer User Guide.

Note

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

Type: Scope object

Required: No

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

Note

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.

Type: Array of UtilizationPreference objects

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400

MissingAuthenticationToken

The request must contain either a valid (registered) AWS access key ID or X.509 certificate.

HTTP Status Code: 400

OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed due to a temporary failure of the server.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400