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

******************
describe_dashboard
******************



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

  

  Retrieves information about a dashboard.

  

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


  **Request Syntax**
  ::

    response = client.describe_dashboard(
        dashboardId='string'
    )
    
  :type dashboardId: string
  :param dashboardId: **[REQUIRED]** 

    The ID of the dashboard.

    

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

    
    ::

      {
          'dashboardId': 'string',
          'dashboardArn': 'string',
          'dashboardName': 'string',
          'projectId': 'string',
          'dashboardDescription': 'string',
          'dashboardDefinition': 'string',
          'dashboardCreationDate': datetime(2015, 1, 1),
          'dashboardLastUpdateDate': datetime(2015, 1, 1)
      }
      
    **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}``

        
      

      - **dashboardName** *(string) --* 

        The name of the dashboard.

        
      

      - **projectId** *(string) --* 

        The ID of the project that the dashboard is in.

        
      

      - **dashboardDescription** *(string) --* 

        The dashboard's description.

        
      

      - **dashboardDefinition** *(string) --* 

        The dashboard's definition JSON literal. For detailed information, see `Creating dashboards (CLI) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html>`__ in the *IoT SiteWise User Guide*.

        
      

      - **dashboardCreationDate** *(datetime) --* 

        The date the dashboard was created, in Unix epoch time.

        
      

      - **dashboardLastUpdateDate** *(datetime) --* 

        The date the dashboard was last updated, in Unix epoch time.

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

  