awswrangler.quicksight.describe_dashboard¶
- awswrangler.quicksight.describe_dashboard(name: Optional[str] = None, dashboard_id: Optional[str] = None, account_id: Optional[str] = None, boto3_session: Optional[Session] = None) Dict[str, Any] ¶
Describe a QuickSight dashboard by name or ID.
Note
You must pass a not None
name
ordashboard_id
argument.- Parameters
name (str, optional) – Dashboard name.
dashboard_id (str, optional) – Dashboard ID.
account_id (str, optional) – If None, the account ID will be inferred from your boto3 session.
boto3_session (boto3.Session(), optional) – Boto3 Session. The default boto3 session will be used if boto3_session receive None.
- Returns
Dashboad Description.
- Return type
Dict[str, Any]
Examples
>>> import awswrangler as wr >>> description = wr.quicksight.describe_dashboard(name="my-dashboard")