Amazon IoT SiteWise

Amazon IoT SiteWise Iot Sitewise Actions API

The Iot Sitewise Actions API from Amazon IoT SiteWise — 2 operation(s) for iot sitewise actions.

GitHub OpenAPI

Operations 3

GET /actions/{actionId} Describe Action #
POST /actions Execute Action #
GET /actions List Actions #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-iot-sitewise/openapi/amazon-iot-sitewise-actions-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-actions-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-actions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS IoT SiteWise Actions 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: Actions
paths:
  /actions/{actionId}:
    get:
      operationId: DescribeAction
      summary: Describe Action
      description: Retrieves information about an action.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeActionResponse'
        '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/DescribeActionRequest'
      tags:
      - Actions
  /actions:
    post:
      operationId: ExecuteAction
      summary: Execute Action
      description: Executes an action on a target resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteActionResponse'
        '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'
        '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/ExecuteActionRequest'
      tags:
      - Actions
    get:
      operationId: ListActions
      summary: List Actions
      description: Retrieves a paginated list of actions for a specific target resource.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListActionsResponse'
        '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/ListActionsRequest'
      tags:
      - Actions
components:
  schemas:
    ExecuteActionResponse:
      type: object
      properties:
        actionId:
          type: string
          description: The ID of the action.
      required:
      - actionId
    ListActionsRequest:
      type: object
      properties:
        targetResourceType:
          type: string
          enum:
          - ASSET
          - COMPUTATION_MODEL
          description: The type of resource.
        targetResourceId:
          type: string
          description: The ID of the target resource.
        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.
        resolveToResourceType:
          type: string
          enum:
          - ASSET
          description: The type of the resolved resource.
        resolveToResourceId:
          type: string
          description: The ID of the resolved resource.
      required:
      - targetResourceType
      - targetResourceId
    ExecuteActionRequest:
      type: object
      properties:
        targetResource:
          $ref: '#/components/schemas/TargetResource'
        actionDefinitionId:
          type: string
          description: The ID of the action definition.
        actionPayload:
          $ref: '#/components/schemas/ActionPayload'
        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.
        resolveTo:
          $ref: '#/components/schemas/ResolveTo'
      required:
      - targetResource
      - actionDefinitionId
      - actionPayload
    ActionSummary:
      type: object
      properties:
        actionId:
          type: string
          description: The ID of the action.
        actionDefinitionId:
          type: string
          description: The ID of the action definition.
        targetResource:
          $ref: '#/components/schemas/TargetResource'
        resolveTo:
          $ref: '#/components/schemas/ResolveTo'
    TargetResource:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset, in UUID format.
        computationModelId:
          type: string
          description: The ID of the computation model.
    ListActionsResponse:
      type: object
      properties:
        actionSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ActionSummary'
          description: A list that summarizes the actions associated with the specified asset.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - actionSummaries
      - nextToken
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    DescribeActionResponse:
      type: object
      properties:
        actionId:
          type: string
          description: The ID of the action.
        targetResource:
          $ref: '#/components/schemas/TargetResource'
        actionDefinitionId:
          type: string
          description: The ID of the action definition.
        actionPayload:
          $ref: '#/components/schemas/ActionPayload'
        executionTime:
          type: string
          format: date-time
          description: The time the action was executed.
        resolveTo:
          $ref: '#/components/schemas/ResolveTo'
      required:
      - actionId
      - targetResource
      - actionDefinitionId
      - actionPayload
      - executionTime
    ResolveTo:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset that the resource resolves to.
      required:
      - assetId
    DescribeActionRequest:
      type: object
      properties:
        actionId:
          type: string
          description: The ID of the action.
      required:
      - actionId
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ActionPayload:
      type: object
      properties:
        stringValue:
          type: string
          description: The payload of the action in a JSON string.
      required:
      - stringValue
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    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
  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)