:doc:`Proton <../../proton>` / Client / get_repository_sync_status

**************************
get_repository_sync_status
**************************



.. py:method:: Proton.Client.get_repository_sync_status(**kwargs)

  

  Get the sync status of a repository used for Proton template sync. For more information about template sync, see .

   

  .. note::

    

    A repository sync status isn't tied to the Proton Repository resource (or any other Proton resource). Therefore, tags on an Proton Repository resource have no effect on this action. Specifically, you can't use these tags to control access to this action using Attribute-based access control (ABAC).

     

    For more information about ABAC, see `ABAC <https://docs.aws.amazon.com/proton/latest/userguide/security_iam_service-with-iam.html#security_iam_service-with-iam-tags>`__ in the *Proton User Guide*.

    

  

  .. 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/GetRepositorySyncStatus>`_  


  **Request Syntax**
  ::

    response = client.get_repository_sync_status(
        branch='string',
        repositoryName='string',
        repositoryProvider='GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
        syncType='TEMPLATE_SYNC'|'SERVICE_SYNC'
    )
    
  :type branch: string
  :param branch: **[REQUIRED]** 

    The repository branch.

    

  
  :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 repository sync type.

    

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

    
    ::

      {
          'latestSync': {
              'events': [
                  {
                      'event': 'string',
                      'externalId': 'string',
                      'time': datetime(2015, 1, 1),
                      'type': 'string'
                  },
              ],
              'startedAt': datetime(2015, 1, 1),
              'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED'|'QUEUED'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **latestSync** *(dict) --* 

        The repository sync status detail data that's returned by Proton.

        
        

        - **events** *(list) --* 

          Detail data for sync attempt events.

          
          

          - *(dict) --* 

            Repository sync event detail data for a sync attempt.

            
            

            - **event** *(string) --* 

              Event detail for a repository sync attempt.

              
            

            - **externalId** *(string) --* 

              The external ID of the sync event.

              
            

            - **time** *(datetime) --* 

              The time that the sync event occurred.

              
            

            - **type** *(string) --* 

              The type of event.

              
        
      
        

        - **startedAt** *(datetime) --* 

          The time when the sync attempt started.

          
        

        - **status** *(string) --* 

          The sync attempt status.

          
    
  
  **Exceptions**
  
  *   :py:class:`Proton.Client.exceptions.ValidationException`

  
  *   :py:class:`Proton.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Proton.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Proton.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Proton.Client.exceptions.InternalServerException`

  