com.amazonaws.services.codegurureviewer

Class AmazonCodeGuruReviewerClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.codegurureviewer.AmazonCodeGuruReviewerClient

All Implemented Interfaces:

AmazonCodeGuruReviewer

Direct Known Subclasses:

AmazonCodeGuruReviewerAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCodeGuruReviewerClient
extends AmazonWebServiceClient
implements AmazonCodeGuruReviewer

Client for accessing CodeGuruReviewer. All service calls made using this client are blocking, and will not return until the service call completes.

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.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.codegurureviewer.AmazonCodeGuruReviewer

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AssociateRepositoryResult	associateRepository(AssociateRepositoryRequest request) Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer.
static AmazonCodeGuruReviewerClientBuilder	builder()
CreateCodeReviewResult	createCodeReview(CreateCodeReviewRequest request) Use to create a code review with a CodeReviewType of RepositoryAnalysis.
DescribeCodeReviewResult	describeCodeReview(DescribeCodeReviewRequest request) Returns the metadata associated with the code review along with its status.
DescribeRecommendationFeedbackResult	describeRecommendationFeedback(DescribeRecommendationFeedbackRequest request) Describes the customer feedback for a CodeGuru Reviewer recommendation.
DescribeRepositoryAssociationResult	describeRepositoryAssociation(DescribeRepositoryAssociationRequest request) Returns a RepositoryAssociation object that contains information about the requested repository association.
DisassociateRepositoryResult	disassociateRepository(DisassociateRepositoryRequest request) 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 request) Lists all the code reviews that the customer has created in the past 90 days.
ListRecommendationFeedbackResult	listRecommendationFeedback(ListRecommendationFeedbackRequest request) Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
ListRecommendationsResult	listRecommendations(ListRecommendationsRequest request) Returns the list of all recommendations for a completed code review.
ListRepositoryAssociationsResult	listRepositoryAssociations(ListRepositoryAssociationsRequest request) Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Returns the list of tags associated with an associated repository resource.
PutRecommendationFeedbackResult	putRecommendationFeedback(PutRecommendationFeedbackRequest request) Stores customer feedback for a CodeGuru Reviewer recommendation.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds one or more tags to an associated repository.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes a tag from an associated repository.
AmazonCodeGuruReviewerWaiters	waiters()

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AmazonCodeGuruReviewerClientBuilder builder()

associateRepository

public AssociateRepositoryResult associateRepository(AssociateRepositoryRequest request)

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.

Specified by:

associateRepository in interface AmazonCodeGuruReviewer

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

createCodeReview

public CreateCodeReviewResult createCodeReview(CreateCodeReviewRequest request)

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.

Specified by:

createCodeReview in interface AmazonCodeGuruReviewer

Parameters:

createCodeReviewRequest -

Returns:

Result of the CreateCodeReview 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.

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.

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

describeCodeReview

public DescribeCodeReviewResult describeCodeReview(DescribeCodeReviewRequest request)

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

Specified by:

describeCodeReview in interface AmazonCodeGuruReviewer

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

public DescribeRecommendationFeedbackResult describeRecommendationFeedback(DescribeRecommendationFeedbackRequest request)

Describes the customer feedback for a CodeGuru Reviewer recommendation.

Specified by:

describeRecommendationFeedback in interface AmazonCodeGuruReviewer

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

public DescribeRepositoryAssociationResult describeRepositoryAssociation(DescribeRepositoryAssociationRequest request)

Returns a RepositoryAssociation object that contains information about the requested repository association.

Specified by:

describeRepositoryAssociation in interface AmazonCodeGuruReviewer

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

public DisassociateRepositoryResult disassociateRepository(DisassociateRepositoryRequest request)

Removes the association between Amazon CodeGuru Reviewer and a repository.

Specified by:

disassociateRepository in interface AmazonCodeGuruReviewer

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

public ListCodeReviewsResult listCodeReviews(ListCodeReviewsRequest request)

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

Specified by:

listCodeReviews in interface AmazonCodeGuruReviewer

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

public ListRecommendationFeedbackResult listRecommendationFeedback(ListRecommendationFeedbackRequest request)

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.

Specified by:

listRecommendationFeedback in interface AmazonCodeGuruReviewer

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

public ListRecommendationsResult listRecommendations(ListRecommendationsRequest request)

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

Specified by:

listRecommendations in interface AmazonCodeGuruReviewer

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

public ListRepositoryAssociationsResult listRepositoryAssociations(ListRepositoryAssociationsRequest request)

Returns 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.

Specified by:

listRepositoryAssociations in interface AmazonCodeGuruReviewer

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

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Returns the list of tags associated with an associated repository resource.

Specified by:

listTagsForResource in interface AmazonCodeGuruReviewer

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource 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.

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

See Also:

AWS API Documentation

putRecommendationFeedback

public PutRecommendationFeedbackResult putRecommendationFeedback(PutRecommendationFeedbackRequest request)

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

Specified by:

putRecommendationFeedback in interface AmazonCodeGuruReviewer

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

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds one or more tags to an associated repository.

Specified by:

tagResource in interface AmazonCodeGuruReviewer

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource 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.

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

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes a tag from an associated repository.

Specified by:

untagResource in interface AmazonCodeGuruReviewer

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource 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.

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

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonCodeGuruReviewer

Parameters:

request - The originally executed request

Returns:

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

waiters

public AmazonCodeGuruReviewerWaiters waiters()

Specified by:

waiters in interface AmazonCodeGuruReviewer

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonCodeGuruReviewer

Overrides:

shutdown in class AmazonWebServiceClient