Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

list_sync_resources

list_sync_resources(**kwargs)

Lists the sync resources.

See also: AWS API Documentation

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'
)
Parameters
  • workspaceId (string) --

    [REQUIRED]

    The ID of the workspace that contains the sync job.

  • syncSource (string) --

    [REQUIRED]

    The sync soucre.

    Note

    Currently the only supported syncSoucre is SITEWISE .

  • filters (list) --

    A list of objects that filter the request.

    • (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 resoucre type

      • resourceId (string) --

        The sync resource filter resource Id.

      • externalId (string) --

        The external Id.

  • maxResults (integer) --

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

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

  • nextToken (string) -- The string that specifies the next page of results.
Return type

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',
                    '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

  • IoTTwinMaker.Client.exceptions.InternalServerException
  • IoTTwinMaker.Client.exceptions.AccessDeniedException
  • IoTTwinMaker.Client.exceptions.ThrottlingException
  • IoTTwinMaker.Client.exceptions.ValidationException
  • IoTTwinMaker.Client.exceptions.ServiceQuotaExceededException