Amazon IoT SiteWise Iot Sitewise Datasets API

openapi: 3.2.0
info:
  title: AWS IoT SiteWise Datasets API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 5 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: Datasets
paths:
  /datasets:
    post:
      operationId: CreateDataset
      summary: Create Dataset
      description: Creates a dataset. Session and curated datasets are created in a workspace. A session dataset contains data segments of time series data, and a curated dataset curates data segments selected from source session datasets. A dataset that connects to an external datasource is created outside of a workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDatasetResponse'
        '409':
          description: ConflictingOperationException; ResourceAlreadyExistsException
          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'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '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/CreateDatasetRequest'
      tags:
      - Datasets
    get:
      operationId: ListDatasets
      summary: List Datasets
      description: Retrieves a paginated list of datasets for a specific target resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDatasetsResponse'
        '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/ListDatasetsRequest'
      tags:
      - Datasets
  /datasets/{datasetId}:
    delete:
      operationId: DeleteDataset
      summary: Delete Dataset
      description: Deletes a dataset. This can't be undone. Deleting a session dataset also deletes the underlying time series data in the session. You can't delete a session dataset while a curated dataset references its data segments. First delete the curated dataset or disassociate the data segments. Deleting a curated dataset doesn't delete the underlying data in the source session datasets.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteDatasetResponse'
        '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/DeleteDatasetRequest'
      tags:
      - Datasets
    get:
      operationId: DescribeDataset
      summary: Describe Dataset
      description: Retrieves information about a dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeDatasetResponse'
        '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/DescribeDatasetRequest'
      tags:
      - Datasets
    put:
      operationId: UpdateDataset
      summary: Update Dataset
      description: Updates a dataset.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateDatasetResponse'
        '409':
          description: ConflictingOperationException; ResourceAlreadyExistsException
          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'
        '410':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '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/UpdateDatasetRequest'
      tags:
      - Datasets
