awswrangler.quicksight.delete_dashboard

awswrangler.quicksight.delete_dashboard(name: Optional[str] = None, dashboard_id: Optional[str] = None, version_number: Optional[int] = None, account_id: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None) None

Delete a dashboard.

Note

You must pass a not None name or dashboard_id argument.

Parameters
  • name (str, optional) – Dashboard name.

  • dashboard_id (str, optional) – The ID for the dashboard.

  • version_number (int, optional) – The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.

  • 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

None.

Return type

None

Examples

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