:doc:`CloudWatch <../../cloudwatch>` / Client / get_dashboard

*************
get_dashboard
*************



.. py:method:: CloudWatch.Client.get_dashboard(**kwargs)

  

  Displays the details of the dashboard that you specify.

   

  To copy an existing dashboard, use ``GetDashboard``, and then use the data returned within ``DashboardBody`` as the template for the new dashboard when you call ``PutDashboard`` to create the copy.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/GetDashboard>`_  


  **Request Syntax**
  ::

    response = client.get_dashboard(
        DashboardName='string'
    )
    
  :type DashboardName: string
  :param DashboardName: **[REQUIRED]** 

    The name of the dashboard to be described.

    

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

    
    ::

      {
          'DashboardArn': 'string',
          'DashboardBody': 'string',
          'DashboardName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **DashboardArn** *(string) --* 

        The Amazon Resource Name (ARN) of the dashboard.

        
      

      - **DashboardBody** *(string) --* 

        The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the ``DashboardBody`` syntax, see `Dashboard Body Structure and Syntax <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html>`__.

        
      

      - **DashboardName** *(string) --* 

        The name of the dashboard.

        
  
  **Exceptions**
  
  *   :py:class:`CloudWatch.Client.exceptions.InvalidParameterValueException`

  
  *   :py:class:`CloudWatch.Client.exceptions.DashboardNotFoundError`

  
  *   :py:class:`CloudWatch.Client.exceptions.InternalServiceFault`

  