Amazon IoT SiteWise

Amazon IoT SiteWise Iot Sitewise Dataset Export Jobs API

The Iot Sitewise Dataset Export Jobs API from Amazon IoT SiteWise — 2 operation(s) for iot sitewise dataset export jobs.

GitHub OpenAPI

Operations 3

POST /workspaces/{workspaceName}/dataset-export-jobs Create Dataset Export Job #
GET /workspaces/{workspaceName}/dataset-export-jobs List Dataset Export Jobs #
GET /workspaces/{workspaceName}/dataset-export-jobs/{jobId} Describe Dataset Export Job #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-iot-sitewise/openapi/amazon-iot-sitewise-dataset-export-jobs-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-iot-sitewise:amazon-iot-sitewise-dataset-export-jobs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-iot-sitewise-dataset-export-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS IoT SiteWise Dataset Export Jobs API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 3 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://iotsitewise.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Dataset Export Jobs
paths:
  /workspaces/{workspaceName}/dataset-export-jobs:
    post:
      operationId: CreateDatasetExportJob
      summary: Create Dataset Export Job
      description: 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.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetExportJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '409':
          description: ConflictingOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictingOperationException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatasetExportJobRequest'
      tags:
      - Dataset Export Jobs
    get:
      operationId: ListDatasetExportJobs
      summary: List Dataset Export Jobs
      description: Retrieves a paginated list of dataset export jobs for a workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetExportJobsResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListDatasetExportJobsRequest'
      tags:
      - Dataset Export Jobs
  /workspaces/{workspaceName}/dataset-export-jobs/{jobId}:
    get:
      operationId: DescribeDatasetExportJob
      summary: Describe Dataset Export Job
      description: Retrieves information about a dataset export job.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDatasetExportJobResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '404':
          description: ResourceNotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceNotFoundException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeDatasetExportJobRequest'
      tags:
      - Dataset Export Jobs
components:
  schemas:
    DescribeDatasetExportJobRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset export job.
        jobId:
          type: string
          description: The unique identifier for the dataset export job.
      required:
      - workspaceName
      - jobId
    ConflictingOperationException:
      type: object
      properties:
        message:
          type: string
        resourceId:
          type: string
          description: The ID of the resource that conflicts with this operation.
        resourceArn:
          type: string
          description: The ARN of the resource that conflicts with this operation.
      required:
      - message
      - resourceId
      - resourceArn
    DatasetItem:
      type: object
      properties:
        datasetId:
          type: string
          description: The unique identifier for the dataset.
        trimSettings:
          $ref: '#/components/schemas/TrimSettings'
        exportDataTypes:
          type: array
          items:
            type: string
            enum:
            - VIDEO
            - TELEMETRY
            - ANNOTATION
          description: The optional subset of data types to export. If omitted, all data types are exported.
      required:
      - datasetId
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    CreateDatasetExportJobResponse:
      type: object
      properties:
        jobId:
          type: string
          description: The unique identifier for the dataset export job.
        workspaceName:
          type: string
          description: The name of the workspace in which the dataset export job was created.
      required:
      - jobId
      - workspaceName
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    TimeseriesItem:
      type: object
      properties:
        timeSeriesId:
          type: string
          description: The unique identifier for the timeseries. Mutually exclusive with propertyAlias.
        propertyAlias:
          type: string
          description: The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.
        trimSettings:
          $ref: '#/components/schemas/TrimSettings'
        formatSettings:
          $ref: '#/components/schemas/FormatSettings'
    CreateDatasetExportJobRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace in which to create the dataset export job.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.
        destinationS3Uri:
          type: string
          description: The S3 URI where output clips will be written.
        input:
          $ref: '#/components/schemas/ProcessingInput'
        errorReportLocation:
          $ref: '#/components/schemas/ExportErrorReportLocation'
      required:
      - workspaceName
      - destinationS3Uri
      - input
      - errorReportLocation
    ExportJobSummary:
      type: object
      properties:
        jobId:
          type: string
          description: The unique identifier for the dataset export job.
        status:
          type: string
          enum:
          - SUBMITTED
          - RUNNING
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The current status of the dataset export job.
        startedAt:
          type: string
          description: The timestamp when the job started processing.
        completedAt:
          type: string
          description: The timestamp when the job completed, or null if the job is still running.
        destinationS3Uri:
          type: string
          description: The S3 URI where output clips are written.
      required:
      - jobId
      - status
      - startedAt
      - destinationS3Uri
    ProcessingInput:
      type: object
      properties:
        timeseries:
          type: array
          items:
            $ref: '#/components/schemas/TimeseriesItem'
          description: List of individual timeseries items to process.
        dataset:
          $ref: '#/components/schemas/DatasetItem'
      description: Exactly one member is set.
    TimeInNanos:
      type: object
      properties:
        timeInSeconds:
          type: integer
          description: The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
        offsetInNanos:
          type: integer
          description: The nanosecond offset from timeInSeconds.
      required:
      - timeInSeconds
    ListDatasetExportJobsResponse:
      type: object
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/ExportJobSummary'
          description: A list of dataset export job summaries.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - jobs
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DescribeDatasetExportJobResponse:
      type: object
      properties:
        jobId:
          type: string
          description: The unique identifier for the dataset export job.
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset export job.
        status:
          type: string
          enum:
          - SUBMITTED
          - RUNNING
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The current status of the dataset export job.
        startedAt:
          type: string
          description: The timestamp when the job started processing.
        completedAt:
          type: string
          description: The timestamp when the job completed, or null if the job is still running.
        destinationS3Uri:
          type: string
          description: The S3 URI where output clips are written.
        errorReportLocation:
          $ref: '#/components/schemas/ExportErrorReportLocation'
        input:
          $ref: '#/components/schemas/ProcessingInput'
      required:
      - jobId
      - workspaceName
      - status
      - startedAt
      - destinationS3Uri
      - errorReportLocation
      - input
    ListDatasetExportJobsRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace whose dataset export jobs should be listed.
        filter:
          type: string
          enum:
          - ALL
          - SUBMITTED
          - RUNNING
          - COMPLETED
          - COMPLETED_WITH_ERRORS
          - FAILED
          description: The optional filter that returns only jobs matching the given filter value. Defaults to ALL.
        maxResults:
          type: integer
          description: The maximum number of results to return for each paginated request.
        nextToken:
          type: string
          description: The token to be used for the next set of paginated results.
      required:
      - workspaceName
    ExportErrorReportLocation:
      type: object
      properties:
        s3Uri:
          type: string
          description: The S3 URI prefix for the error report.
      required:
      - s3Uri
    TrimSettings:
      type: object
      properties:
        startTime:
          $ref: '#/components/schemas/TimeInNanos'
        endTime:
          $ref: '#/components/schemas/TimeInNanos'
      required:
      - startTime
      - endTime
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    FormatSettings:
      type: object
      properties:
        framesPerSecond:
          type: integer
          description: The target frame rate for the output.
        widthInPixels:
          type: integer
          description: The target width of the output, in pixels.
        heightInPixels:
          type: integer
          description: The target height of the output, in pixels.
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: iotsitewise
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/iotsitewise/service/2019-12-02/iotsitewise-2019-12-02.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)