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 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.
If you’re using the service, you’re probably looking for CodeGuruReviewerClient and CodeGuruReviewer.
Structs§
- Associate
Repository Request - Associate
Repository Response - 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.
- Code
Review Summary Information about the summary of the code review.
- Commit
Diff Source Code Type The commit diff for the pull request.
- 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 - 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 - 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
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.- Source
Code Type Information about the source code type.
- Third
Party Source Repository Information about a third-party source repository connected to CodeGuru Reviewer.
Enums§
- Associate
Repository Error - Errors returned by AssociateRepository
- 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
- PutRecommendation
Feedback Error - Errors returned by PutRecommendationFeedback
Traits§
- Code
Guru Reviewer - Trait representing the capabilities of the CodeGuruReviewer API. CodeGuruReviewer clients implement this trait.