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

**************
list_sync_jobs
**************



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

  

  List all SyncJobs.

  

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


  **Request Syntax**
  ::

    response = client.list_sync_jobs(
        workspaceId='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace that contains the sync job.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at one time. The default is 50.

     

    Valid Range: Minimum value of 0. Maximum value of 200.

    

  
  :type nextToken: string
  :param nextToken: 

    The string that specifies the next page of results.

    

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

    
    ::

      {
          'syncJobSummaries': [
              {
                  'arn': 'string',
                  'workspaceId': 'string',
                  'syncSource': '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)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **syncJobSummaries** *(list) --* 

        The listed SyncJob summaries.

        
        

        - *(dict) --* 

          The SyncJob summary.

          
          

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

            The SyncJob summary ARN.

            
          

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

            The ID of the workspace that contains the sync job.

            
          

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

            The sync source.

            
          

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

            The SyncJob summaries 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.

            
      
    
      

      - **nextToken** *(string) --* 

        The string that specifies the next page of results.

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

  