Amazon Compute Optimizer · Schema
GetRecommendationPreferencesRequest
GetRecommendationPreferencesRequest schema
Cost OptimizationFinOpsMachine LearningResource Recommendations
Properties
| Name | Type | Description |
|---|---|---|
| resourceType | object | |
| scope | object | |
| nextToken | object | |
| maxResults | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-compute-optimizer/refs/heads/main/json-schema/compute-optimizer-get-recommendation-preferences-request-schema.json",
"title": "GetRecommendationPreferencesRequest",
"description": "GetRecommendationPreferencesRequest schema",
"type": "object",
"properties": {
"resourceType": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceType"
},
{
"description": "<p>The target resource type of the recommendation preference for which to return preferences.</p> <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p> <note> <p>The valid values for this parameter are <code>Ec2Instance</code> and <code>AutoScalingGroup</code>.</p> </note>"
}
]
},
"scope": {
"allOf": [
{
"$ref": "#/components/schemas/Scope"
},
{
"description": "<p>An object that describes the scope of the recommendation preference to return.</p> <p>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 <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html\">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>"
}
]
},
"nextToken": {
"allOf": [
{
"$ref": "#/components/schemas/NextToken"
},
{
"description": "The token to advance to the next page of recommendation preferences."
}
]
},
"maxResults": {
"allOf": [
{
"$ref": "#/components/schemas/MaxResults"
},
{
"description": "<p>The maximum number of recommendation preferences to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>"
}
]
}
},
"required": [
"resourceType"
]
}