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

****************
create_dashboard
****************



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

  

  Creates a dashboard in an IoT SiteWise Monitor project.

  

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


  **Request Syntax**
  ::

    response = client.create_dashboard(
        projectId='string',
        dashboardName='string',
        dashboardDescription='string',
        dashboardDefinition='string',
        clientToken='string',
        tags={
            'string': 'string'
        }
    )
    
  :type projectId: string
  :param projectId: **[REQUIRED]** 

    The ID of the project in which to create the dashboard.

    

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

    A friendly name for the dashboard.

    

  
  :type dashboardDescription: string
  :param dashboardDescription: 

    A description for the dashboard.

    

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

    The dashboard definition 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.

  
  :type tags: dict
  :param tags: 

    A list of key-value pairs that contain metadata for the dashboard. For more information, see `Tagging your IoT SiteWise resources <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/tag-resources.html>`__ in the *IoT SiteWise User Guide*.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'dashboardId': 'string',
          'dashboardArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **dashboardId** *(string) --* 

        The ID of the dashboard.

        
      

      - **dashboardArn** *(string) --* 

        The `ARN <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ of the dashboard, which has the following format.

         

        ``arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}``

        
  
  **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`

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

  