Amazon IoT SiteWise

Amazon IoT SiteWise Time Series API

The Time Series API from Amazon IoT SiteWise — 5 operation(s) for time series.

Documentation GitHub OpenAPI

Operations 5

POST /timeseries/associate Associate Time Series To Asset Property #

POST /timeseries/delete Delete Time Series #

GET /timeseries/describe Describe Time Series #

POST /timeseries/disassociate Disassociate Time Series From Asset Property #

GET /timeseries List Time Series #

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-time-series-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

openapi: 3.1.0
info:
  title: AWS IoT SiteWise Time Series 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: []
paths:
  /timeseries/associate:
    post:
      operationId: AssociateTimeSeriesToAssetProperty
      summary: Associate Time Series To Asset Property
      description: Associates a time series (data stream) with an asset property.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/AssociateTimeSeriesToAssetPropertyRequest'
      tags:
      - Time Series
  /timeseries/delete:
    post:
      operationId: DeleteTimeSeries
      summary: Delete Time Series
      description: 'Deletes a time series (data stream). If you delete a time series that''s associated with an asset property,
        the asset property still exists, but the time series will no longer be associated with this asset property. You can''t
        delete a time series until all of its data segments have been deleted from session datasets. To identify a time series,
        do one of the following: If the time series isn''t associated with an asset property, specify the alias of the time
        series. If the time series is associated with an asset property, specify one of the following: The alias of the time
        series. The assetId and propertyId that identifies the asset property.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteTimeSeriesRequest'
      tags:
      - Time Series
  /timeseries/describe:
    get:
      operationId: DescribeTimeSeries
      summary: Describe Time Series
      description: 'Retrieves information about a time series (data stream). To identify a time series, do one of the following:
        If the time series isn''t associated with an asset property, specify the alias of the time series. If the time series
        is associated with an asset property, specify one of the following: The alias of the time series. The assetId and
        propertyId that identifies the asset property.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeTimeSeriesResponse'
        '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/DescribeTimeSeriesRequest'
      tags:
      - Time Series
  /timeseries/disassociate:
    post:
      operationId: DisassociateTimeSeriesFromAssetProperty
      summary: Disassociate Time Series From Asset Property
      description: Disassociates a time series (data stream) from an asset property.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DisassociateTimeSeriesFromAssetPropertyRequest'
      tags:
      - Time Series
  /timeseries:
    get:
      operationId: ListTimeSeries
      summary: List Time Series
      description: Retrieves a paginated list of time series (data streams).
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTimeSeriesResponse'
        '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/ListTimeSeriesRequest'
      tags:
      - Time Series
