CodeReview - Amazon CodeGuru Reviewer

CodeReview

Information about a code review.

Contents

CodeReviewArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:[a-z-]+:[\w-]+$

Required: No

CreatedTimeStamp

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

Type: Timestamp

Required: No

LastUpdatedTimeStamp

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

Type: Timestamp

Required: No

Metrics

The statistics from the code review.

Type: Metrics object

Required: No

Name

The name of the code review.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S[\w.-]*$

Required: No

Owner

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S(.*\S)?$

Required: No

ProviderType

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

Type: String

Valid Values: CodeCommit | GitHub | Bitbucket | GitHubEnterpriseServer

Required: No

PullRequestId

The pull request ID for the code review.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: No

RepositoryName

The name of the repository.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S[\w.-]*$

Required: No

SourceCodeType

The type of the source code for the code review.

Type: SourceCodeType object

Required: No

State

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.

Type: String

Valid Values: Completed | Pending | Failed | Deleting

Required: No

StateReason

The reason for the state of the code review.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

Type

The type of code review.

Type: String

Valid Values: PullRequest | RepositoryAnalysis

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: