awswrangler.quicksight.get_dashboard_id

awswrangler.quicksight.get_dashboard_id(name: str, account_id: Optional[str] = None, boto3_session: Optional[Session] = None) str

Get QuickSight dashboard ID given a name and fails if there is more than 1 ID associated with this name.

Parameters
  • name (str) – Dashboard name.

  • 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 ID.

Return type

str

Examples

>>> import awswrangler as wr
>>> my_id = wr.quicksight.get_dashboard_id(name="...")