Skip to content
AWS for Query.Farm

aws.rds.describe_db_recommendations

Example SQL Queries

SELECT * FROM
aws.rds.describe_db_recommendations;

Description

Describes the recommendations to resolve the issues for your DB instances, DB clusters, and DB parameter groups.

Table Definition

Column NameColumn Data Type
filters Input Column

A filter that specifies one or more recommendations to describe.

Supported Filters:

  • recommendation-id - Accepts a list of recommendation identifiers. The results list only includes the recommendations whose identifier is one of the specified filter values.

  • status - Accepts a list of recommendation statuses.

    Valid values:

    • active - The recommendations which are ready for you to apply.

    • pending - The applied or scheduled recommendations which are in progress.

    • resolved - The recommendations which are completed.

    • dismissed - The recommendations that you dismissed.

    The results list only includes the recommendations whose status is one of the specified filter values.

  • severity - Accepts a list of recommendation severities. The results list only includes the recommendations whose severity is one of the specified filter values.

    Valid values:

    • high

    • medium

    • low

    • informational

  • type-id - Accepts a list of recommendation type identifiers. The results list only includes the recommendations whose type is one of the specified filter values.

  • dbi-resource-id - Accepts a list of database resource identifiers. The results list only includes the recommendations that generated for the specified databases.

  • cluster-resource-id - Accepts a list of cluster resource identifiers. The results list only includes the recommendations that generated for the specified clusters.

  • pg-arn - Accepts a list of parameter group ARNs. The results list only includes the recommendations that generated for the specified parameter groups.

  • cluster-pg-arn - Accepts a list of cluster parameter group ARNs. The results list only includes the recommendations that generated for the specified cluster parameter groups.

STRUCT(
    "name" VARCHAR,
    "values" VARCHAR[]
)[]
Show child fields
filters[]
Show child fields
filters[].name

The name of the filter. Filter names are case-sensitive.

filters[].values[]
last_updated_after Input Column

A filter to include only the recommendations that were updated after this specified time.

TIMESTAMP_S
last_updated_before Input Column

A filter to include only the recommendations that were updated before this specified time.

TIMESTAMP_S
locale Input Column

The language that you choose to return the list of recommendations.

Valid values:

  • en

  • en_UK

  • de

  • es

  • fr

  • id

  • it

  • ja

  • ko

  • pt_BR

  • zh_TW

  • zh_CN 

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
additional_info

Additional information about the recommendation. The information might contain markdown.

VARCHAR
category

The category of the recommendation.

Valid values:

  • performance efficiency

  • security

  • reliability

  • cost optimization

  • operational excellence

  • sustainability 

VARCHAR
created_time

The time when the recommendation was created. For example, 2023-09-28T01:13:53.931000+00:00.

TIMESTAMP_S
description

A detailed description of the recommendation. The description might contain markdown.

VARCHAR
detection

A short description of the issue identified for this recommendation. The description might contain markdown.

VARCHAR
impact

A short description that explains the possible impact of an issue.

VARCHAR
issue_details

Details of the issue that caused the recommendation.

STRUCT(
    "performance_issue_details" STRUCT(
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S,
        "metrics" STRUCT(
            "name" VARCHAR,
            "references" STRUCT(
                "name" VARCHAR,
                "reference_details" STRUCT(
                    "scalar_reference_details" STRUCT(
                        "value" DOUBLE
                    )
                )
            )[],
            "statistics_details" VARCHAR,
            "metric_query" STRUCT(
                "performance_insights_metric_query" STRUCT(
                    "group_by" STRUCT(
                        "dimensions" VARCHAR[],
                        "group" VARCHAR,
                        "limit" BIGINT
                    ),
                    "metric" VARCHAR
                )
            )
        )[],
        "analysis" VARCHAR
    )
)
Show child fields
issue_details.performance_issue_details

A detailed description of the issue when the recommendation category is performance.

Show child fields
issue_details.performance_issue_details.analysis

The analysis of the performance issue. The information might contain markdown.

issue_details.performance_issue_details.end_time

The time when the performance issue stopped.

issue_details.performance_issue_details.metrics[]
Show child fields
issue_details.performance_issue_details.metrics[].metric_query

The query to retrieve metric data points.

Show child fields
issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query

The Performance Insights query that you can use to retrieve Performance Insights metric data points.

Show child fields
issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Show child fields
issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.dimensions[]
issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.group

The available dimension groups for Performance Insights metric type.

issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.limit

The maximum number of items to fetch for this dimension group.

issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.metric

The name of a Performance Insights metric to be measured.

Valid Values:

  • db.load.avg - A scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - The raw number of active sessions for the database engine.

  • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

issue_details.performance_issue_details.metrics[].name

The name of a metric.

issue_details.performance_issue_details.metrics[].references[]
Show child fields
issue_details.performance_issue_details.metrics[].references[].name

The name of the metric reference.

issue_details.performance_issue_details.metrics[].references[].reference_details

The details of a performance issue.

Show child fields
issue_details.performance_issue_details.metrics[].references[].reference_details.scalar_reference_details

The metric reference details when the reference is a scalar.

Show child fields
issue_details.performance_issue_details.metrics[].references[].reference_details.scalar_reference_details.value

The value of a scalar reference.

issue_details.performance_issue_details.metrics[].statistics_details

The details of different statistics for a metric. The description might contain markdown.

issue_details.performance_issue_details.start_time

The time when the performance issue started.

links

