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

***************
create_sync_job
***************



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

  

  This action creates a SyncJob.

  

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


  **Request Syntax**
  ::

    response = client.create_sync_job(
        workspaceId='string',
        syncSource='string',
        syncRole='string',
        tags={
            'string': 'string'
        }
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The workspace ID.

    

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

    The sync source.

     

    .. note::

      

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

      

    

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

    The SyncJob IAM role. This IAM role is used by the SyncJob to read from the syncSource, and create, update, or delete the corresponding resources.

    

  
  :type tags: dict
  :param tags: 

    The SyncJob tags.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'arn': 'string',
          'creationDateTime': datetime(2015, 1, 1),
          'state': 'CREATING'|'INITIALIZING'|'ACTIVE'|'DELETING'|'ERROR'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The SyncJob ARN.

        
      

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

        The date and time for the SyncJob creation.

        
      

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

        The SyncJob response state.

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

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

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

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

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

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

  