IoTSiteWise / Client / describe_dataset_export_job

describe_dataset_export_job

IoTSiteWise.Client.describe_dataset_export_job(**kwargs)

Retrieves information about a dataset export job.

See also: AWS API Documentation

Request Syntax

response = client.describe_dataset_export_job(
    workspaceName='string',
    jobId='string'
)
Parameters:

  • workspaceName (string) –

    [REQUIRED]

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

  • jobId (string) –

    [REQUIRED]

    The unique identifier for the dataset export job.

Return type:

dict

Returns:

Response Syntax

{
    'jobId': 'string',
    'workspaceName': '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.

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

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: timeseries, dataset. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

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

Exceptions