Skip to content

List Repository Associations

codegurureviewer_list_repository_associations R Documentation

Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association

Description

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.

Usage

codegurureviewer_list_repository_associations(ProviderTypes, States,
  Names, Owners, MaxResults, NextToken)

Arguments

ProviderTypes

List of provider types to use as a filter.

States

List of repository association states to use as a filter.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      If your repository ProviderType is GitHub, ⁠GitHub Enterprise Server⁠, or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

  • Disassociated: CodeGuru Reviewer successfully disassociated the repository. You can create a new association with this repository if you want to review source code in it later. You can control access to code reviews created in anassociated repository with tags after it has been disassociated. For more information, see Using tags to control access to associated repositories in the Amazon CodeGuru Reviewer User Guide.

Names

List of repository names to use as a filter.

Owners

List of owners to use as a filter. For Amazon Web Services CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket and GitHub Enterprise Server, this is name of the account that was used to associate the repository.

MaxResults

The maximum number of repository association results returned by list_repository_associations in paginated output. When this parameter is used, list_repository_associations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another list_repository_associations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, list_repository_associations returns up to 100 results and a nextToken value if applicable.

NextToken

The nextToken value returned from a previous paginated list_repository_associations request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Treat this token as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Value

A list with the following syntax: 

list(
  RepositoryAssociationSummaries = list(
    list(
      AssociationArn = "string",
      ConnectionArn = "string",
      LastUpdatedTimeStamp = as.POSIXct(
        "2015-01-01"
      ),
      AssociationId = "string",
      Name = "string",
      Owner = "string",
      ProviderType = "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket",
      State = "Associated"|"Associating"|"Failed"|"Disassociating"|"Disassociated"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_repository_associations(
  ProviderTypes = list(
    "CodeCommit"|"GitHub"|"Bitbucket"|"GitHubEnterpriseServer"|"S3Bucket"
  ),
  States = list(
    "Associated"|"Associating"|"Failed"|"Disassociating"|"Disassociated"
  ),
  Names = list(
    "string"
  ),
  Owners = list(
    "string"
  ),
  MaxResults = 123,
  NextToken = "string"
)