Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.
See https://www.paws-r-sdk.com/docs/computeoptimizer_put_recommendation_preferences/ for full documentation.
computeoptimizer_put_recommendation_preferences(
resourceType,
scope = NULL,
enhancedInfrastructureMetrics = NULL,
inferredWorkloadTypes = NULL,
externalMetricsPreference = NULL,
lookBackPeriod = NULL,
utilizationPreferences = NULL,
preferredResources = NULL,
savingsEstimationMode = NULL
)[required] 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.
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 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.
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.
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.
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
delete_recommendation_preferences
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.
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 Auto Scaling group resource types.
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.
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.
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 Auto Scaling group resource types.
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.