sync_jobs

Creates, updates, deletes, gets or lists a sync_jobs resource.

Overview

Name	sync_jobs
Type	Resource
Id	aws.iottwinmaker.sync_jobs

Fields

The following fields are returned by SELECT queries:

get_sync_job

Name	Datatype	Description
arn	string	The sync job ARN. (pattern: <code>arn:((aws)|(aws-cn)|(aws-us-gov)):iottwinmaker:[a-z0-9-]+:[0-9]{12}:[/a-zA-Z0-9_-.:]+</code>)
creation_date_time	string (date-time)	supports epoch seconds value
status	object	The SyncJob response status.
sync_role	string	The sync IAM role. (pattern: <code>arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*</code>)
sync_source	string	The sync soucre. Currently the only supported syncSource is SITEWISE . (pattern: <code>[a-zA-Z_0-9]+</code>)
update_date_time	string (date-time)	supports epoch seconds value
workspace_id	string	The ID of the workspace that contains the sync job. (pattern: <code>[a-zA-Z_0-9][a-zA-Z_-0-9]*[a-zA-Z0-9]+</code>)

list_sync_jobs

Name	Datatype	Description
next_token	string	The string that specifies the next page of results. (pattern: <code>.*</code>)
sync_job_summaries	array	The listed SyncJob summaries.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sync_job	select	sync_source, region	workspace	Gets the SyncJob.
list_sync_jobs	select	workspace_id, region		List all SyncJobs.
create_sync_job	insert	workspace_id, sync_source, region, syncRole		This action creates a SyncJob.
delete_sync_job	delete	workspace_id, sync_source, region		Delete the SyncJob.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
sync_source	string	The sync source. Currently the only supported syncSource is SITEWISE .
workspace_id	string	The workspace ID.
workspace	string	The workspace ID.

SELECT examples

get_sync_job

Gets the SyncJob.

SELECT
arn,
creation_date_time,
status,
sync_role,
sync_source,
update_date_time,
workspace_id
FROM aws.iottwinmaker.sync_jobs
WHERE sync_source = '{{ sync_source }}' -- required
AND region = '{{ region }}' -- required
AND workspace = '{{ workspace }}'
;

list_sync_jobs

List all SyncJobs.

SELECT
next_token,
sync_job_summaries
FROM aws.iottwinmaker.sync_jobs
WHERE workspace_id = '{{ workspace_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_sync_job

This action creates a SyncJob.

INSERT INTO aws.iottwinmaker.sync_jobs (
syncRole,
tags,
workspace_id,
sync_source,
region
)
SELECT 
'{{ syncRole }}' /* required */,
'{{ tags }}',
'{{ workspace_id }}',
'{{ sync_source }}',
'{{ region }}'
RETURNING
arn,
creation_date_time,
state
;

Manifest

# Description fields are for documentation purposes
- name: sync_jobs
props:
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the sync_jobs resource.
  - name: sync_source
    value: "{{ sync_source }}"
    description: Required parameter for the sync_jobs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the sync_jobs resource.
  - name: syncRole
    value: "{{ syncRole }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_sync_job

Delete the SyncJob.

DELETE FROM aws.iottwinmaker.sync_jobs
WHERE workspace_id = '{{ workspace_id }}' --required
AND sync_source = '{{ sync_source }}' --required
AND region = '{{ region }}' --required
;