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

*******************
list_sync_resources
*******************



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

  

  Lists the sync resources.

  

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


  **Request Syntax**
  ::

    response = client.list_sync_resources(
        workspaceId='string',
        syncSource='string',
        filters=[
            {
                'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'ERROR',
                'resourceType': 'ENTITY'|'COMPONENT_TYPE',
                'resourceId': 'string',
                'externalId': 'string'
            },
        ],
        maxResults=123,
        nextToken='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The ID of the workspace that contains the sync job.

    

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

    The sync source.

     

    .. note::

      

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

      

    

  
  :type filters: list
  :param filters: 

    A list of objects that filter the request.

     

    The following filter combinations are supported:

     

    
    * Filter with state
     
    * Filter with ResourceType and ResourceId
     
    * Filter with ResourceType and ExternalId
    

    

  
    - *(dict) --* 

      The sync resource filter.

      .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``state``, ``resourceType``, ``resourceId``, ``externalId``. 

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

        The sync resource filter's state.

        

      
      - **resourceType** *(string) --* 

        The sync resource filter resource type

        

      
      - **resourceId** *(string) --* 

        The sync resource filter resource ID.

        

      
      - **externalId** *(string) --* 

        The external ID.

        

      
    

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

    
    ::

      {
          'syncResources': [
              {
                  'resourceType': 'ENTITY'|'COMPONENT_TYPE',
                  'externalId': 'string',
                  'resourceId': 'string',
                  'status': {
                      'state': 'INITIALIZING'|'PROCESSING'|'DELETED'|'IN_SYNC'|'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'
                      }
                  },
                  'updateDateTime': datetime(2015, 1, 1)
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **syncResources** *(list) --* 

        The sync resources.

        
        

        - *(dict) --* 

          The sync resource summary.

          
          

          - **resourceType** *(string) --* 

            The resource type.

            
          

          - **externalId** *(string) --* 

            The external ID.

            
          

          - **resourceId** *(string) --* 

            The resource ID.

            
          

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

            The sync resource summary status.

            
            

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

              The sync resource status state.

              
            

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

              The status error.

              
              

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

                The error code.

                
              

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

                The error message.

                
          
        
          

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

  