batch_delete_document¶
Operation¶
async
¶
batch_delete_document(input: BatchDeleteDocumentInput, plugins: list[Plugin] | None = None) -> BatchDeleteDocumentOutput
Asynchronously deletes one or more documents added using the
BatchPutDocument API from an Amazon Q Business index.
You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BatchDeleteDocumentInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
BatchDeleteDocumentOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for BatchDeleteDocumentInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application.
class-attribute
instance-attribute
¶
data_source_sync_id: str | None = None
The identifier of the data source sync during which the documents were deleted.
class-attribute
instance-attribute
¶
documents: list[DeleteDocument] | None = None
Documents deleted from the Amazon Q Business index.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the Amazon Q Business index that contains the documents to delete.
Output¶
dataclass
¶
Dataclass for BatchDeleteDocumentOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
failed_documents: list[FailedDocument] | None = None
A list of documents that couldn't be removed from the Amazon Q Business index. Each entry contains an error message that indicates why the document couldn't be removed from the index.