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

************************
get_template_sync_status
************************



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

  

  Get the status of a template sync.

  

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


  **Request Syntax**
  ::

    response = client.get_template_sync_status(
        templateName='string',
        templateType='ENVIRONMENT'|'SERVICE',
        templateVersion='string'
    )
    
  :type templateName: string
  :param templateName: **[REQUIRED]** 

    The template name.

    

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

    The template type.

    

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

    The template major version.

    

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

    
    ::

      {
          'desiredState': {
              'branch': 'string',
              'directory': 'string',
              'repositoryName': 'string',
              'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
              'sha': 'string'
          },
          'latestSuccessfulSync': {
              'events': [
                  {
                      'event': 'string',
                      'externalId': 'string',
                      'time': datetime(2015, 1, 1),
                      'type': 'string'
                  },
              ],
              'initialRevision': {
                  'branch': 'string',
                  'directory': 'string',
                  'repositoryName': 'string',
                  'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
                  'sha': 'string'
              },
              'startedAt': datetime(2015, 1, 1),
              'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
              'target': 'string',
              'targetRevision': {
                  'branch': 'string',
                  'directory': 'string',
                  'repositoryName': 'string',
                  'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
                  'sha': 'string'
              }
          },
          'latestSync': {
              'events': [
                  {
                      'event': 'string',
                      'externalId': 'string',
                      'time': datetime(2015, 1, 1),
                      'type': 'string'
                  },
              ],
              'initialRevision': {
                  'branch': 'string',
                  'directory': 'string',
                  'repositoryName': 'string',
                  'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
                  'sha': 'string'
              },
              'startedAt': datetime(2015, 1, 1),
              'status': 'INITIATED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
              'target': 'string',
              'targetRevision': {
                  'branch': 'string',
                  'directory': 'string',
                  'repositoryName': 'string',
                  'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
                  'sha': 'string'
              }
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **desiredState** *(dict) --* 

        The template sync desired state that's returned by Proton.

        
        

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

          The repository branch.

          
        

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

          The repository directory changed by a commit and push that activated the sync attempt.

          
        

        - **repositoryName** *(string) --* 

          The repository name.

          
        

        - **repositoryProvider** *(string) --* 

          The repository provider.

          
        

        - **sha** *(string) --* 

          The secure hash algorithm (SHA) hash for the revision.

          
    
      

      - **latestSuccessfulSync** *(dict) --* 

        The details of the last successful sync that's returned by Proton.

        
        

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

          An array of events with detail data.

          
          

          - *(dict) --* 

            Detail data for a resource sync event.

            
            

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

              A resource sync event.

              
            

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

              The external ID for the event.

              
            

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

              The time when the event occurred.

              
            

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

              The type of event.

              
        
      
        

        - **initialRevision** *(dict) --* 

          Detail data for the initial repository commit, path and push.

          
          

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

            The repository branch.

            
          

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

            The repository directory changed by a commit and push that activated the sync attempt.

            
          

          - **repositoryName** *(string) --* 

            The repository name.

            
          

          - **repositoryProvider** *(string) --* 

            The repository provider.

            
          

          - **sha** *(string) --* 

            The secure hash algorithm (SHA) hash for the revision.

            
      
        

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

          The time when the sync attempt started.

          
        

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

          The status of the sync attempt.

          
        

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

          The resource that is synced to.

          
        

        - **targetRevision** *(dict) --* 

          Detail data for the target revision.

          
          

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

            The repository branch.

            
          

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

            The repository directory changed by a commit and push that activated the sync attempt.

            
          

          - **repositoryName** *(string) --* 

            The repository name.

            
          

          - **repositoryProvider** *(string) --* 

            The repository provider.

            
          

          - **sha** *(string) --* 

            The secure hash algorithm (SHA) hash for the revision.

            
      
    
      

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

        The details of the last sync that's returned by Proton.

        
        

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

          An array of events with detail data.

          
          

          - *(dict) --* 

            Detail data for a resource sync event.

            
            

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

              A resource sync event.

              
            

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

              The external ID for the event.

              
            

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

              The time when the event occurred.

              
            

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

              The type of event.

              
        
      
        

        - **initialRevision** *(dict) --* 

          Detail data for the initial repository commit, path and push.

          
          

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

            The repository branch.

            
          

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

            The repository directory changed by a commit and push that activated the sync attempt.

            
          

          - **repositoryName** *(string) --* 

            The repository name.

            
          

          - **repositoryProvider** *(string) --* 

            The repository provider.

            
          

          - **sha** *(string) --* 

            The secure hash algorithm (SHA) hash for the revision.

            
      
        

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

          The time when the sync attempt started.

          
        

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

          The status of the sync attempt.

          
        

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

          The resource that is synced to.

          
        

        - **targetRevision** *(dict) --* 

          Detail data for the target revision.

          
          

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

            The repository branch.

            
          

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

            The repository directory changed by a commit and push that activated the sync attempt.

            
          

          - **repositoryName** *(string) --* 

            The repository name.

            
          

          - **repositoryProvider** *(string) --* 

            The repository provider.

            
          

          - **sha** *(string) --* 

            The secure hash algorithm (SHA) hash for the revision.

            
      
    
  
  **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`

  