Skip to content

Returns a list of pull requests for a specified repository

Description

Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.

Usage

codecommit_list_pull_requests(repositoryName, authorArn,
  pullRequestStatus, nextToken, maxResults)

Arguments

  • repositoryName

    [required] The name of the repository for which you want to list pull requests.

  • authorArn

    Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.

  • pullRequestStatus

    Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.

  • nextToken

    An enumeration token that, when provided in a request, returns the next batch of the results.

  • maxResults

    A non-zero, non-negative integer used to limit the number of returned results.

Value

A list with the following syntax:

list(
  pullRequestIds = list(
    "string"
  ),
  nextToken = "string"
)

Request syntax

svc$list_pull_requests(
  repositoryName = "string",
  authorArn = "string",
  pullRequestStatus = "OPEN"|"CLOSED",
  nextToken = "string",
  maxResults = 123
)