awswrangler.quicksight.describe_ingestion¶
- awswrangler.quicksight.describe_ingestion(ingestion_id: str, 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 ingestion by ID.
Note
You must pass a not None value for
dataset_name
ordataset_id
argument.- Parameters:
ingestion_id (str) – Ingestion ID.
dataset_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:
Ingestion Description.
- Return type:
Dict[str, Any]
Examples
>>> import awswrangler as wr >>> description = wr.quicksight.describe_dataset(ingestion_id="...", dataset_name="...")