Amazon IoT SiteWise

Amazon IoT SiteWise Iot Sitewise Workspaces API

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

GitHub OpenAPI

Operations 5

POST /workspaces Create Workspace #
GET /workspaces List Workspaces #
DELETE /workspaces/{workspaceName} Delete Workspace #
GET /workspaces/{workspaceName} Describe Workspace #
PUT /workspaces/{workspaceName} Update Workspace #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-iot-sitewise/openapi/amazon-iot-sitewise-workspaces-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-workspaces-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-workspaces-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS IoT SiteWise Workspaces 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: Workspaces
paths:
  /workspaces:
    post:
      operationId: CreateWorkspace
      summary: Create Workspace
      description: Creates a workspace in IoT SiteWise. A workspace isolates its resources, such as datasets, time series, pipelines, and tasks, and their data from other workspaces, and has its own quotas and throttling limits. You must specify an encryption configuration when you create a workspace. The operation returns immediately with the workspace in the CREATING state. Provisioning completes asynchronously, after which the workspace state is ACTIVE, or FAILED if provisioning doesn't complete.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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'
        '429':
          description: ThrottlingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ThrottlingException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWorkspaceRequest'
      tags:
      - Workspaces
    get:
      operationId: ListWorkspaces
      summary: List Workspaces
      description: Retrieves a paginated list of workspaces. Use the nextToken parameter to retrieve additional results.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWorkspacesResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/ListWorkspacesRequest'
      tags:
      - Workspaces
  /workspaces/{workspaceName}:
    delete:
      operationId: DeleteWorkspace
      summary: Delete Workspace
      description: Deletes a workspace. Before you delete a workspace, you must delete all resources contained in or associated with the workspace, such as datasets, time series, pipelines, and tasks.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DeleteWorkspaceRequest'
      tags:
      - Workspaces
    get:
      operationId: DescribeWorkspace
      summary: Describe Workspace
      description: Retrieves information about a workspace.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/DescribeWorkspaceRequest'
      tags:
      - Workspaces
    put:
      operationId: UpdateWorkspace
      summary: Update Workspace
      description: Updates a workspace. You can update only workspaces in the ACTIVE or FAILED state. Fields that you omit from the request are left unchanged. To recover a workspace in the FAILED state, call this operation and supply its encryption configuration again.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWorkspaceResponse'
        '403':
          description: AccessDeniedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '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/UpdateWorkspaceRequest'
      tags:
      - Workspaces
components:
  schemas:
    WorkspaceErrorDetails:
      type: object
      properties:
        code:
          type: string
          enum:
          - VALIDATION_ERROR
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
      required:
      - code
      - message
    DescribeWorkspaceResponse:
      type: object
      properties:
        workspaceArn:
          type: string
          description: The ARN of the workspace.
        workspaceName:
          type: string
          description: The name of the workspace.
        workspaceDescription:
          type: string
          description: The description of the workspace.
        workspaceStatus:
          $ref: '#/components/schemas/WorkspaceStatus'
        encryptionConfiguration:
          $ref: '#/components/schemas/WorkspaceEncryptionConfigurationInfo'
        createdAt:
          type: string
          format: date-time
          description: The date the workspace was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The date the workspace was last updated, in Unix epoch time.
      required:
      - workspaceArn
      - workspaceName
      - workspaceStatus
      - createdAt
      - updatedAt
    ListWorkspacesRequest:
      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. Default: 50.'
    UpdateWorkspaceResponse:
      type: object
      properties:
        workspaceStatus:
          $ref: '#/components/schemas/WorkspaceStatus'
      required:
      - workspaceStatus
    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
    WorkspaceSummary:
      type: object
      properties:
        name:
          type: string
          description: The name of the workspace.
        arn:
          type: string
          description: The ARN of the workspace.
        status:
          $ref: '#/components/schemas/WorkspaceStatus'
        createdAt:
          type: string
          format: date-time
          description: The date the workspace was created, in Unix epoch time.
        updatedAt:
          type: string
          format: date-time
          description: The date the workspace was last updated, in Unix epoch time.
      required:
      - name
      - arn
      - status
      - createdAt
      - updatedAt
    CreateWorkspaceResponse:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
        workspaceArn:
          type: string
          description: The ARN of the workspace.
        workspaceStatus:
          $ref: '#/components/schemas/WorkspaceStatus'
      required:
      - workspaceName
      - workspaceArn
      - workspaceStatus
    AccessDeniedException:
      type: object
      properties:
        message:
          type: string
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListWorkspacesResponse:
      type: object
      properties:
        workspaceSummaries:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceSummary'
          description: A list that summarizes each workspace.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - workspaceSummaries
    DeleteWorkspaceResponse:
      type: object
      properties:
        workspaceStatus:
          $ref: '#/components/schemas/WorkspaceStatus'
      required:
      - workspaceStatus
    DeleteWorkspaceRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace to delete.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
      required:
      - workspaceName
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    WorkspaceStatus:
      type: object
      properties:
        state:
          type: string
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - FAILED
          description: The current state of the workspace.
        error:
          $ref: '#/components/schemas/WorkspaceErrorDetails'
      required:
      - state
    WorkspaceEncryptionConfiguration:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - SITEWISE_DEFAULT_ENCRYPTION
          - KMS_BASED_ENCRYPTION
          description: The encryption scheme for the workspace. SITEWISE_DEFAULT_ENCRYPTION encrypts data with the IoT SiteWise default key. KMS_BASED_ENCRYPTION encrypts data with the customer managed KMS key identified by kmsKeyId.
        kmsKeyId:
          type: string
          description: The customer managed KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. After a workspace's customer managed key configuration becomes active, the key can't be changed.
      required:
      - encryptionType
    WorkspaceEncryptionConfigurationInfo:
      type: object
      properties:
        encryptionType:
          type: string
          enum:
          - SITEWISE_DEFAULT_ENCRYPTION
          - KMS_BASED_ENCRYPTION
          description: The type of encryption used for the workspace.
        kmsKeyArn:
          type: string
          description: The key ARN of the KMS key used for KMS encryption if encryptionType is KMS_BASED_ENCRYPTION.
      required:
      - encryptionType
    DescribeWorkspaceRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace.
      required:
      - workspaceName
    CreateWorkspaceRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace to create.
        workspaceDescription:
          type: string
          description: A description for the workspace.
        encryptionConfiguration:
          $ref: '#/components/schemas/WorkspaceEncryptionConfiguration'
        tags:
          type: object
          additionalProperties:
            type: string
          description: A list of key-value pairs that contain metadata for the workspace. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
      required:
      - workspaceName
      - encryptionConfiguration
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateWorkspaceRequest:
      type: object
      properties:
        workspaceName:
          type: string
          description: The name of the workspace to update.
        workspaceDescription:
          type: string
          description: A new description for the workspace.
        encryptionConfiguration:
          $ref: '#/components/schemas/WorkspaceEncryptionConfiguration'
        clientToken:
          type: string
          description: A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.
      required:
      - workspaceName
    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)