Package software.amazon.awssdk.services.computeoptimizer.model

Class GetEffectiveRecommendationPreferencesResponse

    • Method Detail

      • enhancedInfrastructureMetrics

        public final EnhancedInfrastructureMetrics 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.

        If the service returns an enum value that is not available in the current SDK version, enhancedInfrastructureMetrics will return EnhancedInfrastructureMetrics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedInfrastructureMetricsAsString().

        Returns:
        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.

        See Also:
        EnhancedInfrastructureMetrics

      • enhancedInfrastructureMetricsAsString

        public final String enhancedInfrastructureMetricsAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, enhancedInfrastructureMetrics will return EnhancedInfrastructureMetrics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from enhancedInfrastructureMetricsAsString().

        Returns:
        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.

        See Also:
        EnhancedInfrastructureMetrics

      • externalMetricsPreference

        public final ExternalMetricsPreference 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.

        Returns:
        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.

      • lookBackPeriod

        public final LookBackPeriodPreference lookBackPeriod()

        The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        If the service returns an enum value that is not available in the current SDK version, lookBackPeriod will return LookBackPeriodPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookBackPeriodAsString().

        Returns:
        The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        See Also:
        LookBackPeriodPreference

      • lookBackPeriodAsString

        public final String lookBackPeriodAsString()

        The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        If the service returns an enum value that is not available in the current SDK version, lookBackPeriod will return LookBackPeriodPreference.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lookBackPeriodAsString().

        Returns:
        The number of days the utilization metrics of the Amazon Web Services resource are analyzed.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        See Also:
        LookBackPeriodPreference

      • hasUtilizationPreferences

        public final boolean hasUtilizationPreferences()
        For responses, this returns true if the service returned a value for the UtilizationPreferences property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • utilizationPreferences

        public final List<UtilizationPreference> utilizationPreferences()

        The resource’s CPU utilization threshold preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasUtilizationPreferences() method.

        Returns:
        The resource’s CPU utilization threshold preferences, such as threshold and headroom, that were used to generate rightsizing recommendations. It considers all applicable preferences that you set at the resource, account, and organization level.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

      • hasPreferredResources

        public final boolean hasPreferredResources()
        For responses, this returns true if the service returned a value for the PreferredResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • preferredResources

        public final List<EffectivePreferredResource> preferredResources()

        The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPreferredResources() method.

        Returns:
        The resource type values that are considered as candidates when generating rightsizing recommendations. This object resolves any wildcard expressions and returns the effective list of candidate resource type values. It also considers all applicable preferences that you set at the resource, account, and organization level.

        To validate that the preference is applied to your last generated set of recommendations, review the effectiveRecommendationPreferences value in the response of the GetAutoScalingGroupRecommendations or GetEC2InstanceRecommendations actions.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object