Skip to content
AWS for Query.Farm

aws.codeguru_reviewer.list_recommendations

Example SQL Queries

SELECT * FROM
aws.codeguru_reviewer.list_recommendations
WHERE
"code_review_arn" = 'VALUE';

Description

Returns the list of all recommendations for a completed code review.

Table Definition

Column NameColumn Data Type
code_review_arn Required Input Column

The Amazon Resource Name (ARN) of the CodeReview object. 

VARCHAR
max_results Input Column

The maximum number of results that are returned per call. The default is 100.

BIGINT
next_token Input Column

Pagination token.

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
recommendation_summaries

List of recommendations for the requested code review.

STRUCT(
    "file_path" VARCHAR,
    "recommendation_id" VARCHAR,
    "start_line" BIGINT,
    "end_line" BIGINT,
    "description" VARCHAR,
    "recommendation_category" VARCHAR,
    "rule_metadata" STRUCT(
        "rule_id" VARCHAR,
        "rule_name" VARCHAR,
        "short_description" VARCHAR,
        "long_description" VARCHAR,
        "rule_tags" VARCHAR[]
    ),
    "severity" VARCHAR
)[]
Show child fields
recommendation_summaries[]
Show child fields
recommendation_summaries[].description

A description of the recommendation generated by CodeGuru Reviewer for the lines of code between the start line and the end line.

recommendation_summaries[].end_line

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

recommendation_summaries[].file_path

Name of the file on which a recommendation is provided.

recommendation_summaries[].recommendation_category

The type of a recommendation.

recommendation_summaries[].recommendation_id

The recommendation ID that can be used to track the provided recommendations. Later on it can be used to collect the feedback.

recommendation_summaries[].rule_metadata

Metadata about a rule. Rule metadata includes an ID, a name, a list of tags, and a short and long description. CodeGuru Reviewer uses rules to analyze code. A rule's recommendation is included in analysis results if code is detected that violates the rule.

Show child fields
recommendation_summaries[].rule_metadata.long_description

A long description of the rule.

recommendation_summaries[].rule_metadata.rule_id

The ID of the rule.

recommendation_summaries[].rule_metadata.rule_name

The name of the rule.

recommendation_summaries[].rule_metadata.rule_tags[]
recommendation_summaries[].rule_metadata.short_description

A short description of the rule.

recommendation_summaries[].severity

The severity of the issue in the code that generated this recommendation.

recommendation_summaries[].start_line

Start line from where the recommendation is applicable in the source commit or source branch.