Expand description
This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java and Python code.
By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by creating an interface VPC endpoint. For more information, see CodeGuru Reviewer and interface VPC endpoints (AWS PrivateLink) in the Amazon CodeGuru Reviewer User Guide.
If you’re using the service, you’re probably looking for CodeGuruReviewerClient and CodeGuruReviewer.
Structs§
- Associate
Repository Request - Associate
Repository Response - Branch
Diff Source Code Type A type of
SourceCodeTypethat specifies a code diff between a source and destination branch in an associated repository.- Code
Artifacts 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.
-
- Code
Commit Repository 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.
- Code
Guru Reviewer Client - A client for the CodeGuruReviewer API.
- Code
Review Information about a code review. A code review belongs to the associated repository that contains the reviewed code.
- Code
Review Summary Information about the summary of the code review.
- Code
Review Type 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 inCreateCodeReview.
-
- Commit
Diff Source Code Type A type of
SourceCodeTypethat specifies the commit diff for a pull request on an associated repository. TheSourceCommitandDestinationCommitfields are required to do a pull request code review.- Create
Code Review Request - Create
Code Review Response - Describe
Code Review Request - Describe
Code Review Response - Describe
Recommendation Feedback Request - Describe
Recommendation Feedback Response - Describe
Repository Association Request - Describe
Repository Association Response - Disassociate
Repository Request - Disassociate
Repository Response - Event
Info Information about an event. The event might be a push, pull request, scheduled request, or another type of event.
- KMSKey
Details An object that contains:
-
The encryption option for a repository association. It is either owned by AWS Key Management Service (KMS) (
AWSOWNEDCMK) or customer managed (CUSTOMERMANAGEDCMK). -
The ID of the AWS KMS key that is associated with a respository association.
-
- List
Code Reviews Request - List
Code Reviews Response - List
Recommendation Feedback Request - List
Recommendation Feedback Response - List
Recommendations Request - List
Recommendations Response - List
Repository Associations Request - List
Repository Associations Response - List
Tags ForResource Request - List
Tags ForResource Response - Metrics
Information about the statistics from the code review.
- Metrics
Summary Information about metrics summaries.
- PutRecommendation
Feedback Request - PutRecommendation
Feedback Response - Recommendation
Feedback Information about the recommendation feedback.
- Recommendation
Feedback Summary Information about recommendation feedback summaries.
- Recommendation
Summary Information about recommendations.
- Repository
Information about an associated AWS CodeCommit repository or an associated repository that is managed by AWS CodeStar Connections (for example, Bitbucket). This
Repositoryobject is not used if your source code is in an associated GitHub repository.- Repository
Analysis A code review type that analyzes all code under a specified branch in an associated repository. The associated repository is specified using its ARN when you call
CreateCodeReview.- Repository
Association Information about a repository association. The
DescribeRepositoryAssociationoperation returns aRepositoryAssociationobject.- Repository
Association Summary Summary information about a repository association. The
ListRepositoryAssociationsoperation returns a list ofRepositoryAssociationSummaryobjects.- Repository
Head Source Code Type A
SourceCodeTypethat specifies the tip of a branch in an associated repository.- Request
Metadata Metadata that is associated with a code review. This applies to both pull request and repository analysis code reviews.
- S3Bucket
Repository Information about an associated repository in an S3 bucket. The associated repository contains a source code .zip file and a build artifacts .zip file that contains .jar or .class files.
- S3Repository
Information about a repository in an S3 bucket.
- S3Repository
Details Specifies the name of an S3 bucket and a
CodeArtifactsobject that contains the S3 object keys for a source code .zip file and for a build artifacts .zip file that contains .jar or .class files.- Source
Code Type Specifies the source code that is analyzed in a code review.
- TagResource
Request - TagResource
Response - Third
Party Source Repository Information about a third-party source repository connected to CodeGuru Reviewer.
- Untag
Resource Request - Untag
Resource Response
Enums§
- Associate
Repository Error - Errors returned by AssociateRepository
- Create
Code Review Error - Errors returned by CreateCodeReview
- Describe
Code Review Error - Errors returned by DescribeCodeReview
- Describe
Recommendation Feedback Error - Errors returned by DescribeRecommendationFeedback
- Describe
Repository Association Error - Errors returned by DescribeRepositoryAssociation
- Disassociate
Repository Error - Errors returned by DisassociateRepository
- List
Code Reviews Error - Errors returned by ListCodeReviews
- List
Recommendation Feedback Error - Errors returned by ListRecommendationFeedback
- List
Recommendations Error - Errors returned by ListRecommendations
- List
Repository Associations Error - Errors returned by ListRepositoryAssociations
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- PutRecommendation
Feedback Error - Errors returned by PutRecommendationFeedback
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
Traits§
- Code
Guru Reviewer - Trait representing the capabilities of the CodeGuruReviewer API. CodeGuruReviewer clients implement this trait.