com.amazonaws.services.codegurureviewer

Interface AmazonCodeGuruReviewer

All Known Subinterfaces:

AmazonCodeGuruReviewerAsync

All Known Implementing Classes:

AbstractAmazonCodeGuruReviewer, AbstractAmazonCodeGuruReviewerAsync, AmazonCodeGuruReviewerAsyncClient, AmazonCodeGuruReviewerClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCodeGuruReviewer

Interface for accessing CodeGuruReviewer.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCodeGuruReviewer instead.

This section provides documentation for the Amazon CodeGuru Reviewer API operations. Amazon 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateRepositoryResult	associateRepository(AssociateRepositoryRequest associateRepositoryRequest) Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer.
DescribeCodeReviewResult	describeCodeReview(DescribeCodeReviewRequest describeCodeReviewRequest) Returns the metadaata associated with the code review along with its status.
DescribeRecommendationFeedbackResult	describeRecommendationFeedback(DescribeRecommendationFeedbackRequest describeRecommendationFeedbackRequest) Describes the customer feedback for a CodeGuru Reviewer recommendation.
DescribeRepositoryAssociationResult	describeRepositoryAssociation(DescribeRepositoryAssociationRequest describeRepositoryAssociationRequest) Describes a repository association.
DisassociateRepositoryResult	disassociateRepository(DisassociateRepositoryRequest disassociateRepositoryRequest) Removes the association between Amazon CodeGuru Reviewer and a repository.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
ListCodeReviewsResult	listCodeReviews(ListCodeReviewsRequest listCodeReviewsRequest) Lists all the code reviews that the customer has created in the past 90 days.
ListRecommendationFeedbackResult	listRecommendationFeedback(ListRecommendationFeedbackRequest listRecommendationFeedbackRequest) Lists the customer feedback for a CodeGuru Reviewer recommendation for all users.
ListRecommendationsResult	listRecommendations(ListRecommendationsRequest listRecommendationsRequest) Returns the list of all recommendations for a completed code review.
ListRepositoryAssociationsResult	listRepositoryAssociations(ListRepositoryAssociationsRequest listRepositoryAssociationsRequest) Lists repository associations.
PutRecommendationFeedbackResult	putRecommendationFeedback(PutRecommendationFeedbackRequest putRecommendationFeedbackRequest) Stores customer feedback for a CodeGuru-Reviewer recommendation.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateRepository

AssociateRepositoryResult associateRepository(AssociateRepositoryRequest associateRepositoryRequest)

Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.

You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.

Parameters:

associateRepositoryRequest -

Returns:

Result of the AssociateRepository operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeCodeReview

DescribeCodeReviewResult describeCodeReview(DescribeCodeReviewRequest describeCodeReviewRequest)

Returns the metadaata associated with the code review along with its status.

Parameters:

describeCodeReviewRequest -

Returns:

Result of the DescribeCodeReview operation returned by the service.

Throws:

ResourceNotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeRecommendationFeedback

DescribeRecommendationFeedbackResult describeRecommendationFeedback(DescribeRecommendationFeedbackRequest describeRecommendationFeedbackRequest)

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Parameters:

describeRecommendationFeedbackRequest -

Returns:

Result of the DescribeRecommendationFeedback operation returned by the service.

Throws:

ResourceNotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

describeRepositoryAssociation

DescribeRepositoryAssociationResult describeRepositoryAssociation(DescribeRepositoryAssociationRequest describeRepositoryAssociationRequest)

Describes a repository association.

Parameters:

describeRepositoryAssociationRequest -

Returns:

Result of the DescribeRepositoryAssociation operation returned by the service.

Throws:

NotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

disassociateRepository

DisassociateRepositoryResult disassociateRepository(DisassociateRepositoryRequest disassociateRepositoryRequest)

Removes the association between Amazon CodeGuru Reviewer and a repository.

Parameters:

disassociateRepositoryRequest -

Returns:

Result of the DisassociateRepository operation returned by the service.

Throws:

NotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ConflictException - The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listCodeReviews

ListCodeReviewsResult listCodeReviews(ListCodeReviewsRequest listCodeReviewsRequest)

Lists all the code reviews that the customer has created in the past 90 days.

Parameters:

listCodeReviewsRequest -

Returns:

Result of the ListCodeReviews operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

ThrottlingException - The request was denied due to request throttling.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listRecommendationFeedback

ListRecommendationFeedbackResult listRecommendationFeedback(ListRecommendationFeedbackRequest listRecommendationFeedbackRequest)

Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations.

Parameters:

listRecommendationFeedbackRequest -

Returns:

Result of the ListRecommendationFeedback operation returned by the service.

Throws:

ResourceNotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listRecommendations

ListRecommendationsResult listRecommendations(ListRecommendationsRequest listRecommendationsRequest)

Returns the list of all recommendations for a completed code review.

Parameters:

listRecommendationsRequest -

Returns:

Result of the ListRecommendations operation returned by the service.

Throws:

ResourceNotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

listRepositoryAssociations

ListRepositoryAssociationsResult listRepositoryAssociations(ListRepositoryAssociationsRequest listRepositoryAssociationsRequest)

Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.

Parameters:

listRepositoryAssociationsRequest -

Returns:

Result of the ListRepositoryAssociations operation returned by the service.

Throws:

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

putRecommendationFeedback

PutRecommendationFeedbackResult putRecommendationFeedback(PutRecommendationFeedbackRequest putRecommendationFeedbackRequest)

Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.

Parameters:

putRecommendationFeedbackRequest -

Returns:

Result of the PutRecommendationFeedback operation returned by the service.

Throws:

ResourceNotFoundException - The resource specified in the request was not found.

InternalServerException - The server encountered an internal error and is unable to complete the request.

ValidationException - The input fails to satisfy the specified constraints.

AccessDeniedException - You do not have sufficient access to perform this action.

ThrottlingException - The request was denied due to request throttling.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.