Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

Creates a dashboard in an IoT SiteWise Monitor project.

post/dashboards

Request body

projectIdstring required

The ID of the project in which to create the dashboard.

dashboardNamestring required

A friendly name for the dashboard.

dashboardDescriptionstring

A description for the dashboard.

dashboardDefinitionstring required

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

clientTokenstring

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.

tagsobject

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

Response

Success

dashboardIdstring required

The ID of the dashboard.

dashboardArnstring required
<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>