awswrangler.quicksight.cancel_ingestion

awswrangler.quicksight.cancel_ingestion(ingestion_id: str, dataset_name: Optional[str] = None, dataset_id: Optional[str] = None, account_id: Optional[str] = None, boto3_session: Optional[boto3.session.Session] = None)None

Cancel an ongoing ingestion of data into SPICE.

Note

You must pass a not None value for dataset_name or dataset_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

None.

Return type

None

Examples

>>> import awswrangler as wr
>>>  wr.quicksight.cancel_ingestion(ingestion_id="...", dataset_name="...")