| 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.GetEffectiveRecommendationPreferences
Description
Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.
When you create a recommendation preference, you can set its status to
Active or Inactive. Use this action to view the recommendation
preferences that are in effect, or Active.
Synopsis
- data GetEffectiveRecommendationPreferences = GetEffectiveRecommendationPreferences' {
- resourceArn :: Text
- newGetEffectiveRecommendationPreferences :: Text -> GetEffectiveRecommendationPreferences
- getEffectiveRecommendationPreferences_resourceArn :: Lens' GetEffectiveRecommendationPreferences Text
- data GetEffectiveRecommendationPreferencesResponse = GetEffectiveRecommendationPreferencesResponse' {}
- newGetEffectiveRecommendationPreferencesResponse :: Int -> GetEffectiveRecommendationPreferencesResponse
- getEffectiveRecommendationPreferencesResponse_enhancedInfrastructureMetrics :: Lens' GetEffectiveRecommendationPreferencesResponse (Maybe EnhancedInfrastructureMetrics)
- getEffectiveRecommendationPreferencesResponse_externalMetricsPreference :: Lens' GetEffectiveRecommendationPreferencesResponse (Maybe ExternalMetricsPreference)
- getEffectiveRecommendationPreferencesResponse_httpStatus :: Lens' GetEffectiveRecommendationPreferencesResponse Int
Creating a Request
data GetEffectiveRecommendationPreferences Source #
See: newGetEffectiveRecommendationPreferences smart constructor.
Constructors
| GetEffectiveRecommendationPreferences' | |
Fields
| |
Instances
newGetEffectiveRecommendationPreferences Source #
Arguments
| :: Text | |
| -> GetEffectiveRecommendationPreferences |
Create a value of GetEffectiveRecommendationPreferences 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:resourceArn:GetEffectiveRecommendationPreferences', getEffectiveRecommendationPreferences_resourceArn - The Amazon Resource Name (ARN) of the resource for which to confirm
effective recommendation preferences. Only EC2 instance and Auto Scaling
group ARNs are currently supported.
Request Lenses
getEffectiveRecommendationPreferences_resourceArn :: Lens' GetEffectiveRecommendationPreferences Text Source #
The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.
Destructuring the Response
data GetEffectiveRecommendationPreferencesResponse Source #
See: newGetEffectiveRecommendationPreferencesResponse smart constructor.
Constructors
| GetEffectiveRecommendationPreferencesResponse' | |
Fields
| |
Instances
newGetEffectiveRecommendationPreferencesResponse Source #
Arguments
| :: Int |
|
| -> GetEffectiveRecommendationPreferencesResponse |
Create a value of GetEffectiveRecommendationPreferencesResponse 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:
GetEffectiveRecommendationPreferencesResponse, getEffectiveRecommendationPreferencesResponse_enhancedInfrastructureMetrics - The status of the enhanced infrastructure metrics recommendation
preference. Considers all applicable preferences that you might have set
at the resource, account, and organization level.
A status of Active confirms that the preference is applied in the
latest recommendation refresh, and a status of Inactive confirms that
it's not yet applied to recommendations.
To validate whether the preference is applied to your last generated set
of recommendations, review the effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations and
GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
GetEffectiveRecommendationPreferencesResponse, getEffectiveRecommendationPreferencesResponse_externalMetricsPreference - The provider of the external metrics recommendation preference.
Considers all applicable preferences that you might have set at the
account and organization level.
If the preference is applied in the latest recommendation refresh, an
object with a valid source value appears in the response. If the
preference isn't applied to the recommendations already, then this
object doesn't appear in the response.
To validate whether the preference is applied to your last generated set
of recommendations, review the effectiveRecommendationPreferences
value in the response of the GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
$sel:httpStatus:GetEffectiveRecommendationPreferencesResponse', getEffectiveRecommendationPreferencesResponse_httpStatus - The response's http status code.
Response Lenses
getEffectiveRecommendationPreferencesResponse_enhancedInfrastructureMetrics :: Lens' GetEffectiveRecommendationPreferencesResponse (Maybe EnhancedInfrastructureMetrics) Source #
The status of the enhanced infrastructure metrics recommendation preference. Considers all applicable preferences that you might have set at the resource, account, and organization level.
A status of Active confirms that the preference is applied in the
latest recommendation refresh, and a status of Inactive confirms that
it's not yet applied to recommendations.
To validate whether the preference is applied to your last generated set
of recommendations, review the effectiveRecommendationPreferences
value in the response of the GetAutoScalingGroupRecommendations and
GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
getEffectiveRecommendationPreferencesResponse_externalMetricsPreference :: Lens' GetEffectiveRecommendationPreferencesResponse (Maybe ExternalMetricsPreference) Source #
The provider of the external metrics recommendation preference. Considers all applicable preferences that you might have set at the account and organization level.
If the preference is applied in the latest recommendation refresh, an
object with a valid source value appears in the response. If the
preference isn't applied to the recommendations already, then this
object doesn't appear in the response.
To validate whether the preference is applied to your last generated set
of recommendations, review the effectiveRecommendationPreferences
value in the response of the GetEC2InstanceRecommendations actions.
For more information, see Enhanced infrastructure metrics in the Compute Optimizer User Guide.
getEffectiveRecommendationPreferencesResponse_httpStatus :: Lens' GetEffectiveRecommendationPreferencesResponse Int Source #
The response's http status code.