aws iotsitewise update-dashboard

The IoT SiteWise Monitor feature will no longer be open to new customers starting November 7, 2025. AWS CLI reference

1 example 5 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To update a dashboard

The following update-dashboard example changes the title of a dashboard's line chart that displays total generated power for a wind farm.

aws iotsitewise update-dashboard --dashboard-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 --dashboard-name "Wind Farm" --dashboard-definition file://update-wind-farm-dashboard.json

Identify

--dashboard-idThe ID of the dashboard to update.

--dashboard-nameA new friendly name for the dashboard.

--dashboard-definitionThe new dashboard definition, as specified in a JSON literal.

Contents of update-wind-farm-dashboard.json:

{
    "widgets": [
        {
            "type": "monitor-line-chart",
            "title": "Total Generated Power",
            "x": 0,
            "y": 0,
            "height": 3,
            "width": 3,
            "metrics": [
                {
                    "label": "Power",
                    "type": "iotsitewise",
                    "assetId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE99999"
                }
            ]
        }
    ]
}

This command produces no output.

For more information, see Creating dashboards (CLI) in the AWS IoT SiteWise User Guide.

Options

5 in the AWS CLI reference

--client-tokenA unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

--dashboard-definitionThe new dashboard definition, as specified in a JSON literal.

--dashboard-descriptionA new description for the dashboard.

--dashboard-idThe ID of the dashboard to update.

--dashboard-nameA new friendly name for the dashboard.