Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetRecommendationPreferences

Returns existing recommendation preferences, such as enhanced infrastructure metrics.

Use the scope parameter to specify which preferences to return. You can specify to return preferences for an organization, a specific account ID, or a specific EC2 instance or Auto Scaling group Amazon Resource Name (ARN).

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

Request Syntax


{
   "maxResults": number,
   "nextToken": "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.

maxResults

The maximum number of recommendation preferences to return with a single request.

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1000.

Required: No

nextToken

The token to advance to the next page of recommendation preferences.

Type: String

Required: No

resourceType

The target resource type of the recommendation preference for which to return preferences.

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.

Note

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

Type: String

Valid Values: Ec2Instance | AutoScalingGroup

Required: Yes

scope

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

You can return 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 Syntax


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

Response Elements

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

The following data is returned in JSON format by the service.

nextToken

The token to use to advance to the next page of recommendation preferences.

This value is null when there are no more pages of recommendation preferences to return.

Type: String

recommendationPreferencesDetails

An array of objects that describe recommendation preferences.

Type: Array of RecommendationPreferencesDetail objects

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