:doc:`IoTTwinMaker <../../iottwinmaker>` / Client / get_sync_job

************
get_sync_job
************



.. py:method:: IoTTwinMaker.Client.get_sync_job(**kwargs)

  

  Gets the SyncJob.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iottwinmaker-2021-11-29/GetSyncJob>`_  


  **Request Syntax**
  ::

    response = client.get_sync_job(
        syncSource='string',
        workspaceId='string'
    )
    
  :type syncSource: string
  :param syncSource: **[REQUIRED]** 

    The sync source.

     

    .. note::

      

      Currently the only supported syncSource is ``SITEWISE ``.

      

    

  
  :type workspaceId: string
  :param workspaceId: 

    The workspace ID.

    

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

    
    ::

      {
          'arn': 'string',
          'workspaceId': 'string',
          'syncSource': 'string',
          'syncRole': 'string',
          'status': {
              'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR',
              'error': {
                  'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE'|'SYNC_INITIALIZING_ERROR'|'SYNC_CREATING_ERROR'|'SYNC_PROCESSING_ERROR'|'SYNC_DELETING_ERROR'|'PROCESSING_ERROR'|'COMPOSITE_COMPONENT_FAILURE',
                  'message': 'string'
              }
          },
          'creationDateTime': datetime(2015, 1, 1),
          'updateDateTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **arn** *(string) --* 

        The sync job ARN.

        
      

      - **workspaceId** *(string) --* 

        The ID of the workspace that contains the sync job.

        
      

      - **syncSource** *(string) --* 

        The sync soucre.

         

        .. note::

          

          Currently the only supported syncSource is ``SITEWISE ``.

          

        
      

      - **syncRole** *(string) --* 

        The sync IAM role.

        
      

      - **status** *(dict) --* 

        The SyncJob response status.

        
        

        - **state** *(string) --* 

          The SyncJob status state.

          
        

        - **error** *(dict) --* 

          The SyncJob error.

          
          

          - **code** *(string) --* 

            The error code.

            
          

          - **message** *(string) --* 

            The error message.

            
      
    
      

      - **creationDateTime** *(datetime) --* 

        The creation date and time.

        
      

      - **updateDateTime** *(datetime) --* 

        The update date and time.

        
  
  **Exceptions**
  
  *   :py:class:`IoTTwinMaker.Client.exceptions.InternalServerException`

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

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

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

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException`

  