create_sync_job

create_sync_job(**kwargs)

This action creates a SyncJob.

See also: AWS API Documentation

Request Syntax

response = client.create_sync_job(
    workspaceId='string',
    syncSource='string',
    syncRole='string',
    tags={
        'string': 'string'
    }
)
Parameters
  • workspaceId (string) --

    [REQUIRED]

    The workspace Id.

  • syncSource (string) --

    [REQUIRED]

    The sync source.

    Note

    Currently the only supported syncSoucre is SITEWISE .

  • syncRole (string) --

    [REQUIRED]

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

  • tags (dict) --

    The SyncJob tags.

    • (string) --
      • (string) --
Return type

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

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