BranchDiffSourceCodeType
A type of SourceCodeType that specifies a code diff between a source and destination branch in an associated repository.
Contents
DestinationBranchName
The destination branch for a diff in an associated repository.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes SourceBranchName
The source branch for a diff in an associated repository.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeArtifacts
CodeArtifacts
Code artifacts are source code artifacts and build artifacts used in a repository analysis or a pull request review.
• Source code artifacts are source code files in a Git repository that are compressed into a .zip file.
• Build artifacts are .jar or .class files that are compressed in a .zip file.
Contents
BuildArtifactsObjectKey
The S3 object key for a build artifacts .zip file that contains .jar or .class files. This is required for a code review with security analysis. For more information, see Create code reviews with security analysis in the Amazon CodeGuru Reviewer User Guide.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^\S(.*\S)?$
Required: No
SourceCodeArtifactsObjectKey
The S3 object key for a source code .zip file. This is required for all code reviews.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: ^\S(.*\S)?$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeCommitRepository
CodeCommitRepository
Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Contents
Name
The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern: ^\S[\w.-]*$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeReview
CodeReview
Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
Contents
AnalysisTypes
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
Type: Array of strings
Valid Values: Security | CodeQuality Required: No
AssociationArn
The Amazon Resource Name (ARN) of the RepositoryAssociation that contains the reviewed source code. You can retrieve associated repository ARNs by calling ListRepositoryAssociations.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Pattern: ^arn:aws[^:\s]*:codeguru-reviewer:[^:\s]+:[\d]{12}:association:[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
Required: No 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.
Contents
Type: Metrics (p. 60) 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. For an S3 repository, it can be the username or AWS account ID.
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 | S3Bucket
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.
See Also
Type: SourceCodeType (p. 83) 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:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeReviewSummary
CodeReviewSummary
Information about the summary of the 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 MetricsSummary
The statistics from the code review.
Type: MetricsSummary (p. 61) 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. For an S3 repository, it can be the username or AWS account ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Contents
Pattern: ^\S(.*\S)?$
Required: No ProviderType
The provider type of the repository association.
Type: String
Valid Values: CodeCommit | GitHub | Bitbucket | GitHubEnterpriseServer | S3Bucket
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
Specifies the source code that is analyzed in a code review.
Type: SourceCodeType (p. 83) object Required: No
State
The state of the code review.
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
Type
The type of the code review.
See Also
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:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
CodeReviewType
CodeReviewType
The type of a code review. There are two code review types:
• PullRequest - A code review that is automatically triggered by a pull request on an associated repository.
• RepositoryAnalysis - A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview.
Contents
AnalysisTypes
They types of analysis performed during a repository analysis or a pull request review. You can specify either Security, CodeQuality, or both.
Type: Array of strings
Valid Values: Security | CodeQuality Required: No
RepositoryAnalysis
A code review that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN in CreateCodeReview.
Type: RepositoryAnalysis (p. 68) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3