awswrangler.quicksight.describe_dataset

awswrangler.quicksight.describe_dataset(name: Optional[str] = None, dataset_id: Optional[str] = None, account_id: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = 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, optional) – Dataset name.

  • dataset_id (str, optional) – Dataset 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

Dataset Description.

Return type

Dict[str, Any]

Examples

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