components:
  schemas:
    KendraSourceDetail:
      type: object
      properties:
        knowledgeBaseArn:
          type: string
          description: The knowledgeBaseArn details for the Kendra dataset source.
        roleArn:
          type: string
          description: The roleARN details for the Kendra dataset source.
      required:
      - knowledgeBaseArn
      - roleArn
    ListDatasetsResponse:
      type: object
      properties:
        datasetSummaries:
          type: array
          items:
            $ref: '#/components/schemas/DatasetSummary'
          description: A list that summarizes the dataset response.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
        workspaceName:
          type: string
          description: The name of the workspace.
      required:
      - datasetSummaries
    DeleteDatasetResponse:
      type: object
      properties:
        datasetStatus:
          $ref: '#/components/schemas/DatasetStatus'
      required:
      - datasetStatus
    SessionConfig:
      type: object
      properties:
        sessionStartTimestamp:
          $ref: '#/components/schemas/TimeInNanos'
        sessionEndTimestamp:
          $ref: '#/components/schemas/TimeInNanos'
      required:
      - sessionStartTimestamp
      - sessionEndTimestamp
    CreateDatasetResponse:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        datasetArn:
          type: string
          description: The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
        datasetStatus:
          $ref: '#/components/schemas/DatasetStatus'
      required:
      - datasetId
      - datasetArn
      - datasetStatus
    DatasetStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - FAILED
          description: The current status of the dataset.
        error:
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - state
    ListDatasetsRequest:
      type: object
      properties:
        sourceType:
          type: string
          enum:
          - KENDRA
          - SITEWISE
          description: The type of data source for the dataset.
        workspaceName:
          type: string
          description: The name of the workspace to filter datasets by.
        datasetType:
          type: string
          enum:
          - SESSION
          - CURATED
          - EXTERNAL
          description: 'The type of dataset to filter by: a session dataset, a curated dataset, or a connection to an external datasource.'
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
        maxResults:
          type: integer
          description: The maximum number of results to return for each paginated request.
      required:
      - sourceType
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    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
    DescribeDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset.
        datasetVersion:
          type: string
          description: The version of the dataset.
      required:
      - datasetId
    DeleteDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset.
        clientToken:
          type: string
          description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
      required:
      - datasetId
    UpdateDatasetResponse:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        datasetArn:
          type: string
          description: The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
        datasetStatus:
          $ref: '#/components/schemas/DatasetStatus'
    CreateDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        datasetName:
          type: string
          description: The name of the dataset.
        datasetDescription:
          type: string
          description: A description about the dataset, and its functionality.
        datasetType:
          type: string
          enum:
          - SESSION
          - CURATED
          - EXTERNAL
          description: 'The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.'
        datasetConfig:
          $ref: '#/components/schemas/DatasetConfig'
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset. Required for session and curated datasets. Omit this field for datasets that connect to an external datasource.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata for the dataset, provided as key-value pairs.
        datasetSource:
          $ref: '#/components/schemas/DatasetSource'
        clientToken:
          type: string
          description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
      required:
      - datasetName
      - datasetSource
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DatasetSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the dataset.
        arn:
          type: string
          description: The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
        name:
          type: string
          description: The name of the dataset.
        description:
          type: string
          description: A description about the dataset, and its functionality.
        sourceType:
          type: string
          enum:
          - KENDRA
          - SITEWISE
          description: The data source type of the dataset.
        datasetType:
          type: string
          enum:
          - SESSION
          - CURATED
          - EXTERNAL
          description: 'The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.'
        creationDate:
          type: string
          format: date-time
          description: The dataset creation date, in Unix epoch time.
        lastUpdateDate:
          type: string
          format: date-time
          description: The date the dataset was last updated, in Unix epoch time.
        status:
          $ref: '#/components/schemas/DatasetStatus'
        enrichmentStatus:
          $ref: '#/components/schemas/DatasetEnrichment'
      required:
      - id
      - arn
      - name
      - description
      - creationDate
      - lastUpdateDate
      - status
    DetailedError:
      type: object
      properties:
        code:
          type: string
          enum:
          - INCOMPATIBLE_COMPUTE_LOCATION
          - INCOMPATIBLE_FORWARDING_CONFIGURATION
          description: The error code.
        message:
          type: string
          description: The error message.
      required:
      - code
      - message
    ErrorDetails:
      type: object
      properties:
        code:
          type: string
          enum:
          - VALIDATION_ERROR
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
        details:
          type: array
          items:
            $ref: '#/components/schemas/DetailedError'
          description: A list of detailed errors.
      required:
      - code
      - message
    DatasetConfig:
      type: object
      properties:
        session:
          $ref: '#/components/schemas/SessionConfig'
    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
    DatasetEnrichmentEntry:
      type: object
      properties:
        status:
          type: string
          enum:
          - FULLY_ENRICHED
          - PARTIALLY_ENRICHED
          - NOT_ENRICHED
          description: The enrichment status of the data type in the dataset.
        lastEnrichedAt:
          type: string
          format: date-time
          description: The date the data was last enriched, in Unix epoch time.
      required:
      - status
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateDatasetRequest:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset.
        datasetName:
          type: string
          description: The name of the dataset.
        datasetDescription:
          type: string
          description: A description about the dataset, and its functionality.
        datasetConfig:
          $ref: '#/components/schemas/DatasetConfig'
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The updated metadata for the dataset.
        datasetSource:
          $ref: '#/components/schemas/DatasetSource'
        clientToken:
          type: string
          description: A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
      required:
      - datasetId
      - datasetName
      - datasetSource
    DatasetSource:
      type: object
      properties:
        sourceType:
          type: string
          enum:
          - KENDRA
          - SITEWISE
          description: The type of data source for the dataset.
        sourceFormat:
          type: string
          enum:
          - KNOWLEDGE_BASE
          - TIMESERIES
          description: The format of the dataset source associated with the dataset.
        sourceDetail:
          $ref: '#/components/schemas/SourceDetail'
      required:
      - sourceType
      - sourceFormat
    DescribeDatasetResponse:
      type: object
      properties:
        datasetId:
          type: string
          description: The ID of the dataset.
        datasetArn:
          type: string
          description: The ARN of the dataset. The format is arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}.
        datasetName:
          type: string
          description: The name of the dataset.
        datasetDescription:
          type: string
          description: A description about the dataset, and its functionality.
        datasetType:
          type: string
          enum:
          - SESSION
          - CURATED
          - EXTERNAL
          description: 'The type of dataset: a session dataset, a curated dataset, or a connection to an external datasource.'
        datasetConfig:
          $ref: '#/components/schemas/DatasetConfig'
        workspaceName:
          type: string
          description: The name of the workspace that contains the dataset.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: The metadata for the dataset.
        datasetSource:
          $ref: '#/components/schemas/DatasetSource'
        datasetStatus:
          $ref: '#/components/schemas/DatasetStatus'
        datasetCreationDate:
          type: string
          format: date-time
          description: The dataset creation date, in Unix epoch time.
        datasetLastUpdateDate:
          type: string
          format: date-time
          description: The date the dataset was last updated, in Unix epoch time.
        datasetVersion:
          type: string
          description: The version of the dataset.
        enrichmentStatus:
          $ref: '#/components/schemas/DatasetEnrichment'
      required:
      - datasetId
      - datasetArn
      - datasetName
      - datasetDescription
      - datasetSource
      - datasetStatus
      - datasetCreationDate
      - datasetLastUpdateDate
    SourceDetail:
      type: object
      properties:
        kendra:
          $ref: '#/components/schemas/KendraSourceDetail'
    DatasetEnrichment:
      type: object
      properties:
        video:
          $ref: '#/components/schemas/DatasetEnrichmentEntry'
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
  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)