v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1473397365.8 KB

Retrieves information about a dashboard.

get/dashboards/{dashboardId}

Path parameters

dashboardIdstring required

The ID of the dashboard.

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

The name of the dashboard.

projectIdstring required

The ID of the project that the dashboard is in.

dashboardDescriptionstring

The dashboard's description.

dashboardDefinitionstring required

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

dashboardCreationDatestring date-time required

The date the dashboard was created, in Unix epoch time.

dashboardLastUpdateDatestring date-time required

The date the dashboard was last updated, in Unix epoch time.