AWS IoT SiteWise

{'jobName': 'string'}

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

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',
            ]
        }
    },
    jobName='string',
    errorReportLocation={
        's3Uri': 'string'
    }
)

type workspaceName:

string

param workspaceName:

[REQUIRED]

The name of the workspace in which to create the dataset export job.

type clientToken:

string

param clientToken:

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.

type destinationS3Uri:

string

param destinationS3Uri:

[REQUIRED]

The S3 URI where output clips will be written.

type input:

dict

param input:

[REQUIRED]

The processing input source.

• 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>

type jobName:

string

param jobName:

An optional name for the export job. When omitted, one will be created based on type of job and start time.

type errorReportLocation:

dict

param errorReportLocation:

[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>

rtype:

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.

{'jobName': 'string'}

Retrieves information about a dataset export job.

See also: AWS API Documentation

Request Syntax

client.describe_dataset_export_job(
    workspaceName='string',
    jobId='string'
)

type workspaceName:

string

param workspaceName:

[REQUIRED]

The name of the workspace that contains the dataset export job.

type jobId:

string

param jobId:

[REQUIRED]

The unique identifier for the dataset export job.

rtype:

dict

returns:

Response Syntax

{
    'jobId': 'string',
    'workspaceName': 'string',
    'jobName': 'string',
    'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    'startedAt': datetime(2015, 1, 1),
    'completedAt': datetime(2015, 1, 1),
    'destinationS3Uri': 'string',
    'errorReportLocation': {
        's3Uri': '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',
            ]
        }
    }
}

Response Structure

• (dict) --

  Response for describe dataset export job request.

  • jobId (string) --

    The unique identifier for the dataset export job.

  • workspaceName (string) --

    The name of the workspace that contains the dataset export job.

  • jobName (string) --

    The name of the dataset export job.

  • status (string) --

    The current status of the dataset export job.

  • startedAt (datetime) --

    The timestamp when the job started processing.

  • completedAt (datetime) --

    The timestamp when the job completed, or null if the job is still running.

  • destinationS3Uri (string) --

    The S3 URI where output clips are written.

  • errorReportLocation (dict) --

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

    • s3Uri (string) -- <p>The S3 URI prefix for the error report.</p>

  • input (dict) --

    The processing input that was provided in the CreateDatasetExportJob request.

    • 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) -- <p>The start time for the trim range.</p>

            • timeInSeconds (integer) --

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

            • timeInSeconds (integer) --

              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) -- <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) -- <p>The start time for the trim range.</p>

          • timeInSeconds (integer) --

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

          • timeInSeconds (integer) --

            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>

{'jobs': {'jobName': 'string'}}

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

See also: AWS API Documentation

Request Syntax

client.list_dataset_export_jobs(
    workspaceName='string',
    filter='ALL'|'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
    maxResults=123,
    nextToken='string'
)

type workspaceName:

string

param workspaceName:

[REQUIRED]

The name of the workspace whose dataset export jobs should be listed.

type filter:

string

param filter:

The optional filter that returns only jobs matching the given filter value. Defaults to ALL.

type maxResults:

integer

param maxResults:

The maximum number of results to return for each paginated request.

type nextToken:

string

param nextToken:

The token to be used for the next set of paginated results.

rtype:

dict

returns:

Response Syntax

{
    'jobs': [
        {
            'jobId': 'string',
            'jobName': 'string',
            'status': 'SUBMITTED'|'RUNNING'|'COMPLETED'|'COMPLETED_WITH_ERRORS'|'FAILED',
            'startedAt': datetime(2015, 1, 1),
            'completedAt': datetime(2015, 1, 1),
            'destinationS3Uri': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  Response for list dataset export jobs request.

  • jobs (list) --

    A list of dataset export job summaries.

    • (dict) -- <p>Contains summary information about a dataset export job.</p>

      • jobId (string) -- <p>The unique identifier for the dataset export job.</p>

      • jobName (string) -- <p>The name of the dataset export job.</p>

      • status (string) -- <p>The current status of the dataset export job.</p>

      • startedAt (datetime) -- <p>The timestamp when the job started processing.</p>

      • completedAt (datetime) -- <p>The timestamp when the job completed, or null if the job is still running.</p>

      • destinationS3Uri (string) -- <p>The S3 URI where output clips are written.</p>

  • nextToken (string) --

    The token for the next set of results, or null if there are no additional results.