Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . codeguru-reviewer ]

list-recommendations

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-recommendations
[--next-token <value>]
[--max-results <value>]
--code-review-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (string)

Pagination token.

--max-results (integer)

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

--code-review-arn (string)

The Amazon Resource Name (ARN) of the ` CodeReview https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReview.html`__ object.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

RecommendationSummaries -> (list)

List of recommendations for the requested code review.

(structure)

Information about recommendations.

FilePath -> (string)

Name of the file on which a recommendation is provided.

RecommendationId -> (string)

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

StartLine -> (integer)

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

EndLine -> (integer)

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.

Description -> (string)

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

NextToken -> (string)

Pagination token.