Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]



Updates an IoT SiteWise Monitor dashboard.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--dashboard-id <value>
--dashboard-name <value>
[--dashboard-description <value>]
--dashboard-definition <value>
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--dashboard-id (string)

The ID of the dashboard to update.

--dashboard-name (string)

A new friendly name for the dashboard.

--dashboard-description (string)

A new description for the dashboard.

--dashboard-definition (string)

The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide .

--client-token (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


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 \
    --project-id a1b2c3d4-5678-90ab-cdef-fffffEXAMPLE \
    --dashboard-name "Wind Farm" \
    --dashboard-definition file://update-wind-farm-dashboard.json

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-44444EXAMPLE",
                    "propertyId": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE"

This command produces no output.

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