CodeGuruReviewer

import { CodeGuruReviewer } from "https://aws-api.deno.dev/v0.4/services/codegurureviewer.ts?docs=full";

class CodeGuruReviewer {

constructor(apiFactory: client.ApiFactory);

async associateRepository(params: AssociateRepositoryRequest, opts?: client.RequestOptions): Promise<AssociateRepositoryResponse>;

async createCodeReview(params: CreateCodeReviewRequest, opts?: client.RequestOptions): Promise<CreateCodeReviewResponse>;

async describeCodeReview(params: DescribeCodeReviewRequest, opts?: client.RequestOptions): Promise<DescribeCodeReviewResponse>;

async describeRecommendationFeedback(params: DescribeRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<DescribeRecommendationFeedbackResponse>;

async describeRepositoryAssociation(params: DescribeRepositoryAssociationRequest, opts?: client.RequestOptions): Promise<DescribeRepositoryAssociationResponse>;

async disassociateRepository(params: DisassociateRepositoryRequest, opts?: client.RequestOptions): Promise<DisassociateRepositoryResponse>;

async listCodeReviews(params: ListCodeReviewsRequest, opts?: client.RequestOptions): Promise<ListCodeReviewsResponse>;

async listRecommendationFeedback(params: ListRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<ListRecommendationFeedbackResponse>;

async listRecommendations(params: ListRecommendationsRequest, opts?: client.RequestOptions): Promise<ListRecommendationsResponse>;

async listRepositoryAssociations(params?: ListRepositoryAssociationsRequest, opts?: client.RequestOptions): Promise<ListRepositoryAssociationsResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putRecommendationFeedback(params: PutRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async waitForCodeReviewCompleted(params: DescribeCodeReviewRequest, opts?: client.RequestOptions): Promise<DescribeCodeReviewResponse>;

async waitForRepositoryAssociationSucceeded(params: DescribeRepositoryAssociationRequest, opts?: client.RequestOptions): Promise<DescribeRepositoryAssociationResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new CodeGuruReviewer(apiFactory: client.ApiFactory)

[src]

§Methods

associateRepository(params: AssociateRepositoryRequest, opts?: client.RequestOptions): Promise<AssociateRepositoryResponse>

[src]

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.

Note: 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.

createCodeReview(params: CreateCodeReviewRequest, opts?: client.RequestOptions): Promise<CreateCodeReviewResponse>

[src]

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.

describeCodeReview(params: DescribeCodeReviewRequest, opts?: client.RequestOptions): Promise<DescribeCodeReviewResponse>

[src]

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

describeRecommendationFeedback(params: DescribeRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<DescribeRecommendationFeedbackResponse>

[src]

Describes the customer feedback for a CodeGuru Reviewer recommendation.

describeRepositoryAssociation(params: DescribeRepositoryAssociationRequest, opts?: client.RequestOptions): Promise<DescribeRepositoryAssociationResponse>

[src]

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

disassociateRepository(params: DisassociateRepositoryRequest, opts?: client.RequestOptions): Promise<DisassociateRepositoryResponse>

[src]

Removes the association between Amazon CodeGuru Reviewer and a repository.

listCodeReviews(params: ListCodeReviewsRequest, opts?: client.RequestOptions): Promise<ListCodeReviewsResponse>

[src]

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

listRecommendationFeedback(params: ListRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<ListRecommendationFeedbackResponse>

[src]

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

listRecommendations(params: ListRecommendationsRequest, opts?: client.RequestOptions): Promise<ListRecommendationsResponse>

[src]

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

listRepositoryAssociations(params?: ListRepositoryAssociationsRequest, opts?: client.RequestOptions): Promise<ListRepositoryAssociationsResponse>

[src]

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.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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

putRecommendationFeedback(params: PutRecommendationFeedbackRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds one or more tags to an associated repository.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes a tag from an associated repository.

waitForCodeReviewCompleted(params: DescribeCodeReviewRequest, opts?: client.RequestOptions): Promise<DescribeCodeReviewResponse>

[src]

Wait until a code review is complete. Checks state up to 180 times, 10 seconds apart (about 30 minutes max wait time).

waitForRepositoryAssociationSucceeded(params: DescribeRepositoryAssociationRequest, opts?: client.RequestOptions): Promise<DescribeRepositoryAssociationResponse>

[src]

Wait until a repository association is complete. Checks state up to 30 times, 10 seconds apart (about 5 minutes max wait time).

§Static Properties

ApiMetadata: client.ApiMetadata

[src]