ListRepositoryAssociations - Amazon CodeGuru Reviewer

ListRepositoryAssociations

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 .

Request Syntax

GET /associations?MaxResults=MaxResults&Name=Names&NextToken=NextToken&Owner=Owners&ProviderType=ProviderTypes&State=States HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations 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 ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

Valid Range: Minimum value of 1. Maximum value of 100.

Names

List of repository names to use as a filter.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S[\w.-]*$

NextToken

The nextToken value returned from a previous paginated ListRepositoryAssociations 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.

Note

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.

Length Constraints: Minimum length of 1. Maximum length of 2048.

Owners

List of owners to use as a filter. For AWS 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.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^\S(.*\S)?$

ProviderTypes

List of provider types to use as a filter.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: CodeCommit | GitHub | Bitbucket | GitHubEnterpriseServer

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.

      Note

      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.

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: Associated | Associating | Failed | Disassociating

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "RepositoryAssociationSummaries": [ { "AssociationArn": "string", "AssociationId": "string", "ConnectionArn": "string", "LastUpdatedTimeStamp": number, "Name": "string", "Owner": "string", "ProviderType": "string", "State": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The nextToken value to include in a future ListRecommendations request. When the results of a ListRecommendations request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

RepositoryAssociationSummaries

A list of repository associations that meet the criteria of the request.

Type: Array of RepositoryAssociationSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The server encountered an internal error and is unable to complete the request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: