awswrangler.quicksight.describe_dashboard

awswrangler.quicksight.describe_dashboard(name: str | None = None, dashboard_id: str | None = None, account_id: str | None = None, boto3_session: Session | None = None) → dict[str, Any]

Describe a QuickSight dashboard by name or ID.

Note

You must pass a not None name or dashboard_id argument.

Parameters:

  • name (str | None) – Dashboard name.

  • dashboard_id (str | None) – Dashboard ID.

  • account_id (str | None) – If None, the account ID will be inferred from your boto3 session.

  • boto3_session (Session | None) – The default boto3 session will be used if boto3_session is None.

Return type:

dict[str, Any]

Returns:

Dashboard Description.

Examples

>>> import awswrangler as wr
>>> description = wr.quicksight.describe_dashboard(name="my-dashboard")