The Dashboards API from Amazon IoT SiteWise — 2 operation(s) for dashboards.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-iot-sitewise-dashboards-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
version: '2019-12-02'
x-release: v4
title: AWS IoT SiteWise Dashboards API
description: Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about IoT SiteWise quotas, see Quotas in the IoT SiteWise User Guide.
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: iotsitewise
x-aws-signingName: iotsitewise
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/iotsitewise-2019-12-02.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://iotsitewise.{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 SiteWise multi-region endpoint
- url: https://iotsitewise.{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 SiteWise multi-region endpoint
- url: http://iotsitewise.{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 SiteWise endpoint for China (Beijing) and China (Ningxia)
- url: https://iotsitewise.{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 SiteWise endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Dashboards
paths:
/dashboards:
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: CreateDashboard
description: Creates a dashboard in an IoT SiteWise Monitor project.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDashboardResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
parameters: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- projectId
- dashboardName
- dashboardDefinition
properties:
projectId:
description: The ID of the project in which to create the dashboard.
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
dashboardName:
description: A friendly name for the dashboard.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
dashboardDescription:
description: A description for the dashboard.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
dashboardDefinition:
description: The dashboard definition specified in a JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.
type: string
pattern: .+
minLength: 0
maxLength: 204800
clientToken:
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.
type: string
pattern: \S{36,64}
minLength: 36
maxLength: 64
tags:
description: A list of key-value pairs that contain metadata for the dashboard. For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html">Tagging your IoT SiteWise resources</a> in the <i>IoT SiteWise User Guide</i>.
type: object
minProperties: 1
maxProperties: 50
additionalProperties:
$ref: '#/components/schemas/TagValue'
summary: Amazon IoT SiteWise Create Dashboard
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Dashboards
/dashboards/{dashboardId}:
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'
delete:
operationId: DeleteDashboard
description: Deletes a dashboard from IoT SiteWise Monitor.
responses:
'204':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteDashboardResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: dashboardId
in: path
required: true
description: The ID of the dashboard to delete.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
- name: clientToken
in: query
required: false
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.
schema:
type: string
pattern: \S{36,64}
minLength: 36
maxLength: 64
summary: Amazon IoT SiteWise Delete Dashboard
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Dashboards
get:
operationId: DescribeDashboard
description: Retrieves information about a dashboard.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeDashboardResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: dashboardId
in: path
required: true
description: The ID of the dashboard.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
summary: Amazon IoT SiteWise Describe Dashboard
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Dashboards
put:
operationId: UpdateDashboard
description: Updates an IoT SiteWise Monitor dashboard.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateDashboardResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
parameters:
- name: dashboardId
in: path
required: true
description: The ID of the dashboard to update.
schema:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- dashboardName
- dashboardDefinition
properties:
dashboardName:
description: A new friendly name for the dashboard.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
dashboardDescription:
description: A new description for the dashboard.
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
dashboardDefinition:
description: The new dashboard definition, as specified in a JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.
type: string
pattern: .+
minLength: 0
maxLength: 204800
clientToken:
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.
type: string
pattern: \S{36,64}
minLength: 36
maxLength: 64
summary: Amazon IoT SiteWise Update Dashboard
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- Dashboards
components:
parameters:
X-Amz-Signature:
name: X-Amz-Signature
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-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-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
schemas:
Description:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 2048
ID:
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
minLength: 36
maxLength: 36
DashboardDefinition:
type: string
pattern: .+
minLength: 0
maxLength: 204800
InvalidRequestException: {}
DeleteDashboardResponse:
type: object
properties: {}
InternalFailureException: {}
LimitExceededException: {}
Name:
type: string
pattern: '[^\u0000-\u001F\u007F]+'
minLength: 1
maxLength: 256
TagValue:
type: string
minLength: 0
maxLength: 256
Timestamp:
type: string
format: date-time
ThrottlingException: {}
ResourceNotFoundException: {}
CreateDashboardResponse:
type: object
required:
- dashboardId
- dashboardArn
properties:
dashboardId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the dashboard.
dashboardArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
DescribeDashboardResponse:
type: object
required:
- dashboardId
- dashboardArn
- dashboardName
- projectId
- dashboardDefinition
- dashboardCreationDate
- dashboardLastUpdateDate
properties:
dashboardId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the dashboard.
dashboardArn:
allOf:
- $ref: '#/components/schemas/ARN'
- description: <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p> <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
dashboardName:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the dashboard.
projectId:
allOf:
- $ref: '#/components/schemas/ID'
- description: The ID of the project that the dashboard is in.
dashboardDescription:
allOf:
- $ref: '#/components/schemas/Description'
- description: The dashboard's description.
dashboardDefinition:
allOf:
- $ref: '#/components/schemas/DashboardDefinition'
- description: The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.
dashboardCreationDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the dashboard was created, in Unix epoch time.
dashboardLastUpdateDate:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The date the dashboard was last updated, in Unix epoch time.
ARN:
type: string
pattern: .*
minLength: 1
maxLength: 1600
UpdateDashboardResponse:
type: object
properties: {}
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/iotsitewise/
x-hasEquivalentPaths: true