:doc:`CodeStarconnections <../../codestar-connections>` / Client / get_sync_configuration

**********************
get_sync_configuration
**********************



.. py:method:: CodeStarconnections.Client.get_sync_configuration(**kwargs)

  

  Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codestar-connections-2019-12-01/GetSyncConfiguration>`_  


  **Request Syntax**
  ::

    response = client.get_sync_configuration(
        SyncType='CFN_STACK_SYNC',
        ResourceName='string'
    )
    
  :type SyncType: string
  :param SyncType: **[REQUIRED]** 

    The sync type for the sync configuration for which you want to retrieve information.

    

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

    The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.

    

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

    
    ::

      {
          'SyncConfiguration': {
              'Branch': 'string',
              'ConfigFile': 'string',
              'OwnerId': 'string',
              'ProviderType': 'Bitbucket'|'GitHub'|'GitHubEnterpriseServer'|'GitLab'|'GitLabSelfManaged',
              'RepositoryLinkId': 'string',
              'RepositoryName': 'string',
              'ResourceName': 'string',
              'RoleArn': 'string',
              'SyncType': 'CFN_STACK_SYNC',
              'PublishDeploymentStatus': 'ENABLED'|'DISABLED',
              'TriggerResourceUpdateOn': 'ANY_CHANGE'|'FILE_CHANGE'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **SyncConfiguration** *(dict) --* 

        The details about the sync configuration for which you want to retrieve information.

        
        

        - **Branch** *(string) --* 

          The branch associated with a specific sync configuration.

          
        

        - **ConfigFile** *(string) --* 

          The file path to the configuration file associated with a specific sync configuration. The path should point to an actual file in the sync configurations linked repository.

          
        

        - **OwnerId** *(string) --* 

          The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

          
        

        - **ProviderType** *(string) --* 

          The connection provider type associated with a specific sync configuration, such as GitHub.

          
        

        - **RepositoryLinkId** *(string) --* 

          The ID of the repository link associated with a specific sync configuration.

          
        

        - **RepositoryName** *(string) --* 

          The name of the repository associated with a specific sync configuration.

          
        

        - **ResourceName** *(string) --* 

          The name of the connection resource associated with a specific sync configuration.

          
        

        - **RoleArn** *(string) --* 

          The Amazon Resource Name (ARN) of the IAM role associated with a specific sync configuration.

          
        

        - **SyncType** *(string) --* 

          The type of sync for a specific sync configuration.

          
        

        - **PublishDeploymentStatus** *(string) --* 

          Whether to enable or disable publishing of deployment status to source providers.

          
        

        - **TriggerResourceUpdateOn** *(string) --* 

          When to trigger Git sync to begin the stack update.

          
    
  
  **Exceptions**
  
  *   :py:class:`CodeStarconnections.Client.exceptions.AccessDeniedException`

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

  
  *   :py:class:`CodeStarconnections.Client.exceptions.InvalidInputException`

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

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

  