Skip to content

UpdateDashboardRequest

Source code in docs_src/capo_iotsitewise/types/update_dashboard_request.py
class UpdateDashboardRequest(TypedDict, closed=True):
    dashboard_id: "capo_iotsitewise.types.id.ID"
    """<p>The ID of the dashboard to update.</p>"""
    dashboard_name: "capo_iotsitewise.types.name.Name"
    """<p>A new friendly name for the dashboard.</p>"""
    dashboard_description: NotRequired["capo_iotsitewise.types.description.Description"]
    """<p>A new description for the dashboard.</p>"""
    dashboard_definition: (
        "capo_iotsitewise.types.dashboard_definition.DashboardDefinition"
    )
    """<p>The new dashboard definition, as specified in a JSON literal.</p> <ul> <li> <p>IoT SiteWise Monitor (Classic) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Create dashboards (CLI)</a> </p> </li> <li> <p>IoT SiteWise Monitor (AI-aware) see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html">Create dashboards (CLI)</a> </p> </li> </ul> <p>in the <i>IoT SiteWise User Guide</i> </p>"""
    client_token: NotRequired["capo_iotsitewise.types.client_token.ClientToken"]
    """<p>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.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

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.

dashboard_definition instance-attribute

dashboard_definition: DashboardDefinition

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

in the IoT SiteWise User Guide

dashboard_description instance-attribute

dashboard_description: NotRequired[Description]

A new description for the dashboard.

dashboard_id instance-attribute

dashboard_id: ID

The ID of the dashboard to update.

dashboard_name instance-attribute

dashboard_name: Name

A new friendly name for the dashboard.