:doc:`QuickSight <../../quicksight>` / Client / describe_dashboard_definition

*****************************
describe_dashboard_definition
*****************************



.. py:method:: QuickSight.Client.describe_dashboard_definition(**kwargs)

  

  Provides a detailed description of the definition of a dashboard.

   

  .. note::

    

    If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the `DescribeDashboard <https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html>`__ instead.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardDefinition>`_  


  **Request Syntax**
  ::

    response = client.describe_dashboard_definition(
        AwsAccountId='string',
        DashboardId='string',
        VersionNumber=123,
        AliasName='string'
    )
    
  :type AwsAccountId: string
  :param AwsAccountId: **[REQUIRED]** 

    The ID of the Amazon Web Services account that contains the dashboard that you're describing.

    

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

    The ID for the dashboard.

    

  
  :type VersionNumber: integer
  :param VersionNumber: 

    The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.

    

  
  :type AliasName: string
  :param AliasName: 

    The alias name.

    

  
  
  :rtype: dict
  :returns: 
    

    **Response Syntax**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardDefinition>`_


    

    **Response Structure**
    ::

        # This section is too large to render.
        # Please see the AWS API Documentation linked below.

    `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/quicksight-2018-04-01/DescribeDashboardDefinition>`_


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

  
  *   :py:class:`QuickSight.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QuickSight.Client.exceptions.ResourceExistsException`

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

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

  
  *   :py:class:`QuickSight.Client.exceptions.ConflictException`

  
  *   :py:class:`QuickSight.Client.exceptions.UnsupportedUserEditionException`

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

  