Skip to content

List Code Reviews

codegurureviewer_list_code_reviews R Documentation

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

Description

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

Usage

codegurureviewer_list_code_reviews(ProviderTypes, States,
  RepositoryNames, Type, MaxResults, NextToken)

Arguments

ProviderTypes

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

States

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.

RepositoryNames

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

Type

[required] The type of code reviews to list in the response.

MaxResults

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

NextToken

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.

Value

A list with the following syntax: 

list(
  CodeReviewSummaries = list(
    list(
      Name = "string",
      CodeReviewArn = "string",
      RepositoryName = "string",
      Owner = "string",
      ProviderType = "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket",
      State = "Completed"|"Pending"|"Failed"|"Deleting",
      CreatedTimeStamp = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTimeStamp = as.POSIXct(
        "2015-01-01"
      ),
      Type = "PullRequest"|"RepositoryAnalysis",
      PullRequestId = "string",
      MetricsSummary = list(
        MeteredLinesOfCodeCount = 123,
        SuppressedLinesOfCodeCount = 123,
        FindingsCount = 123
      ),
      SourceCodeType = list(
        CommitDiff = list(
          SourceCommit = "string",
          DestinationCommit = "string",
          MergeBaseCommit = "string"
        ),
        RepositoryHead = list(
          BranchName = "string"
        ),
        BranchDiff = list(
          SourceBranchName = "string",
          DestinationBranchName = "string"
        ),
        S3BucketRepository = list(
          Name = "string",
          Details = list(
            BucketName = "string",
            CodeArtifacts = list(
              SourceCodeArtifactsObjectKey = "string",
              BuildArtifactsObjectKey = "string"
            )
          )
        ),
        RequestMetadata = list(
          RequestId = "string",
          Requester = "string",
          EventInfo = list(
            Name = "string",
            State = "string"
          ),
          VendorName = "GitHub"|"GitLab"|"NativeS3"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_code_reviews(
  ProviderTypes = list(
    "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket"
  ),
  States = list(
    "Completed"|"Pending"|"Failed"|"Deleting"
  ),
  RepositoryNames = list(
    "string"
  ),
  Type = "PullRequest"|"RepositoryAnalysis",
  MaxResults = 123,
  NextToken = "string"
)