ListRepositoryAssociations¶

class CodeGuruReviewer.Paginator.ListRepositoryAssociations¶

paginator = client.get_paginator('list_repository_associations')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from CodeGuruReviewer.Client.list_repository_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProviderTypes=[
        'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer'|'S3Bucket',
    ],
    States=[
        'Associated'|'Associating'|'Failed'|'Disassociating'|'Disassociated',
    ],
    Names=[
        'string',
    ],
    Owners=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

ProviderTypes (list) --
List of provider types to use as a filter.
- (string) --
States (list) --
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.
- 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 .
- (string) --
Names (list) --
List of repository names to use as a filter.
- (string) --
Owners (list) --
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.
- (string) --
PaginationConfig (dict) --
A dictionary that provides parameters to control pagination.
- MaxItems (integer) --
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) --
  The size of each page.
- StartingToken (string) --
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'RepositoryAssociationSummaries': [
        {
            'AssociationArn': 'string',
            'ConnectionArn': 'string',
            'LastUpdatedTimeStamp': datetime(2015, 1, 1),
            'AssociationId': 'string',
            'Name': 'string',
            'Owner': 'string',
            'ProviderType': 'CodeCommit'|'GitHub'|'Bitbucket'|'GitHubEnterpriseServer'|'S3Bucket',
            'State': 'Associated'|'Associating'|'Failed'|'Disassociating'|'Disassociated'
        },
    ],

}

Response Structure

(dict) --
- RepositoryAssociationSummaries (list) --
  
  A list of repository associations that meet the criteria of the request.
  - (dict) --
    
    Summary information about a repository association. The ListRepositoryAssociations operation returns a list of RepositoryAssociationSummary objects.
    - AssociationArn (string) --
      
      The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositoryAssociations.
    - ConnectionArn (string) --
      
      The Amazon Resource Name (ARN) of an Amazon Web Services CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id . For more information, see Connection in the Amazon Web Services CodeStar Connections API Reference .
    - LastUpdatedTimeStamp (datetime) --
      
      The time, in milliseconds since the epoch, since the repository association was last updated.
    - AssociationId (string) --
      
      The repository association ID.
    - Name (string) --
      
      The name of the repository association.
    - Owner (string) --
      
      The owner of the repository. For an Amazon Web Services CodeCommit repository, this is the Amazon Web Services account ID of the account that owns the repository. For a GitHub, GitHub Enterprise Server, or Bitbucket repository, this is the username for the account that owns the repository. For an S3 repository, it can be the username or Amazon Web Services account ID.
    - ProviderType (string) --
      
      The provider type of the repository association.
    - State (string) --
      
      The state of the repository association.
      
      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.
      - 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 .

Table Of Contents

ListRepositoryAssociations¶