dashboards

Creates, updates, deletes, gets or lists a dashboards resource.

Overview

Name	dashboards
Type	Resource
Id	aws.iotsitewise.dashboards

Fields

The following fields are returned by SELECT queries:

list_dashboards

Name	Datatype	Description
id	string	The ID of the dashboard. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
name	string	The name of the dashboard (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
creation_date	string (date-time)	The date the dashboard was created, in Unix epoch time.
description	string	The dashboard's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
last_update_date	string (date-time)	The date the dashboard was last updated, in Unix epoch time.

describe_dashboard

Name	Datatype	Description
dashboard_arn	string	The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:/_.]+$</code>)
dashboard_creation_date	string (date-time)	The date the dashboard was created, in Unix epoch time.
dashboard_definition	string	The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide. (pattern: <code>.+</code>)
dashboard_description	string	The dashboard's description. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
dashboard_id	string	The ID of the dashboard. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)
dashboard_last_update_date	string (date-time)	The date the dashboard was last updated, in Unix epoch time.
dashboard_name	string	The name of the dashboard. (pattern: <code>[^\u0000-\u001F\u007F]+</code>)
project_id	string	The ID of the project that the dashboard is in. (pattern: <code>^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_dashboards	select	projectId, region	nextToken, maxResults	Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
describe_dashboard	select	dashboard_id, region		Retrieves information about a dashboard.
create_dashboard	insert	region, projectId, dashboardName, dashboardDefinition		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 dashboard in an IoT SiteWise Monitor project.
update_dashboard	update	dashboard_id, region, dashboardName, dashboardDefinition		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 dashboard.
delete_dashboard	delete	dashboard_id, region	clientToken	Deletes a dashboard from IoT SiteWise Monitor.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dashboard_id	string	The ID of the dashboard to delete.
projectId	string	The ID of the project.
region	string	AWS region (default: us-east-1)
clientToken	string	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.
maxResults	integer	The maximum number of results to return for each paginated request. Default: 50
nextToken	string	The token to be used for the next set of paginated results.

SELECT examples

list_dashboards

Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.

SELECT
id,
name,
creation_date,
description,
last_update_date
FROM aws.iotsitewise.dashboards
WHERE projectId = '{{ projectId }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

describe_dashboard

Retrieves information about a dashboard.

SELECT
dashboard_arn,
dashboard_creation_date,
dashboard_definition,
dashboard_description,
dashboard_id,
dashboard_last_update_date,
dashboard_name,
project_id
FROM aws.iotsitewise.dashboards
WHERE dashboard_id = '{{ dashboard_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_dashboard

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 dashboard in an IoT SiteWise Monitor project.

INSERT INTO aws.iotsitewise.dashboards (
projectId,
dashboardName,
dashboardDescription,
dashboardDefinition,
clientToken,
tags,
region
)
SELECT 
'{{ projectId }}' /* required */,
'{{ dashboardName }}' /* required */,
'{{ dashboardDescription }}',
'{{ dashboardDefinition }}' /* required */,
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
dashboard_arn,
dashboard_id
;

Manifest

# Description fields are for documentation purposes
- name: dashboards
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dashboards resource.
  - name: projectId
    value: "{{ projectId }}"
  - name: dashboardName
    value: "{{ dashboardName }}"
  - name: dashboardDescription
    value: "{{ dashboardDescription }}"
  - name: dashboardDefinition
    value: "{{ dashboardDefinition }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_dashboard

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

UPDATE aws.iotsitewise.dashboards
SET 
dashboardName = '{{ dashboardName }}',
dashboardDescription = '{{ dashboardDescription }}',
dashboardDefinition = '{{ dashboardDefinition }}',
clientToken = '{{ clientToken }}'
WHERE 
dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
AND dashboardName = '{{ dashboardName }}' --required
AND dashboardDefinition = '{{ dashboardDefinition }}' --required;

DELETE examples

delete_dashboard

Deletes a dashboard from IoT SiteWise Monitor.

DELETE FROM aws.iotsitewise.dashboards
WHERE dashboard_id = '{{ dashboard_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;