:doc:`IoTSiteWise <../../iotsitewise>` / Client / update_dashboard

****************
update_dashboard
****************



.. py:method:: IoTSiteWise.Client.update_dashboard(**kwargs)

  

  Updates an IoT SiteWise Monitor dashboard.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/UpdateDashboard>`_  


  **Request Syntax**
  ::

    response = client.update_dashboard(
        dashboardId='string',
        dashboardName='string',
        dashboardDescription='string',
        dashboardDefinition='string',
        clientToken='string'
    )
    
  :type dashboardId: string
  :param dashboardId: **[REQUIRED]** 

    The ID of the dashboard to update.

    

  
  :type dashboardName: string
  :param dashboardName: **[REQUIRED]** 

    A new friendly name for the dashboard.

    

  
  :type dashboardDescription: string
  :param dashboardDescription: 

    A new description for the dashboard.

    

  
  :type dashboardDefinition: string
  :param dashboardDefinition: **[REQUIRED]** 

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

     

    
    * IoT SiteWise Monitor (Classic) see `Create dashboards (CLI) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html>`__
     
    * IoT SiteWise Monitor (AI-aware) see `Create dashboards (CLI) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-ai-dashboard-cli.html>`__
    

     

    in the *IoT SiteWise User Guide*

    

  
  :type clientToken: string
  :param 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.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`IoTSiteWise.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTSiteWise.Client.exceptions.ThrottlingException`

  