amazonaws.com – codeguru-reviewer
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 .
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 in the Amazon CodeGuru Reviewer User Guide.
- Homepage
- https://api.apis.guru/v2/specs/amazonaws.com:codeguru-reviewer/2019-09-19.json
- Provider
- amazonaws.com:codeguru-reviewer / codeguru-reviewer
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/amazonaws.com/codeguru-reviewer/2019-09-19/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/amazonaws.com/codeguru-reviewer/2019-09-19/openapi.yaml
Tools (16)
Extracted live via the executor SDK.
-
associations.associateRepositoryUse to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see in the Amazon CodeGuru Reviewer User Guide.
If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar Connections to connect to CodeGuru Reviewer. For more information, see in the Amazon CodeGuru Reviewer User Guide.
You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see in the CodeGuru Reviewer User Guide.
-
associations.describeRepositoryAssociationReturns a object that contains information about the requested repository association.
-
associations.disassociateRepositoryRemoves the association between Amazon CodeGuru Reviewer and a repository.
-
associations.listRepositoryAssociationsReturns a list of objects that contain summary information about a repository association. You can filter the returned list by , , , and .
-
codereviews.createCodeReviewUse to create a code review with a of
RepositoryAnalysis. This type of code review analyzes all code under a specified branch in an associated repository.PullRequestcode reviews are automatically triggered by a pull request. -
codereviews.describeCodeReviewReturns the metadata associated with the code review along with its status.
-
codereviews.listRecommendationsReturns the list of all recommendations for a completed code review.
-
codereviewsType.listCodeReviewsLists all the code reviews that the customer has created in the past 90 days.
-
feedback.describeRecommendationFeedbackDescribes the customer feedback for a CodeGuru Reviewer recommendation.
-
feedback.listRecommendationFeedbackReturns a list of objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
-
feedback.putRecommendationFeedbackStores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
-
tags.listTagsForResourceReturns the list of tags associated with an associated repository resource.
-
tags.tagResourceAdds one or more tags to an associated repository.
-
tags.untagResourceRemoves a tag from an associated repository.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools