QuickSight / Client / describe_dashboard_definition
describe_dashboard_definition#
- 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 instead.
See also: AWS API Documentation
Request Syntax
response = client.describe_dashboard_definition( AwsAccountId='string', DashboardId='string', VersionNumber=123, AliasName='string' )
- Parameters:
AwsAccountId (string) –
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you’re describing.
DashboardId (string) –
[REQUIRED]
The ID for the dashboard.
VersionNumber (integer) – The version number for the dashboard. If a version number isn’t passed, the latest published dashboard version is described.
AliasName (string) – The alias name.
- Return type:
dict
- Returns:
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
Exceptions
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.ResourceExistsException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.ConflictException
QuickSight.Client.exceptions.UnsupportedUserEditionException
QuickSight.Client.exceptions.InternalFailureException