| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.ComputeOptimizer.GetRecommendationPreferences
Description
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 Compute Optimizer User Guide.
This operation returns paginated results.
Synopsis
- data GetRecommendationPreferences = GetRecommendationPreferences' {}
- newGetRecommendationPreferences :: ResourceType -> GetRecommendationPreferences
- getRecommendationPreferences_maxResults :: Lens' GetRecommendationPreferences (Maybe Natural)
- getRecommendationPreferences_nextToken :: Lens' GetRecommendationPreferences (Maybe Text)
- getRecommendationPreferences_scope :: Lens' GetRecommendationPreferences (Maybe Scope)
- getRecommendationPreferences_resourceType :: Lens' GetRecommendationPreferences ResourceType
- data GetRecommendationPreferencesResponse = GetRecommendationPreferencesResponse' {}
- newGetRecommendationPreferencesResponse :: Int -> GetRecommendationPreferencesResponse
- getRecommendationPreferencesResponse_nextToken :: Lens' GetRecommendationPreferencesResponse (Maybe Text)
- getRecommendationPreferencesResponse_recommendationPreferencesDetails :: Lens' GetRecommendationPreferencesResponse (Maybe [RecommendationPreferencesDetail])
- getRecommendationPreferencesResponse_httpStatus :: Lens' GetRecommendationPreferencesResponse Int
Creating a Request
data GetRecommendationPreferences Source #
See: newGetRecommendationPreferences smart constructor.
Constructors
| GetRecommendationPreferences' | |
Fields
| |
Instances
newGetRecommendationPreferences Source #
Create a value of GetRecommendationPreferences with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:GetRecommendationPreferences', getRecommendationPreferences_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.
GetRecommendationPreferences, getRecommendationPreferences_nextToken - The token to advance to the next page of recommendation preferences.
GetRecommendationPreferences, getRecommendationPreferences_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 Compute Optimizer User Guide.
GetRecommendationPreferences, getRecommendationPreferences_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.
The valid values for this parameter are Ec2Instance and
AutoScalingGroup.
Request Lenses
getRecommendationPreferences_maxResults :: Lens' GetRecommendationPreferences (Maybe Natural) Source #
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.
getRecommendationPreferences_nextToken :: Lens' GetRecommendationPreferences (Maybe Text) Source #
The token to advance to the next page of recommendation preferences.
getRecommendationPreferences_scope :: Lens' GetRecommendationPreferences (Maybe Scope) Source #
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 Compute Optimizer User Guide.
getRecommendationPreferences_resourceType :: Lens' GetRecommendationPreferences ResourceType Source #
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.
The valid values for this parameter are Ec2Instance and
AutoScalingGroup.
Destructuring the Response
data GetRecommendationPreferencesResponse Source #
See: newGetRecommendationPreferencesResponse smart constructor.
Constructors
| GetRecommendationPreferencesResponse' | |
Fields
| |
Instances
newGetRecommendationPreferencesResponse Source #
Arguments
| :: Int | |
| -> GetRecommendationPreferencesResponse |
Create a value of GetRecommendationPreferencesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetRecommendationPreferences, getRecommendationPreferencesResponse_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.
$sel:recommendationPreferencesDetails:GetRecommendationPreferencesResponse', getRecommendationPreferencesResponse_recommendationPreferencesDetails - An array of objects that describe recommendation preferences.
$sel:httpStatus:GetRecommendationPreferencesResponse', getRecommendationPreferencesResponse_httpStatus - The response's http status code.
Response Lenses
getRecommendationPreferencesResponse_nextToken :: Lens' GetRecommendationPreferencesResponse (Maybe Text) Source #
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.
getRecommendationPreferencesResponse_recommendationPreferencesDetails :: Lens' GetRecommendationPreferencesResponse (Maybe [RecommendationPreferencesDetail]) Source #
An array of objects that describe recommendation preferences.
getRecommendationPreferencesResponse_httpStatus :: Lens' GetRecommendationPreferencesResponse Int Source #
The response's http status code.