Amazon IoT SiteWise Projects API

The Projects API from Amazon IoT SiteWise — 5 operation(s) for projects.

GitHub OpenAPI

Operations 8

POST /projects Create Project #
GET /projects List Projects #
DELETE /projects/{projectId} Delete Project #
GET /projects/{projectId} Describe Project #
PUT /projects/{projectId} Update Project #
POST /projects/{projectId}/assets/associate Batch Associate Project Assets #
POST /projects/{projectId}/assets/disassociate Batch Disassociate Project Assets #
GET /projects/{projectId}/assets List Project Assets #

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-projects-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-iot-sitewise-projects-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: AWS IoT SiteWise Projects API
  version: '2019-12-02'
  description: Generated from AWS's published Smithy model for AWS IoT SiteWise. 8 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:
  /projects:
    post:
      operationId: CreateProject
      summary: Create Project
      description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If
        you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue
        to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Creates a project
        in the specified portal. Make sure that the project name and description don't contain confidential information.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateProjectResponse'
        '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/CreateProjectRequest'
      tags:
      - Projects
    get:
      operationId: ListProjects
      summary: List Projects
      description: Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProjectsResponse'
        '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/ListProjectsRequest'
      tags:
      - Projects
  /projects/{projectId}:
    delete:
      operationId: DeleteProject
      summary: Delete Project
      description: Deletes a project from IoT SiteWise Monitor.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteProjectResponse'
        '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/DeleteProjectRequest'
      tags:
      - Projects
    get:
      operationId: DescribeProject
      summary: Describe Project
      description: Retrieves information about a project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeProjectResponse'
        '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/DescribeProjectRequest'
      tags:
      - Projects
    put:
      operationId: UpdateProject
      summary: Update Project
      description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If
        you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue
        to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Updates an IoT SiteWise
        Monitor project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateProjectResponse'
        '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/UpdateProjectRequest'
      tags:
      - Projects
  /projects/{projectId}/assets/associate:
    post:
      operationId: BatchAssociateProjectAssets
      summary: Batch Associate Project Assets
      description: The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. If
        you would like to use the IoT SiteWise Monitor feature, sign up prior to that date. Existing customers can continue
        to use the service as normal. For more information, see IoT SiteWise Monitor availability change. Associates a group
        (batch) of assets with an IoT SiteWise Monitor project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchAssociateProjectAssetsResponse'
        '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/BatchAssociateProjectAssetsRequest'
      tags:
      - Projects
  /projects/{projectId}/assets/disassociate:
    post:
      operationId: BatchDisassociateProjectAssets
      summary: Batch Disassociate Project Assets
      description: Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchDisassociateProjectAssetsResponse'
        '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/BatchDisassociateProjectAssetsRequest'
      tags:
      - Projects
  /projects/{projectId}/assets:
    get:
      operationId: ListProjectAssets
      summary: List Project Assets
      description: Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListProjectAssetsResponse'
        '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/ListProjectAssetsRequest'
      tags:
      - Projects
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:
    AssetErrorDetails:
      type: object
      properties:
        assetId:
          type: string
          description: The ID of the asset, in UUID format.
        code:
          type: string
          enum:
          - INTERNAL_FAILURE
          description: The error code.
        message:
          type: string
          description: The error message.
      required:
      - assetId
      - code
      - message
    BatchAssociateProjectAssetsRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project to which to associate the assets.
        assetIds:
          type: array
          items:
            type: string
          description: The IDs of the assets to be associated to the project.
        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:
      - projectId
      - assetIds
    BatchAssociateProjectAssetsResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AssetErrorDetails'
          description: A list of associated error information, if any.
    BatchDisassociateProjectAssetsRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project from which to disassociate the assets.
        assetIds:
          type: array
          items:
            type: string
          description: The IDs of the assets to be disassociated from the project.
        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:
      - projectId
      - assetIds
    BatchDisassociateProjectAssetsResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/AssetErrorDetails'
          description: A list of associated error information, if any.
    CreateProjectRequest:
      type: object
      properties:
        portalId:
          type: string
          description: The ID of the portal in which to create the project.
        projectName:
          type: string
          description: A friendly name for the project.
        projectDescription:
          type: string
          description: A description for the project.
        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 project. For more information, see Tagging
            your IoT SiteWise resources in the IoT SiteWise User Guide.
      required:
      - portalId
      - projectName
    CreateProjectResponse:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project.
        projectArn:
          type: string
          description: The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
      required:
      - projectId
      - projectArn
    DeleteProjectRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project.
        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:
      - projectId
    DeleteProjectResponse:
      type: object
      properties: {}
    DescribeProjectRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project.
      required:
      - projectId
    DescribeProjectResponse:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project.
        projectArn:
          type: string
          description: The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
        projectName:
          type: string
          description: The name of the project.
        portalId:
          type: string
          description: The ID of the portal that the project is in.
        projectDescription:
          type: string
          description: The project's description.
        projectCreationDate:
          type: string
          format: date-time
          description: The date the project was created, in Unix epoch time.
        projectLastUpdateDate:
          type: string
          format: date-time
          description: The date the project was last updated, in Unix epoch time.
      required:
      - projectId
      - projectArn
      - projectName
      - portalId
      - projectCreationDate
      - projectLastUpdateDate
    InternalFailureException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    InvalidRequestException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    LimitExceededException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ListProjectAssetsRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project.
        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'
      required:
      - projectId
    ListProjectAssetsResponse:
      type: object
      properties:
        assetIds:
          type: array
          items:
            type: string
          description: A list that contains the IDs of each asset associated with the project.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - assetIds
    ListProjectsRequest:
      type: object
      properties:
        portalId:
          type: string
          description: The ID of the portal.
        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'
      required:
      - portalId
    ListProjectsResponse:
      type: object
      properties:
        projectSummaries:
          type: array
          items:
            $ref: '#/components/schemas/ProjectSummary'
          description: A list that summarizes each project in the portal.
        nextToken:
          type: string
          description: The token for the next set of results, or null if there are no additional results.
      required:
      - projectSummaries
    ProjectSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID of the project.
        name:
          type: string
          description: The name of the project.
        description:
          type: string
          description: The project's description.
        creationDate:
          type: string
          format: date-time
          description: The date the project was created, in Unix epoch time.
        lastUpdateDate:
          type: string
          format: date-time
          description: The date the project was last updated, in Unix epoch time.
      required:
      - id
      - name
    ResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    ThrottlingException:
      type: object
      properties:
        message:
          type: string
      required:
      - message
    UpdateProjectRequest:
      type: object
      properties:
        projectId:
          type: string
          description: The ID of the project to update.
        projectName:
          type: string
          description: A new friendly name for the project.
        projectDescription:
          type: string
          description: A new description for the project.
        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:
      - projectId
      - projectName
    UpdateProjectResponse:
      type: object
      properties: {}
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)