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.

See also: AWS API Documentation

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) – <p>List of individual timeseries items to process.</p>

      • (dict) – <p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>

        • timeSeriesId (string) – <p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>

        • propertyAlias (string) – <p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>

        • trimSettings (dict) – <p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>

          • startTime (dict) – [REQUIRED] <p>The start time for the trim range.</p>

            • 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] <p>The end time for the trim range. Must be greater than startTime.</p>

            • 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) – <p>The optional format settings for the output.</p>

          • framesPerSecond (integer) – <p>The target frame rate for the output.</p>

          • widthInPixels (integer) – <p>The target width of the output, in pixels.</p>

          • heightInPixels (integer) – <p>The target height of the output, in pixels.</p>

    • dataset (dict) – <p>A dataset containing multiple items to process.</p>

      • datasetId (string) – [REQUIRED] <p>The unique identifier for the dataset.</p>

      • trimSettings (dict) – <p>The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.</p>

        • startTime (dict) – [REQUIRED] <p>The start time for the trim range.</p>

          • 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] <p>The end time for the trim range. Must be greater than startTime.</p>

          • 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) – <p>The optional subset of data types to export. If omitted, all data types are exported.</p>

        • (string) – <p>Data types that can be exported from a dataset.</p>

  • errorReportLocation (dict) –

    [REQUIRED]

    The location where the error report will be written on failure.

    • s3Uri (string) – [REQUIRED] <p>The S3 URI prefix for the error report.</p>

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