NAME
Paws::CodeGuruReviewer - Perl Interface to AWS Amazon CodeGuru Reviewer
SYNOPSIS
use Paws;
my $obj = Paws->service('CodeGuruReviewer');
my $res = $obj->Method(
Arg1 => $val1,
Arg2 => [ 'V1', 'V2' ],
# if Arg3 is an object, the HashRef will be used as arguments to the constructor
# of the arguments type
Arg3 => { Att1 => 'Val1' },
# if Arg4 is an array of objects, the HashRefs will be passed as arguments to
# the constructor of the arguments type
Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
);DESCRIPTION
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 (AWS PrivateLink) (https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html) in the Amazon CodeGuru Reviewer User Guide.
For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer-2019-09-19
METHODS
AssociateRepository
- Repository => Paws::CodeGuruReviewer::Repository
- [ClientRequestToken => Str]
- [KMSKeyDetails => Paws::CodeGuruReviewer::KMSKeyDetails]
- [Tags => Paws::CodeGuruReviewer::TagMap]
Each argument is described in detail in: Paws::CodeGuruReviewer::AssociateRepository
Returns: a Paws::CodeGuruReviewer::AssociateRepositoryResponse instance
Use to associate an AWS CodeCommit repository or a repostory managed by AWS 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 AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.
Bitbucket and GitHub Enterprise Server repositories are managed by AWS 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 AWS 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.
CreateCodeReview
- Name => Str
- RepositoryAssociationArn => Str
- Type => Paws::CodeGuruReviewer::CodeReviewType
- [ClientRequestToken => Str]
Each argument is described in detail in: Paws::CodeGuruReviewer::CreateCodeReview
Returns: a Paws::CodeGuruReviewer::CreateCodeReviewResponse instance
Use to create a code review with a CodeReviewType (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html) 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.
DescribeCodeReview
Each argument is described in detail in: Paws::CodeGuruReviewer::DescribeCodeReview
Returns: a Paws::CodeGuruReviewer::DescribeCodeReviewResponse instance
Returns the metadata associated with the code review along with its status.
DescribeRecommendationFeedback
Each argument is described in detail in: Paws::CodeGuruReviewer::DescribeRecommendationFeedback
Returns: a Paws::CodeGuruReviewer::DescribeRecommendationFeedbackResponse instance
Describes the customer feedback for a CodeGuru Reviewer recommendation.
DescribeRepositoryAssociation
Each argument is described in detail in: Paws::CodeGuruReviewer::DescribeRepositoryAssociation
Returns: a Paws::CodeGuruReviewer::DescribeRepositoryAssociationResponse instance
Returns a RepositoryAssociation (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html) object that contains information about the requested repository association.
DisassociateRepository
Each argument is described in detail in: Paws::CodeGuruReviewer::DisassociateRepository
Returns: a Paws::CodeGuruReviewer::DisassociateRepositoryResponse instance
Removes the association between Amazon CodeGuru Reviewer and a repository.
ListCodeReviews
- Type => Str
- [MaxResults => Int]
- [NextToken => Str]
- [ProviderTypes => ArrayRef[Str|Undef]]
- [RepositoryNames => ArrayRef[Str|Undef]]
- [States => ArrayRef[Str|Undef]]
Each argument is described in detail in: Paws::CodeGuruReviewer::ListCodeReviews
Returns: a Paws::CodeGuruReviewer::ListCodeReviewsResponse instance
Lists all the code reviews that the customer has created in the past 90 days.
ListRecommendationFeedback
- CodeReviewArn => Str
- [MaxResults => Int]
- [NextToken => Str]
- [RecommendationIds => ArrayRef[Str|Undef]]
- [UserIds => ArrayRef[Str|Undef]]
Each argument is described in detail in: Paws::CodeGuruReviewer::ListRecommendationFeedback
Returns: a Paws::CodeGuruReviewer::ListRecommendationFeedbackResponse instance
Returns a list of RecommendationFeedbackSummary (https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html) objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
ListRecommendations
Each argument is described in detail in: Paws::CodeGuruReviewer::ListRecommendations
Returns: a Paws::CodeGuruReviewer::ListRecommendationsResponse instance
Returns the list of all recommendations for a completed code review.
ListRepositoryAssociations
- [MaxResults => Int]
- [Names => ArrayRef[Str|Undef]]
- [NextToken => Str]
- [Owners => ArrayRef[Str|Undef]]
- [ProviderTypes => ArrayRef[Str|Undef]]
- [States => ArrayRef[Str|Undef]]
Each argument is described in detail in: Paws::CodeGuruReviewer::ListRepositoryAssociations
Returns: a Paws::CodeGuruReviewer::ListRepositoryAssociationsResponse instance
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. 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).
ListTagsForResource
Each argument is described in detail in: Paws::CodeGuruReviewer::ListTagsForResource
Returns: a Paws::CodeGuruReviewer::ListTagsForResourceResponse instance
Returns the list of tags associated with an associated repository resource.
PutRecommendationFeedback
Each argument is described in detail in: Paws::CodeGuruReviewer::PutRecommendationFeedback
Returns: a Paws::CodeGuruReviewer::PutRecommendationFeedbackResponse instance
Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
TagResource
- ResourceArn => Str
- Tags => Paws::CodeGuruReviewer::TagMap
Each argument is described in detail in: Paws::CodeGuruReviewer::TagResource
Returns: a Paws::CodeGuruReviewer::TagResourceResponse instance
Adds one or more tags to an associated repository.
UntagResource
Each argument is described in detail in: Paws::CodeGuruReviewer::UntagResource
Returns: a Paws::CodeGuruReviewer::UntagResourceResponse instance
Removes a tag from an associated repository.
PAGINATORS
Paginator methods are helpers that repetively call methods that return partial results
ListAllRepositoryAssociations(sub { },[MaxResults => Int, Names => ArrayRef[Str|Undef], NextToken => Str, Owners => ArrayRef[Str|Undef], ProviderTypes => ArrayRef[Str|Undef], States => ArrayRef[Str|Undef]])
ListAllRepositoryAssociations([MaxResults => Int, Names => ArrayRef[Str|Undef], NextToken => Str, Owners => ArrayRef[Str|Undef], ProviderTypes => ArrayRef[Str|Undef], States => ArrayRef[Str|Undef]])
If passed a sub as first parameter, it will call the sub for each element found in :
- RepositoryAssociationSummaries, passing the object as the first parameter, and the string 'RepositoryAssociationSummaries' as the second parameter If not, it will return a a Paws::CodeGuruReviewer::ListRepositoryAssociationsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
SEE ALSO
This service class forms part of Paws
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues