Skip to content
AWS for Query.Farm

aws.compute_optimizer.get_effective_recommendation_preferences

Example SQL Queries

SELECT * FROM
aws.compute_optimizer.get_effective_recommendation_preferences
WHERE
"resource_arn" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
resource_arn Required Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
enhanced_infrastructure_metrics

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.

VARCHAR
external_metrics_preference

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.

STRUCT(
    "source" VARCHAR
)
Show child fields
external_metrics_preference.source

Contains the source options for external metrics preferences.

look_back_period

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.

VARCHAR
preferred_resources

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.

STRUCT(
    "name" VARCHAR,
    "include_list" VARCHAR[],
    "effective_include_list" VARCHAR[],
    "exclude_list" VARCHAR[]
)[]
Show child fields
preferred_resources[]
Show child fields
preferred_resources[].effective_include_list[]
preferred_resources[].exclude_list[]
preferred_resources[].include_list[]
preferred_resources[].name

The name of the preferred resource list.

utilization_preferences

The resource’s CPU and memory utilization 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.

STRUCT(
    "metric_name" VARCHAR,
    "metric_parameters" STRUCT(
        "threshold" VARCHAR,
        "headroom" VARCHAR
    )
)[]
Show child fields
utilization_preferences[]
Show child fields
utilization_preferences[].metric_name

The name of the resource utilization metric name to customize.

utilization_preferences[].metric_parameters

The parameters to set when customizing the resource utilization thresholds.

Show child fields
utilization_preferences[].metric_parameters.headroom

The headroom value in percentage used for the specified metric parameter.

The following lists the valid values for CPU and memory utilization.

  • CPU utilization: PERCENT_30 | PERCENT_20 | PERCENT_0

  • Memory utilization: PERCENT_30 | PERCENT_20 | PERCENT_10

utilization_preferences[].metric_parameters.threshold

The threshold value used for the specified metric parameter.

You can only specify the threshold value for CPU utilization.