IoTTwinMaker / Client / get_sync_job

get_sync_job#

IoTTwinMaker.Client.get_sync_job(**kwargs)#

Gets the SyncJob.

See also: AWS API Documentation

Request Syntax

response = client.get_sync_job(
    syncSource='string',
    workspaceId='string'
)
Parameters:

  • syncSource (string) –

    [REQUIRED]

    The sync source.

    Note

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

  • workspaceId (string) – The workspace ID.

Return type:

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