IoTSiteWise / Client / create_dataset_export_job

create_dataset_export_job¶

IoTSiteWise.Client.create_dataset_export_job(**kwargs)¶

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.

Request Syntax

response = client.create_dataset_export_job(
    workspaceName='string',
    clientToken='string',
    destinationS3Uri='string',
    input={
        'timeseries': [
            {
                'timeSeriesId': 'string',
                'propertyAlias': 'string',
                'trimSettings': {
                    'startTime': {
                        'timeInSeconds': 123,
                        'offsetInNanos': 123
                    },
                    'endTime': {
                        'timeInSeconds': 123,
                        'offsetInNanos': 123
                    }
                },
                'formatSettings': {
                    'framesPerSecond': 123,
                    'widthInPixels': 123,
                    'heightInPixels': 123
                }
            },
        ],
        'dataset': {
            'datasetId': 'string',
            'trimSettings': {
                'startTime': {
                    'timeInSeconds': 123,
                    'offsetInNanos': 123
                },
                'endTime': {
                    'timeInSeconds': 123,
                    'offsetInNanos': 123
                }
            },
            'exportDataTypes': [
                'VIDEO'|'TELEMETRY'|'ANNOTATION',
            ]
        }
    },
    errorReportLocation={
        's3Uri': 'string'
    }
)

Parameters:

workspaceName (string) –
[REQUIRED]

The name of the workspace in which to create the dataset export job.
clientToken (string) –
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.

This field is autopopulated if not provided.
destinationS3Uri (string) –
[REQUIRED]

The S3 URI where output clips will be written.
input (dict) –
[REQUIRED]

The processing input source.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: timeseries, dataset.
- timeseries (list) – List of individual timeseries items to process.
 - (dict) – A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.
 - timeSeriesId (string) – The unique identifier for the timeseries. Mutually exclusive with propertyAlias.
 - propertyAlias (string) – The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.
 - trimSettings (dict) – The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.
 - startTime (dict) – [REQUIRED] The start time for the trim range.
 
 timeInSeconds (integer) – [REQUIRED]
 
 The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
 
 offsetInNanos (integer) –
 
 The nanosecond offset from timeInSeconds.
 - endTime (dict) – [REQUIRED] The end time for the trim range. Must be greater than startTime.
 
 timeInSeconds (integer) – [REQUIRED]
 
 The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
 
 offsetInNanos (integer) –
 
 The nanosecond offset from timeInSeconds.
 - formatSettings (dict) – The optional format settings for the output.
 - framesPerSecond (integer) – The target frame rate for the output.
 - widthInPixels (integer) – The target width of the output, in pixels.
 - heightInPixels (integer) – The target height of the output, in pixels.
- dataset (dict) – A dataset containing multiple items to process.
 - datasetId (string) – [REQUIRED] The unique identifier for the dataset.
 - trimSettings (dict) – The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.
 - startTime (dict) – [REQUIRED] The start time for the trim range.
 - timeInSeconds (integer) – [REQUIRED]
 
 The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
 - offsetInNanos (integer) –
 
 The nanosecond offset from timeInSeconds.
 - endTime (dict) – [REQUIRED] The end time for the trim range. Must be greater than startTime.
 - timeInSeconds (integer) – [REQUIRED]
 
 The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
 - offsetInNanos (integer) –
 
 The nanosecond offset from timeInSeconds.
 - exportDataTypes (list) – The optional subset of data types to export. If omitted, all data types are exported.
 - (string) – Data types that can be exported from a dataset.
errorReportLocation (dict) –
[REQUIRED]

The location where the error report will be written on failure.
- s3Uri (string) – [REQUIRED] The S3 URI prefix for the error report.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'workspaceName': 'string'
}

Response Structure

(dict) –

Response for create dataset export job request.
- jobId (string) –
  
  The unique identifier for the dataset export job.
- workspaceName (string) –
  
  The name of the workspace in which the dataset export job was created.

Exceptions

IoTSiteWise.Client.exceptions.InternalFailureException
IoTSiteWise.Client.exceptions.AccessDeniedException
IoTSiteWise.Client.exceptions.InvalidRequestException
IoTSiteWise.Client.exceptions.ResourceNotFoundException
IoTSiteWise.Client.exceptions.ThrottlingException
IoTSiteWise.Client.exceptions.ConflictingOperationException