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 ]

describe-code-review

Description

Returns the metadata associated with the code review along with its status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-code-review
--code-review-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--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

CodeReview -> (structure)

Information about the code review.

Name -> (string)

The name of the code review.

CodeReviewArn -> (string)

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

RepositoryName -> (string)

The name of the repository.

Owner -> (string)

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository.

ProviderType -> (string)

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

State -> (string)

The valid code review states are:

  • Completed : The code review is complete.
  • Pending : The code review started and has not completed or failed.
  • Failed : The code review failed.
  • Deleting : The code review is being deleted.

StateReason -> (string)

The reason for the state of the code review.

CreatedTimeStamp -> (timestamp)

The time, in milliseconds since the epoch, when the code review was created.

LastUpdatedTimeStamp -> (timestamp)

The time, in milliseconds since the epoch, when the code review was last updated.

Type -> (string)

The type of code review.

PullRequestId -> (string)

The pull request ID for the code review.

SourceCodeType -> (structure)

The type of the source code for the code review.

CommitDiff -> (structure)

A ` SourceCodeType https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies a commit diff created by a pull request on an associated repository.

SourceCommit -> (string)

The SHA of the source commit used to generate a commit diff.

DestinationCommit -> (string)

The SHA of the destination commit used to generate a commit diff.

RepositoryHead -> (structure)

A ` SourceCodeType https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_SourceCodeType`__ that specifies the tip of a branch in an associated repository.

BranchName -> (string)

The name of the branch in an associated repository. The RepositoryHeadSourceCodeType specifies the tip of this branch.

Metrics -> (structure)

The statistics from the code review.

MeteredLinesOfCodeCount -> (long)

Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.

FindingsCount -> (long)

Total number of recommendations found in the code review.