awswrangler.quicksight.describe_dataset

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

Describe a QuickSight dataset by name or ID.

Note

You must pass a not None name or dataset_id argument.

Parameters:

  • name (str | None) – Dataset name.

  • dataset_id (str | None) – Dataset 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:

Dataset Description.

Examples

>>> import awswrangler as wr
>>> description = wr.quicksight.describe_dataset("my-dataset")