AmazonCodeGuruReviewer (AWS Java SDK for Amazon CodeGuru Reviewer 1.12.343 API)

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. 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
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateRepositoryResult`	`associateRepository(AssociateRepositoryRequest associateRepositoryRequest)` Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer.
`CreateCodeReviewResult`	`createCodeReview(CreateCodeReviewRequest createCodeReviewRequest)` Use to create a code review with a CodeReviewType of `RepositoryAnalysis`.
`DescribeCodeReviewResult`	`describeCodeReview(DescribeCodeReviewRequest describeCodeReviewRequest)` Returns the metadata 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)` Returns a RepositoryAssociation object that contains information about the requested 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)` Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
`ListRecommendationsResult`	`listRecommendations(ListRecommendationsRequest listRecommendationsRequest)` Returns the list of all recommendations for a completed code review.
`ListRepositoryAssociationsResult`	`listRepositoryAssociations(ListRepositoryAssociationsRequest listRepositoryAssociationsRequest)` Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns the list of tags associated with an associated repository resource.
`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.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds one or more tags to an associated repository.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an associated repository.
`AmazonCodeGuruReviewerWaiters`	`waiters()`

- 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)
```
    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.
    
    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
```
CreateCodeReviewResult createCodeReview(CreateCodeReviewRequest createCodeReviewRequest)
```
    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.
    
    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
```
DescribeCodeReviewResult describeCodeReview(DescribeCodeReviewRequest describeCodeReviewRequest)
```
    Returns the metadata 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)
```
    Returns a RepositoryAssociation object that contains information about the requested 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)
```
    Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
    
    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)
```
    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.
    
    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
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns the list of tags associated with an associated repository resource.
    
    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
```
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
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds one or more tags to an associated repository.
    
    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
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an associated repository.
    
    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
  - 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.
  - waiters
```
AmazonCodeGuruReviewerWaiters waiters()
```

Interface AmazonCodeGuruReviewer

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateRepository

createCodeReview

describeCodeReview

describeRecommendationFeedback

describeRepositoryAssociation

disassociateRepository

listCodeReviews

listRecommendationFeedback

listRecommendations

listRepositoryAssociations

listTagsForResource

putRecommendationFeedback

tagResource

untagResource

shutdown

getCachedResponseMetadata

waiters