Amazon IoT SiteWise Iot Sitewise Computation Models API

openapi: 3.2.0
info:
  title: AWS IoT SiteWise Computation Models API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 6 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: Computation Models
paths:
  /computation-models:
    post:
      operationId: CreateComputationModel
      summary: Create Computation Model
      description: Create a computation model with a configuration and data binding.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComputationModelResponse'
        '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/CreateComputationModelRequest'
      tags:
      - Computation Models
    get:
      operationId: ListComputationModels
      summary: List Computation Models
      description: Retrieves a paginated list of summaries of all computation models.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComputationModelsResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListComputationModelsRequest'
      tags:
      - Computation Models
  /computation-models/{computationModelId}:
    delete:
      operationId: DeleteComputationModel
      summary: Delete Computation Model
      description: Deletes a computation model. This action can't be undone.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteComputationModelResponse'
        '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/DeleteComputationModelRequest'
      tags:
      - Computation Models
    get:
      operationId: DescribeComputationModel
      summary: Describe Computation Model
      description: Retrieves information about a computation model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeComputationModelResponse'
        '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/DescribeComputationModelRequest'
      tags:
      - Computation Models
    post:
      operationId: UpdateComputationModel
      summary: Update Computation Model
      description: Updates the computation model.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateComputationModelResponse'
        '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/UpdateComputationModelRequest'
      tags:
      - Computation Models
  /computation-models/data-binding-usages:
    post:
      operationId: ListComputationModelDataBindingUsages
      summary: List Computation Model Data Binding Usages
      description: Lists all data binding usages for computation models. This allows to identify where specific data bindings are being utilized across the computation models. This track dependencies between data sources and computation models.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListComputationModelDataBindingUsagesResponse'
        '500':
          description: InternalFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '400':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListComputationModelDataBindingUsagesRequest'
      tags:
      - Computation Models
components:
  schemas:
    ListComputationModelDataBindingUsagesRequest:
      type: object
      properties:
        dataBindingValueFilter:
          $ref: '#/components/schemas/DataBindingValueFilter'
        nextToken:
          type: string
          description: The token used for the next set of paginated results.
        maxResults:
          type: integer
          description: The maximum number of results returned for each paginated request.
      required:
      - dataBindingValueFilter
    DescribeComputationModelRequest:
      type: object
      properties:
        computationModelId:
          type: string
          description: The ID of the computation model.
        computationModelVersion:
          type: string
          description: The version of the computation model.
      required:
      - computationModelId
    ComputationModelAnomalyDetectionConfiguration:
      type: object
      properties:
        inputProperties:
          type: string
          description: Define the variable name associated with input properties, with the following format ${VariableName}.
        resultProperty:
          type: string
          description: Define the variable name associated with the result property, and the following format ${VariableName}.
      required:
      - inputProperties
      - resultProperty
    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
    MatchedDataBinding:
      type: object
      properties:
        value:
          $ref: '#/components/schemas/DataBindingValue'
      required:
      - value
    DeleteComputationModelRequest:
      type: object
      properties:
        computationModelId:
          type: string
          description: The ID of the computation model.
        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:
      - computationModelId
    AssetModelPropertyBindingValueFilter:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model containing the filter property. This identifies the specific asset model that contains the property of interest.
        propertyId:
          type: string
          description: The ID of the property within the asset model to filter by. Only data bindings referencing this specific property of the specified asset model are matched.
      required:
      - assetModelId
      - propertyId
    AssetModelPropertyBindingValue:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model, in UUID format.
        propertyId:
          type: string
          description: The ID of the asset model property used in data binding value.
      required:
      - assetModelId
      - propertyId
    AssetModelBindingValueFilter:
      type: object
      properties:
        assetModelId:
          type: string
          description: The ID of the asset model to filter data bindings by. Only data bindings referemncing this specific asset model are matched.
      required:
      - assetModelId
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    CreateComputationModelResponse:
      type: object
      properties:
        computationModelId:
          type: string
          description: The ID of the computation model.
        computationModelArn:
          type: string
          description: The ARN of the computation model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
        computationModelStatus:
          $ref: '#/components/schemas/ComputationModelStatus'
      required:
      - computationModelId
      - computationModelArn
      - computationModelStatus
    ComputationModelStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - FAILED
          description: The current state of the computation model.
        error:
          $ref: '#/components/schemas/ErrorDetails'
      required:
      - state
    ComputationModelConfiguration:
      type: object
      properties:
        anomalyDetection:
          $ref: '#/components/schemas/ComputationModelAnomalyDetectionConfiguration'
    DataBindingValueFilter:
      type: object
      properties:
        asset:
          $ref: '#/components/schemas/AssetBindingValueFilter'
        assetModel:
          $ref: '#/components/schemas/AssetModelBindingValueFilter'
        assetProperty:
          $ref: '#/components/schemas/AssetPropertyBindingValueFilter'
        assetModelProperty:
          $ref: '#/components/schemas/AssetModelPropertyBindingValueFilter'
    AssetPropertyBindingValueFilter:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset containing the property to filter by. This identifies the specific asset instance containing the property of interest.
        propertyId:
          type: string
          description: The ID of the property within the asset to filter by. Only data bindings referencing this specific property of the specified asset are matched.
      required:
      - assetId
      - propertyId
    ListComputationModelDataBindingUsagesResponse:
      type: object
      properties:
        dataBindingUsageSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ComputationModelDataBindingUsageSummary'
          description: A list of summaries describing the data binding usages across computation models. Each summary includes the computation model IDs and the matched data binding details.
        nextToken:
          type: string
          description: The token for the next set of paginated results, or null if there are no additional results.
      required:
      - dataBindingUsageSummaries
    UpdateComputationModelRequest:
      type: object
      properties:
        computationModelId:
          type: string
          description: The ID of the computation model.
        computationModelName:
          type: string
          description: The name of the computation model.
        computationModelDescription:
          type: string
          description: The description of the computation model.
        computationModelConfiguration:
          $ref: '#/components/schemas/ComputationModelConfiguration'
        computationModelDataBinding:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ComputationModelDataBindingValue'
          description: The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
        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:
      - computationModelId
      - computationModelName
      - computationModelConfiguration
      - computationModelDataBinding
    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
    AssetBindingValueFilter:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset to filter data bindings by. Only data bindings referencing this specific asset are matched.
      required:
      - assetId
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ComputationModelDataBindingUsageSummary:
      type: object
      properties:
        computationModelIds:
          type: array
          items:
            type: string
          description: The list of computation model IDs that use this data binding. This allows identification of all computation models affected by changes to the referenced data source.
        matchedDataBinding:
          $ref: '#/components/schemas/MatchedDataBinding'
      required:
      - computationModelIds
      - matchedDataBinding
    ActionDefinition:
      type: object
      properties:
        actionDefinitionId:
          type: string
          description: The ID of the action definition.
        actionName:
          type: string
          description: The name of the action definition.
        actionType:
          type: string
          description: The type of the action definition.
      required:
      - actionDefinitionId
      - actionName
      - actionType
    ListComputationModelsResponse:
      type: object
      properties:
        computationModelSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ComputationModelSummary'
          description: A list summarizing each computation model.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - computationModelSummaries
    ComputationModelDataBindingValue:
      type: object
      properties:
        assetModelProperty:
          $ref: '#/components/schemas/AssetModelPropertyBindingValue'
        assetProperty:
          $ref: '#/components/schemas/AssetPropertyBindingValue'
        list:
          type: array
          items:
            $ref: '#/components/schemas/ComputationModelDataBindingValue'
          description: Specifies a list of data binding value.
    AssetPropertyBindingValue:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset containing the property. This identifies the specific asset instance's property value used in the computation model.
        propertyId:
          type: string
          description: The ID of the property within the asset. This identifies the specific property's value used in the computation model.
      required:
      - assetId
      - propertyId
    DataBindingValue:
      type: object
      properties:
        assetModelProperty:
          $ref: '#/components/schemas/AssetModelPropertyBindingValue'
        assetProperty:
          $ref: '#/components/schemas/AssetPropertyBindingValue'
    ComputationModelSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the computation model.
        arn:
          type: string
          description: The ARN of the computation model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
        name:
          type: string
          description: The name of the computation model.
        description:
          type: string
          description: The description of the computation model.
        type:
          type: string
          enum:
          - ANOMALY_DETECTION
          description: The type of the computation model.
        creationDate:
          type: string
          format: date-time
          description: The model creation date, in Unix epoch time.
        lastUpdateDate:
          type: string
          format: date-time
          description: The time the model was last updated, in Unix epoch time.
        status:
          $ref: '#/components/schemas/ComputationModelStatus'
        version:
          type: string
          description: The version of the computation model.
      required:
      - id
      - arn
      - name
      - type
      - creationDate
      - lastUpdateDate
      - status
      - version
    CreateComputationModelRequest:
      type: object
      properties:
        computationModelName:
          type: string
          description: The name of the computation model.
        computationModelDescription:
          type: string
          description: The description of the computation model.
        computationModelConfiguration:
          $ref: '#/components/schemas/ComputationModelConfiguration'
        computationModelDataBinding:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ComputationModelDataBindingValue'
          description: The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
        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 asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
      required:
      - computationModelName
      - computationModelConfiguration
      - computationModelDataBinding
    DeleteComputationModelResponse:
      type: object
      properties:
        computationModelStatus:
          $ref: '#/components/schemas/ComputationModelStatus'
      required:
      - computationModelStatus
    DescribeComputationModelResponse:
      type: object
      properties:
        computationModelId:
          type: string
          description: The ID of the computation model.
        computationModelArn:
          type: string
          description: The ARN of the computation model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId}
        computationModelName:
          type: string
          description: The name of the computation model.
        computationModelDescription:
          type: string
          description: The description of the computation model.
        computationModelConfiguration:
          $ref: '#/components/schemas/ComputationModelConfiguration'
        computationModelDataBinding:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ComputationModelDataBindingValue'
          description: The data binding for the computation model. Key is a variable name defined in configuration. Value is a ComputationModelDataBindingValue referenced by the variable.
        computationModelCreationDate:
          type: string
          format: date-time
          description: The model creation date, in Unix epoch time.
        computationModelLastUpdateDate:
          type: string
          format: date-time
          description: The date the model was last updated, in Unix epoch time.
        computationModelStatus:
          $ref: '#/components/schemas/ComputationModelStatus'
        computationModelVersion:
          type: string
          description: The version of the computation model.
        actionDefinitions:
          type: array
          items:
            $ref: '#/components/schemas/ActionDefinition'
          description: The available actions for this computation model.
      required:
      - computationModelId
      - computationModelArn
      - computationModelName
      - computationModelConfiguration
      - computationModelDataBinding
      - computationModelCreationDate
      - computationModelLastUpdateDate
      - computationModelStatus
      - computationModelVersion
      - actionDefinitions
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateComputationModelResponse:
      type: object
      properties:
        computationModelStatus:
          $ref: '#/components/schemas/ComputationModelStatus'
      required:
      - computationModelStatus
    ListComputationModelsRequest:
      type: object
      properties:
        computationModelType:
          type: string
          enum:
          - ANOMALY_DETECTION
          description: The type of computation model. If a computationModelType is not provided, all types of computation models are returned.
        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.
  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)