:doc:`Proton <../../proton>` / Paginator / ListRepositorySyncDefinitions

*****************************
ListRepositorySyncDefinitions
*****************************



.. py:class:: Proton.Paginator.ListRepositorySyncDefinitions

  ::

    
    paginator = client.get_paginator('list_repository_sync_definitions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Proton.Client.list_repository_sync_definitions`.

    .. danger::

            This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


    

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/proton-2020-07-20/ListRepositorySyncDefinitions>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          repositoryName='string',
          repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
          syncType='TEMPLATE_SYNC'|'SERVICE_SYNC',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type repositoryName: string
    :param repositoryName: **[REQUIRED]** 

      The repository name.

      

    
    :type repositoryProvider: string
    :param repositoryProvider: **[REQUIRED]** 

      The repository provider.

      

    
    :type syncType: string
    :param syncType: **[REQUIRED]** 

      The sync type. The only supported value is ``TEMPLATE_SYNC``.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'syncDefinitions': [
                {
                    'branch': 'string',
                    'directory': 'string',
                    'parent': 'string',
                    'target': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **syncDefinitions** *(list) --* 

          An array of repository sync definitions.

          
          

          - *(dict) --* 

            A repository sync definition.

            
            

            - **branch** *(string) --* 

              The repository branch.

              
            

            - **directory** *(string) --* 

              The directory in the repository.

              
            

            - **parent** *(string) --* 

              The resource that is synced from.

              
            

            - **target** *(string) --* 

              The resource that is synced to.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    