DeleteRecommendationPreferences
Deletes a recommendation preference, such as enhanced infrastructure metrics.
For more information, see Activating enhanced infrastructure metrics in the AWS Compute Optimizer User Guide.
Request Syntax
{
"recommendationPreferenceNames": [ "string
" ],
"resourceType": "string
",
"scope": {
"name": "string
",
"value": "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.
- recommendationPreferenceNames
-
The name of the recommendation preference to delete.
Type: Array of strings
Valid Values:
EnhancedInfrastructureMetrics | InferredWorkloadTypes | ExternalMetricsPreference | LookBackPeriodPreference | PreferredResources | UtilizationPreferences
Required: Yes
- resourceType
-
The target resource type of the recommendation preference to delete.
The
Ec2Instance
option encompasses standalone instances and instances that are part of Auto Scaling groups. TheAutoScalingGroup
option encompasses only instances that are part of an Auto Scaling group.Type: String
Valid Values:
Ec2Instance | AutoScalingGroup | RdsDBInstance
Required: Yes
- scope
-
An object that describes the scope of the recommendation preference to delete.
You can delete recommendation preferences that are created 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.
Type: Scope object
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: