openapi: 3.0.0
info:
  version: '2021-11-29'
  x-release: v4
  title: AWS IoT TwinMaker Pricingplan Queries API
  description: IoT TwinMaker is a service with which you can build operational digital twins of physical systems. IoT TwinMaker overlays measurements and analysis from real-world sensors, cameras, and enterprise applications so you can create data visualizations to monitor your physical factory, building, or industrial plant. You can use this real-world data to monitor operations and diagnose and repair errors.
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: iottwinmaker
  x-aws-signingName: iottwinmaker
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iottwinmaker-2021-11-29.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://iottwinmaker.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: https://iottwinmaker.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The AWS IoT TwinMaker multi-region endpoint
- url: http://iottwinmaker.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
- url: https://iottwinmaker.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The AWS IoT TwinMaker endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Queries
paths:
  /queries/execution:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ExecuteQuery
      description: Run queries to access information from your knowledge graph of entities within individual workspaces.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteQueryResponse'
        '480':
          description: InternalServerException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '481':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '482':
          description: QueryTimeoutException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryTimeoutException'
        '483':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
        '484':
          description: ValidationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationException'
        '485':
          description: ServiceQuotaExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceQuotaExceededException'
      parameters:
      - name: maxResults
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: nextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - workspaceId
              - queryStatement
              properties:
                workspaceId:
                  description: The ID of the workspace.
                  type: string
                  pattern: '[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+'
                  minLength: 1
                  maxLength: 128
                queryStatement:
                  description: The query statement.
                  type: string
                  pattern: '[\s\S]+'
                  minLength: 1
                  maxLength: 1000
                maxResults:
                  description: '<p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>'
                  type: integer
                  minimum: 1
                  maximum: 100
                nextToken:
                  description: The string that specifies the next page of results.
                  type: string
                  pattern: .*
                  minLength: 0
                  maxLength: 17880
      summary: Amazon IoT TwinMaker Execute Query
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - Queries
components:
  parameters:
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
  schemas:
    Row:
      type: object
      properties:
        rowData:
          allOf:
          - $ref: '#/components/schemas/RowData'
          - description: The data in a row of query results.
      description: Represents a single row in the query results.
    ColumnDescriptions:
      type: array
      items:
        $ref: '#/components/schemas/ColumnDescription'
    ServiceQuotaExceededException: {}
    NextToken:
      type: string
      pattern: .*
      minLength: 0
      maxLength: 17880
    ColumnType:
      type: string
      enum:
      - NODE
      - EDGE
      - VALUE
    ExecuteQueryResponse:
      type: object
      properties:
        columnDescriptions:
          allOf:
          - $ref: '#/components/schemas/ColumnDescriptions'
          - description: A list of ColumnDescription objects.
        rows:
          allOf:
          - $ref: '#/components/schemas/Rows'
          - description: Represents a single row in the query results.
        nextToken:
          allOf:
          - $ref: '#/components/schemas/NextToken'
          - description: The string that specifies the next page of results.
    AccessDeniedException: {}
    ColumnDescription:
      type: object
      properties:
        name:
          allOf:
          - $ref: '#/components/schemas/ColumnName'
          - description: The name of the column description.
        type:
          allOf:
          - $ref: '#/components/schemas/ColumnType'
          - description: The type of the column description.
      description: A description of the column in the query results.
    QueryTimeoutException: {}
    RowData:
      type: array
      items:
        $ref: '#/components/schemas/QueryResultValue'
    ThrottlingException: {}
    Rows:
      type: array
      items:
        $ref: '#/components/schemas/Row'
    QueryResultValue:
      type: object
      properties: {}
    ValidationException: {}
    InternalServerException: {}
    ColumnName:
      type: string
      pattern: .*
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/iottwinmaker/
x-hasEquivalentPaths: true