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 metadaata 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 code review to describe.

--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 code review to describe.

RepositoryName -> (string)

The name of the repository.

Owner -> (string)

The owner of the repository.

ProviderType -> (string)

The provider type of the repository association.

State -> (string)

The state of the code review.

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)

The commit diff for the pull request.

SourceCommit -> (string)

Source Commit SHA.

DestinationCommit -> (string)

Destination Commit SHA

Metrics -> (structure)

The statistics from the code review.

MeteredLinesOfCodeCount -> (long)

Lines of code metered in the code review.

FindingsCount -> (long)

Total number of recommendations found in the code review.