A link to documentation that provides additional information about the recommendation.

STRUCT(
    "text" VARCHAR,
    "url" VARCHAR
)[]
Show child fields
links[]
Show child fields
links[].text

The text with the link to documentation for the recommendation.

links[].url

The URL for the documentation for the recommendation.

reason

The reason why this recommendation was created. The information might contain markdown.

VARCHAR
recommendation

A short description of the recommendation to resolve an issue. The description might contain markdown.

VARCHAR
recommendation_id

The unique identifier of the recommendation.

VARCHAR
recommended_actions

A list of recommended actions.

STRUCT(
    "action_id" VARCHAR,
    "title" VARCHAR,
    "description" VARCHAR,
    "operation" VARCHAR,
    "parameters" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "apply_modes" VARCHAR[],
    "status" VARCHAR,
    "issue_details" STRUCT(
        "performance_issue_details" STRUCT(
            "start_time" TIMESTAMP_S,
            "end_time" TIMESTAMP_S,
            "metrics" STRUCT(
                "name" VARCHAR,
                "references" STRUCT(
                    "name" VARCHAR,
                    "reference_details" STRUCT(
                        "scalar_reference_details" STRUCT(
                            "value" DOUBLE
                        )
                    )
                )[],
                "statistics_details" VARCHAR,
                "metric_query" STRUCT(
                    "performance_insights_metric_query" STRUCT(
                        "group_by" STRUCT(
                            "dimensions" VARCHAR[],
                            "group" VARCHAR,
                            "limit" BIGINT
                        ),
                        "metric" VARCHAR
                    )
                )
            )[],
            "analysis" VARCHAR
        )
    ),
    "context_attributes" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[]
)[]
Show child fields
recommended_actions[]
Show child fields
recommended_actions[].action_id

The unique identifier of the recommended action.

recommended_actions[].apply_modes[]
recommended_actions[].context_attributes[]
Show child fields
recommended_actions[].context_attributes[].key

The key of ContextAttribute.

recommended_actions[].context_attributes[].value

The value of ContextAttribute.

recommended_actions[].description

A detailed description of the action. The description might contain markdown.

recommended_actions[].issue_details

The details of the issue.

Show child fields
recommended_actions[].issue_details.performance_issue_details

A detailed description of the issue when the recommendation category is performance.

Show child fields
recommended_actions[].issue_details.performance_issue_details.analysis

The analysis of the performance issue. The information might contain markdown.

recommended_actions[].issue_details.performance_issue_details.end_time

The time when the performance issue stopped.

recommended_actions[].issue_details.performance_issue_details.metrics[]
Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query

The query to retrieve metric data points.

Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query

The Performance Insights query that you can use to retrieve Performance Insights metric data points.

Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.dimensions[]
recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.group

The available dimension groups for Performance Insights metric type.

recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.group_by.limit

The maximum number of items to fetch for this dimension group.

recommended_actions[].issue_details.performance_issue_details.metrics[].metric_query.performance_insights_metric_query.metric

The name of a Performance Insights metric to be measured.

Valid Values:

  • db.load.avg - A scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - The raw number of active sessions for the database engine.

  • The counter metrics listed in Performance Insights operating system counters in the Amazon Aurora User Guide.

If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

recommended_actions[].issue_details.performance_issue_details.metrics[].name

The name of a metric.

recommended_actions[].issue_details.performance_issue_details.metrics[].references[]
Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].references[].name

The name of the metric reference.

recommended_actions[].issue_details.performance_issue_details.metrics[].references[].reference_details

The details of a performance issue.

Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].references[].reference_details.scalar_reference_details

The metric reference details when the reference is a scalar.

Show child fields
recommended_actions[].issue_details.performance_issue_details.metrics[].references[].reference_details.scalar_reference_details.value

The value of a scalar reference.

recommended_actions[].issue_details.performance_issue_details.metrics[].statistics_details

The details of different statistics for a metric. The description might contain markdown.

recommended_actions[].issue_details.performance_issue_details.start_time

The time when the performance issue started.

recommended_actions[].operation

An API operation for the action.

recommended_actions[].parameters[]
Show child fields
recommended_actions[].parameters[].key

The key of the parameter to use with the RecommendedAction API operation.

recommended_actions[].parameters[].value

The value of the parameter to use with the RecommendedAction API operation.

recommended_actions[].status

The status of the action.

  • ready

  • applied

  • scheduled

  • resolved

recommended_actions[].title

A short description to summarize the action. The description might contain markdown.

resource_arn

The Amazon Resource Name (ARN) of the RDS resource associated with the recommendation.

VARCHAR
severity

The severity level of the recommendation. The severity level can help you decide the urgency with which to address the recommendation.

Valid values:

  • high

  • medium

  • low

  • informational 

VARCHAR
source

The Amazon Web Services service that generated the recommendations.

VARCHAR
status

The current status of the recommendation.

Valid values:

  • active - The recommendations which are ready for you to apply.

  • pending - The applied or scheduled recommendations which are in progress.

  • resolved - The recommendations which are completed.

  • dismissed - The recommendations that you dismissed.

VARCHAR
type_detection

A short description of the recommendation type. The description might contain markdown.

VARCHAR
type_id

A value that indicates the type of recommendation. This value determines how the description is rendered.

VARCHAR
type_recommendation

A short description that summarizes the recommendation to fix all the issues of the recommendation type. The description might contain markdown.

VARCHAR
updated_time

The time when the recommendation was last updated.

TIMESTAMP_S