metadata_transfer_jobs

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

Overview

Name	metadata_transfer_jobs
Type	Resource
Id	aws.iottwinmaker.metadata_transfer_jobs

Fields

The following fields are returned by SELECT queries:

list_metadata_transfer_jobs

Name	Datatype	Description
metadata_transfer_job_summaries	array	The metadata transfer job summaries.
next_token	string	The string that specifies the next page of results. (pattern: <code>.*</code>)

get_metadata_transfer_job

Name	Datatype	Description
arn	string	The metadata transfer 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)	The metadata transfer job's creation DateTime property.
description	string	The metadata transfer job description. (pattern: <code>.*</code>)
destination	object	The [link to action] metadata transfer job destination configuration.
metadata_transfer_job_id	string	The metadata transfer job Id. (pattern: <code>[a-zA-Z_0-9][a-zA-Z_-0-9]*[a-zA-Z0-9]+</code>)
metadata_transfer_job_role	string	The metadata transfer job's role. (pattern: <code>arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*</code>)
progress	object	The metadata transfer job's progress.
report_url	string	The metadata transfer job's report URL. (pattern: <code>.*</code>)
sources	array	The metadata transfer job's sources.
status	object	The metadata transfer job's status.
update_date_time	string (date-time)	The metadata transfer job's update DateTime property.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_metadata_transfer_jobs	select	region		Lists the metadata transfer jobs.
get_metadata_transfer_job	select	metadata_transfer_job_id, region		Gets a nmetadata transfer job.
create_metadata_transfer_job	insert	region, sources, destination		Creates a new metadata transfer job.
cancel_metadata_transfer_job	exec	metadata_transfer_job_id, region		Cancels the metadata transfer job.

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
metadata_transfer_job_id	string	The metadata transfer job Id.
region	string	AWS region (default: us-east-1)

SELECT examples

list_metadata_transfer_jobs

Lists the metadata transfer jobs.

SELECT
metadata_transfer_job_summaries,
next_token
FROM aws.iottwinmaker.metadata_transfer_jobs
WHERE region = '{{ region }}' -- required
;

get_metadata_transfer_job

Gets a nmetadata transfer job.

SELECT
arn,
creation_date_time,
description,
destination,
metadata_transfer_job_id,
metadata_transfer_job_role,
progress,
report_url,
sources,
status,
update_date_time
FROM aws.iottwinmaker.metadata_transfer_jobs
WHERE metadata_transfer_job_id = '{{ metadata_transfer_job_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_metadata_transfer_job

Creates a new metadata transfer job.

INSERT INTO aws.iottwinmaker.metadata_transfer_jobs (
metadataTransferJobId,
description,
sources,
destination,
region
)
SELECT 
'{{ metadataTransferJobId }}',
'{{ description }}',
'{{ sources }}' /* required */,
'{{ destination }}' /* required */,
'{{ region }}'
RETURNING
arn,
creation_date_time,
metadata_transfer_job_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: metadata_transfer_jobs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the metadata_transfer_jobs resource.
  - name: metadataTransferJobId
    value: "{{ metadataTransferJobId }}"
  - name: description
    value: "{{ description }}"
  - name: sources
    value:
      - type_: "{{ type_ }}"
        s3Configuration:
          location: "{{ location }}"
        iotSiteWiseConfiguration:
          filters:
            - filterByAssetModel:
                assetModelId: "{{ assetModelId }}"
                assetModelExternalId: "{{ assetModelExternalId }}"
                includeOffspring: {{ includeOffspring }}
                includeAssets: {{ includeAssets }}
              filterByAsset:
                assetId: "{{ assetId }}"
                assetExternalId: "{{ assetExternalId }}"
                includeOffspring: {{ includeOffspring }}
                includeAssetModel: {{ includeAssetModel }}
        iotTwinMakerConfiguration:
          workspace: "{{ workspace }}"
          filters:
            - filterByComponentType:
                componentTypeId: "{{ componentTypeId }}"
              filterByEntity:
                entityId: "{{ entityId }}"
  - name: destination
    description: |
      The [link to action] metadata transfer job destination configuration.
    value:
      type_: "{{ type_ }}"
      s3Configuration:
        location: "{{ location }}"
      iotTwinMakerConfiguration:
        workspace: "{{ workspace }}"

Lifecycle Methods

cancel_metadata_transfer_job

Cancels the metadata transfer job.

EXEC aws.iottwinmaker.metadata_transfer_jobs.cancel_metadata_transfer_job 
@metadata_transfer_job_id='{{ metadata_transfer_job_id }}' --required, 
@region='{{ region }}' --required
;