Amazon CodeGuru Reviewer
This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 (Amazon Web Services PrivateLink) in the Amazon CodeGuru Reviewer User
Guide .
Endpoints 14
- GETList repository associations
/associations?ProviderType=&State=&Name=&Owner=&MaxResults=0&NextToken=stringReturns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by… - POSTAssociate repository
/associationsUse to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru… - GETList code reviews
/codereviews?ProviderTypes=&States=&RepositoryNames=&Type=string&MaxResults=0&NextToken=stringLists all the code reviews that the customer has created in the past 90 days. - POSTCreate code review
/codereviewsUse to create a code review with a CodeReviewType of RepositoryAnalysis . This type of code review analyzes all code under a specified branch in an associated… - GETDescribe code review
/codereviews/:CodeReviewArnReturns the metadata associated with the code review along with its status. - GETDescribe recommendation feedback
/feedback/:CodeReviewArn?RecommendationId=string&UserId=stringDescribes the customer feedback for a CodeGuru Reviewer recommendation. - GETDescribe repository association
/associations/:AssociationArnReturns a RepositoryAssociation object that contains information about the requested repository association. - DELETEDisassociate repository
/associations/:AssociationArnRemoves the association between Amazon CodeGuru Reviewer and a repository. - GETList recommendation feedback
/feedback/:CodeReviewArn/RecommendationFeedback?NextToken=string&MaxResults=0&UserIds=&RecommendationIds=Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users. - GETList recommendations
/codereviews/:CodeReviewArn/Recommendations?NextToken=string&MaxResults=0Returns the list of all recommendations for a completed code review. - GETList tags for resource
/tags/:resourceArnReturns the list of tags associated with an associated repository resource. - POSTTag resource
/tags/:resourceArnAdds one or more tags to an associated repository. - DELETEUntag resource
/tags/:resourceArn?tagKeys=Removes a tag from an associated repository. - PUTPut recommendation feedback
/feedbackStores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
API details
- Base URL
https://codeguru-reviewer.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 14 operations on 9 pathsGET 8POST 3DELETE 2PUT 1
- Description format
- AWS Smithy model, API version
2019-09-19 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon CodeGuru Reviewer in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon CodeGuru Reviewer collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List repository associations” (GET /associations?ProviderType=&State=&Name=&Owner=&MaxResults=0&NextToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon CodeGuru Reviewer?
This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine… It is listed under Developer tools and has 14 endpoints.
Who publishes the Amazon CodeGuru Reviewer?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon CodeGuru Reviewer?
Requests go to https://codeguru-reviewer.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon CodeGuru Reviewer?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon CodeGuru Reviewer have?
14 operations on 9 paths (8 GET, 3 POST, 2 DELETE, 1 PUT).
Is forking the Amazon CodeGuru Reviewer free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.