dataset_export_jobs

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

Overview

Name	dataset_export_jobs
Type	Resource
Id	aws.iotsitewise.dataset_export_jobs

Fields

The following fields are returned by SELECT queries:

describe_dataset_export_job

Name	Datatype	Description
completed_at	string (date-time)	The timestamp when the job completed, or null if the job is still running.
destination_s3_uri	string	<p>An S3 URI identifying an object location, in the form s3:​//bucket/key.</p> (pattern: <code>s3:​//[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+</code>)
error_report_location	object	<p>Contains the location where error reports will be written on failure.</p>
input	object	<p>Input source for processing. Specify exactly one option.</p>
job_id	string	<p>The unique identifier for a dataset export job.</p> (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
started_at	string (date-time)	The timestamp when the job started processing.
status	string	The current status of the dataset export job. (SUBMITTED, RUNNING, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)
workspace_name	string	The name of the workspace that contains the dataset export job. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)

list_dataset_export_jobs

Name	Datatype	Description
completed_at	string (date-time)	<p>The timestamp when the job completed, or null if the job is still running.</p>
destination_s3_uri	string	<p>An S3 URI identifying an object location, in the form s3:​//bucket/key.</p> (pattern: <code>s3:​//[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+</code>)
job_id	string	<p>The unique identifier for the dataset export job.</p> (pattern: <code>[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
started_at	string (date-time)	<p>The timestamp when the job started processing.</p>
status	string	<p>The current status of the dataset export job.</p> (SUBMITTED, RUNNING, COMPLETED, COMPLETED_WITH_ERRORS, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_dataset_export_job	select	workspace_name, job_id, region		Retrieves information about a dataset export job.
list_dataset_export_jobs	select	workspace_name, region	filter, maxResults, nextToken	Retrieves a paginated list of dataset export jobs for a workspace.
create_dataset_export_job	insert	workspace_name, region, destinationS3Uri, input, errorReportLocation		Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

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
job_id	string	The unique identifier for the dataset export job.
region	string	AWS region (default: us-east-1)
workspace_name	string	The name of the workspace in which to create the dataset export job.
filter	string	The optional filter that returns only jobs matching the given filter value. Defaults to ALL.
maxResults	integer	The maximum number of results to return for each paginated request.
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

describe_dataset_export_job

Retrieves information about a dataset export job.

SELECT
completed_at,
destination_s3_uri,
error_report_location,
input,
job_id,
started_at,
status,
workspace_name
FROM aws.iotsitewise.dataset_export_jobs
WHERE workspace_name = '{{ workspace_name }}' -- required
AND job_id = '{{ job_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dataset_export_jobs

Retrieves a paginated list of dataset export jobs for a workspace.

SELECT
completed_at,
destination_s3_uri,
job_id,
started_at,
status
FROM aws.iotsitewise.dataset_export_jobs
WHERE workspace_name = '{{ workspace_name }}' -- required
AND region = '{{ region }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_dataset_export_job

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace's jobs.

INSERT INTO aws.iotsitewise.dataset_export_jobs (
clientToken,
destinationS3Uri,
input,
errorReportLocation,
workspace_name,
region
)
SELECT 
'{{ clientToken }}',
'{{ destinationS3Uri }}' /* required */,
'{{ input }}' /* required */,
'{{ errorReportLocation }}' /* required */,
'{{ workspace_name }}',
'{{ region }}'
RETURNING
job_id,
workspace_name
;

Manifest

# Description fields are for documentation purposes
- name: dataset_export_jobs
props:
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the dataset_export_jobs resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dataset_export_jobs resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: destinationS3Uri
    value: "{{ destinationS3Uri }}"
    description: |
      `<p>`An S3 URI identifying an object location, in the form s3://bucket/key.</p>
  - name: input
    description: |
      `<p>`Input source for processing. Specify exactly one option.</p>
    value:
      timeseries:
        - timeSeriesId: "{{ timeSeriesId }}"
          propertyAlias: "{{ propertyAlias }}"
          trimSettings:
            startTime:
              timeInSeconds: {{ timeInSeconds }}
              offsetInNanos: {{ offsetInNanos }}
            endTime:
              timeInSeconds: {{ timeInSeconds }}
              offsetInNanos: {{ offsetInNanos }}
          formatSettings:
            framesPerSecond: {{ framesPerSecond }}
            widthInPixels: {{ widthInPixels }}
            heightInPixels: {{ heightInPixels }}
      dataset:
        datasetId: "{{ datasetId }}"
        trimSettings:
          startTime:
            timeInSeconds: {{ timeInSeconds }}
            offsetInNanos: {{ offsetInNanos }}
          endTime:
            timeInSeconds: {{ timeInSeconds }}
            offsetInNanos: {{ offsetInNanos }}
        exportDataTypes:
          - "{{ exportDataTypes }}"
  - name: errorReportLocation
    description: |
      `<p>`Contains the location where error reports will be written on failure.</p>
    value:
      s3Uri: "{{ s3Uri }}"