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

***********************
get_service_sync_config
***********************



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

  

  Get detailed information for the service sync configuration.

  

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


  **Request Syntax**
  ::

    response = client.get_service_sync_config(
        serviceName='string'
    )
    
  :type serviceName: string
  :param serviceName: **[REQUIRED]** 

    The name of the service that you want to get the service sync configuration for.

    

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

    
    ::

      {
          'serviceSyncConfig': {
              'branch': 'string',
              'filePath': 'string',
              'repositoryName': 'string',
              'repositoryProvider': 'GITHUB'|'GITHUB_ENTERPRISE'|'BITBUCKET',
              'serviceName': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **serviceSyncConfig** *(dict) --* 

        The detailed data of the requested service sync configuration.

        
        

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

          The name of the code repository branch that holds the service code Proton will sync with.

          
        

        - **filePath** *(string) --* 

          The file path to the service sync configuration file.

          
        

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

          The name of the code repository that holds the service code Proton will sync with.

          
        

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

          The name of the repository provider that holds the repository Proton will sync with.

          
        

        - **serviceName** *(string) --* 

          The name of the service that the service instance is added to.

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

  