View Source AWS.CodeGuruReviewer (aws-elixir 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.
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.
Link to this section 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
of
RepositoryAnalysis.
Returns the metadata associated with the code review along with its status.
Describes the customer feedback for a CodeGuru Reviewer recommendation.
Returns a RepositoryAssociation object that contains information about the requested repository association.
Removes the association between Amazon CodeGuru Reviewer and a repository.
Lists all the code reviews that the customer has created in the past 90 days.
Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
Returns the list of all recommendations for a completed code review.
Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association.
Returns the list of tags associated with an associated repository resource.
Stores customer feedback for a CodeGuru Reviewer recommendation.
Adds one or more tags to an associated repository.
Removes a tag from an associated repository.
Link to this section 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 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 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 in the CodeGuru Reviewer User Guide.
Use 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 repository. PullRequest code reviews are
automatically triggered by a pull request.
Returns the metadata associated with the code review along with its status.
describe_recommendation_feedback(client, code_review_arn, recommendation_id, user_id \\ nil, options \\ [])
View SourceDescribes the customer feedback for a CodeGuru Reviewer recommendation.
describe_repository_association(client, association_arn, options \\ [])
View SourceReturns a RepositoryAssociation object that contains information about the requested repository association.
disassociate_repository(client, association_arn, input, options \\ [])
View SourceRemoves the association between Amazon CodeGuru Reviewer and a repository.
list_code_reviews(client, max_results \\ nil, next_token \\ nil, provider_types \\ nil, repository_names \\ nil, states \\ nil, type, options \\ [])
View SourceLists all the code reviews that the customer has created in the past 90 days.
list_recommendation_feedback(client, code_review_arn, max_results \\ nil, next_token \\ nil, recommendation_ids \\ nil, user_ids \\ nil, options \\ [])
View SourceReturns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
list_recommendations(client, code_review_arn, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns the list of all recommendations for a completed code review.
list_repository_associations(client, max_results \\ nil, names \\ nil, next_token \\ nil, owners \\ nil, provider_types \\ nil, states \\ nil, options \\ [])
View SourceReturns a list of RepositoryAssociationSummary objects that contain summary information about a repository association.
You can filter the returned list by ProviderType, Name, State, and Owner.
Returns the list of tags associated with an associated repository resource.
Stores customer feedback for a CodeGuru Reviewer recommendation.
When this API is called again with different reactions the previous feedback is overwritten.
Adds one or more tags to an associated repository.
Removes a tag from an associated repository.