IoTSiteWise / Client / update_dashboard

update_dashboard

IoTSiteWise.Client.update_dashboard(**kwargs)

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.update_dashboard(
    dashboardId='string',
    dashboardName='string',
    dashboardDescription='string',
    dashboardDefinition='string',
    clientToken='string'
)
Parameters:

  • dashboardId (string) –

    [REQUIRED]

    The ID of the dashboard to update.

  • dashboardName (string) –

    [REQUIRED]

    A new friendly name for the dashboard.

  • dashboardDescription (string) – A new description for the dashboard.

  • dashboardDefinition (string) –

    [REQUIRED]

    The new dashboard definition, as specified in a JSON literal.

    in the IoT SiteWise User Guide

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions