v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1440296193.3 KB

This action creates a SyncJob.

post/workspaces/{workspaceId}/sync-jobs/{syncSource}

Path parameters

workspaceIdstring required

The workspace ID.

syncSourcestring required
<p>The sync source.</p> <note> <p>Currently the only supported syncSoource is <code>SITEWISE </code>.</p> </note>

Request body

syncRolestring required

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

tagsobject

The SyncJob tags.

Response

Success

arnstring required

The SyncJob ARN.

creationDateTimestring date-time required

The date and time for the SyncJob creation.

state'CREATING' | 'INITIALIZING' | 'ACTIVE' | 'DELETING' | 'ERROR' required

The SyncJob response state.