View Source aws_codeguru_reviewer (aws v1.0.4)
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: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html.
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): https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html in the Amazon CodeGuru Reviewer User Guide.Summary
Functions
Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer.
Use to create a code review with a CodeReviewType: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html of RepositoryAnalysis.
Returns a list of RepositoryAssociationSummary: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html objects that contain summary information about a repository association.
Stores customer feedback for a CodeGuru Reviewer recommendation.
Functions
Use 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 Recommendations in Amazon CodeGuru Reviewer: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html 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 Associate a repository: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html 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 Getting started with CodeGuru Reviewer: https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html in the CodeGuru Reviewer User Guide.Use to create a code review with a CodeReviewType: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html of RepositoryAnalysis.
PullRequest code reviews are automatically triggered by a pull request.
describe_code_review(Client, CodeReviewArn, QueryMap, HeadersMap, Options0)
View Sourcedescribe_recommendation_feedback(Client, CodeReviewArn, RecommendationId)
View Sourcedescribe_recommendation_feedback(Client, CodeReviewArn, RecommendationId, QueryMap, HeadersMap)
View Sourcedescribe_recommendation_feedback(Client, CodeReviewArn, RecommendationId, QueryMap, HeadersMap, Options0)
View Sourcedescribe_repository_association(Client, AssociationArn, QueryMap, HeadersMap)
View Sourcedescribe_repository_association(Client, AssociationArn, QueryMap, HeadersMap, Options0)
View Sourcelist_recommendation_feedback(Client, CodeReviewArn, QueryMap, HeadersMap)
View Sourcelist_recommendation_feedback(Client, CodeReviewArn, QueryMap, HeadersMap, Options0)
View Sourcelist_recommendations(Client, CodeReviewArn, QueryMap, HeadersMap, Options0)
View SourceReturns a list of RepositoryAssociationSummary: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html objects that contain summary information about a repository association.
You can filter the returned list by ProviderType: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType, Name: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name, State: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State, and Owner: https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner.list_repository_associations(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceStores customer feedback for a CodeGuru Reviewer recommendation.
When this API is called again with different reactions the previous feedback is overwritten.