components:
  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
  schemas:
    AssociateTimeSeriesToAssetPropertyRequest:
      type: object
      properties:
        alias:
          type: string
          description: The alias that identifies the time series.
        assetId:
          type: string
          description: 'The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
            format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
            objects with external IDs in the IoT SiteWise User Guide.'
        propertyId:
          type: string
          description: 'The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
            followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in
            the IoT SiteWise User Guide.'
        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:
      - alias
      - assetId
      - propertyId
    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
    DeleteTimeSeriesRequest:
      type: object
      properties:
        alias:
          type: string
          description: The alias that identifies the time series.
        assetId:
          type: string
          description: 'The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
            format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
            objects with external IDs in the IoT SiteWise User Guide.'
        propertyId:
          type: string
          description: 'The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
            followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in
            the IoT SiteWise User Guide.'
        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.
        workspaceName:
          type: string
          description: The name of the workspace.
    DescribeTimeSeriesRequest:
      type: object
      properties:
        alias:
          type: string
          description: The alias that identifies the time series.
        assetId:
          type: string
          description: 'The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
            format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
            objects with external IDs in the IoT SiteWise User Guide.'
        propertyId:
          type: string
          description: 'The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
            followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in
            the IoT SiteWise User Guide.'
        workspaceName:
          type: string
          description: The name of the workspace.
    DescribeTimeSeriesResponse:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset in which the asset property was created.
        propertyId:
          type: string
          description: The ID of the asset property, in UUID format.
        alias:
          type: string
          description: The alias that identifies the time series.
        timeSeriesId:
          type: string
          description: The ID of the time series.
        dataType:
          type: string
          enum:
          - STRING
          - INTEGER
          - DOUBLE
          - BOOLEAN
          - STRUCT
          - VIDEO
          - ANNOTATION
          - JSON
          description: The data type of the time series. If you specify STRUCT, you must also specify dataTypeSpec to identify
            the type of the structure for this time series.
        dataTypeSpec:
          type: string
          description: The data type of the structure for this time series. This parameter is required for time series that
            have the STRUCT data type. The options for this parameter depend on the type of the composite model in which you
            created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm
            composite models.
        timeSeriesCreationDate:
          type: string
          format: date-time
          description: The date that the time series was created, in Unix epoch time.
        timeSeriesLastUpdateDate:
          type: string
          format: date-time
          description: The date that the time series was last updated, in Unix epoch time.
        timeSeriesArn:
          type: string
          description: The ARN of the time series, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
        workspaceName:
          type: string
          description: The name of the workspace.
      required:
      - timeSeriesId
      - dataType
      - timeSeriesCreationDate
      - timeSeriesLastUpdateDate
      - timeSeriesArn
    DisassociateTimeSeriesFromAssetPropertyRequest:
      type: object
      properties:
        alias:
          type: string
          description: The alias that identifies the time series.
        assetId:
          type: string
          description: 'The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
            format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
            objects with external IDs in the IoT SiteWise User Guide.'
        propertyId:
          type: string
          description: 'The ID of the asset property. This can be either the actual ID in UUID format, or else externalId:
            followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in
            the IoT SiteWise User Guide.'
        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:
      - alias
      - assetId
      - propertyId
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListTimeSeriesRequest:
      type: object
      properties:
        nextToken:
          type: string
          description: The token to be used for the next set of paginated results.
        maxResults:
          type: integer
          description: The maximum number of results to return for each paginated request.
        assetId:
          type: string
          description: 'The ID of the asset in which the asset property was created. This can be either the actual ID in UUID
            format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing
            objects with external IDs in the IoT SiteWise User Guide.'
        aliasPrefix:
          type: string
          description: The alias prefix of the time series.
        timeSeriesType:
          type: string
          enum:
          - ASSOCIATED
          - DISASSOCIATED
          description: 'The type of the time series. The time series type can be one of the following values: ASSOCIATED –
            The time series is associated with an asset property. DISASSOCIATED – The time series isn''t associated with any
            asset property.'
        workspaceName:
          type: string
          description: The name of the workspace.
    ListTimeSeriesResponse:
      type: object
      properties:
        TimeSeriesSummaries:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesSummary'
          description: One or more time series summaries to list.
        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:
      - TimeSeriesSummaries
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    TimeSeriesSummary:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset in which the asset property was created.
        propertyId:
          type: string
          description: The ID of the asset property, in UUID format.
        alias:
          type: string
          description: The alias that identifies the time series.
        timeSeriesId:
          type: string
          description: The ID of the time series.
        dataType:
          type: string
          enum:
          - STRING
          - INTEGER
          - DOUBLE
          - BOOLEAN
          - STRUCT
          - VIDEO
          - ANNOTATION
          - JSON
          description: The data type of the time series. If you specify STRUCT, you must also specify dataTypeSpec to identify
            the type of the structure for this time series.
        dataTypeSpec:
          type: string
          description: The data type of the structure for this time series. This parameter is required for time series that
            have the STRUCT data type. The options for this parameter depend on the type of the composite model in which you
            created the asset property that is associated with your time series. Use AWS/ALARM_STATE for alarm state in alarm
            composite models.
        timeSeriesCreationDate:
          type: string
          format: date-time
          description: The date that the time series was created, in Unix epoch time.
        timeSeriesLastUpdateDate:
          type: string
          format: date-time
          description: The date that the time series was last updated, in Unix epoch time.
        timeSeriesArn:
          type: string
          description: The ARN of the time series, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId}
      required:
      - timeSeriesId
      - dataType
      - timeSeriesCreationDate
      - timeSeriesLastUpdateDate
      - timeSeriesArn
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/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)

Amazon IoT SiteWise Time Series API

Operations 5

Documentation

Specifications

Schemas & Data

Other Resources