/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeGuruReviewer::ListCodeReviews

NAME

Paws::CodeGuruReviewer::ListCodeReviews - Arguments for method ListCodeReviews on Paws::CodeGuruReviewer

DESCRIPTION

This class represents the parameters used for calling the method ListCodeReviews on the Amazon CodeGuru Reviewer service. Use the attributes of this class as arguments to method ListCodeReviews.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListCodeReviews.

SYNOPSIS

my $codeguru-reviewer = Paws->service('CodeGuruReviewer');
my $ListCodeReviewsResponse = $codeguru -reviewer->ListCodeReviews(
  Type          => 'PullRequest',
  MaxResults    => 1,                # OPTIONAL
  NextToken     => 'MyNextToken',    # OPTIONAL
  ProviderTypes => [
    'CodeCommit',
    ... # values: CodeCommit, GitHub, Bitbucket, GitHubEnterpriseServer, S3Bucket
  ],    # OPTIONAL
  RepositoryNames => [
    'MyName', ...    # min: 1, max: 100
  ],    # OPTIONAL
  States => [
    'Completed', ...    # values: Completed, Pending, Failed, Deleting
  ],    # OPTIONAL
);

# Results:
my $CodeReviewSummaries = $ListCodeReviewsResponse->CodeReviewSummaries;
my $NextToken           = $ListCodeReviewsResponse->NextToken;

# Returns a L<Paws::CodeGuruReviewer::ListCodeReviewsResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codeguru-reviewer/ListCodeReviews

ATTRIBUTES

MaxResults => Int

The maximum number of results that are returned per call. The default is 100.

NextToken => Str

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

ProviderTypes => ArrayRef[Str|Undef]

List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

RepositoryNames => ArrayRef[Str|Undef]

List of repository names for filtering that needs to be applied before displaying the result.

States => ArrayRef[Str|Undef]

List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

The valid code review states are:

  • Completed: The code review is complete.

  • Pending: The code review started and has not completed or failed.

  • Failed: The code review failed.

  • Deleting: The code review is being deleted.

REQUIRED Type => Str

The type of code reviews to list in the response.

Valid values are: "PullRequest", "RepositoryAnalysis"

SEE ALSO

This class forms part of Paws, documenting arguments for method ListCodeReviews in Paws::CodeGuruReviewer

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