IoTSiteWise / Client / update_dashboard

update_dashboard#

IoTSiteWise.Client.update_dashboard(**kwargs)#

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. For detailed information, see Creating dashboards (CLI) 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

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException