Skip to content

batch_delete_document

Operation

batch_delete_document

batch_delete_document(request: BatchDeleteDocumentInput | BatchDeleteDocumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchDeleteDocumentInputDict]) -> 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
request BatchDeleteDocumentInput | BatchDeleteDocumentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[BatchDeleteDocumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchDeleteDocumentOutput

An instance of BatchDeleteDocumentOutput.

batch_delete_document async

batch_delete_document(request: BatchDeleteDocumentInput | BatchDeleteDocumentInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[BatchDeleteDocumentInputDict]) -> 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
request BatchDeleteDocumentInput | BatchDeleteDocumentInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[BatchDeleteDocumentInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
BatchDeleteDocumentOutput

An instance of BatchDeleteDocumentOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

BatchDeleteDocumentInputDict

Bases: TypedDict

Dictionary form of BatchDeleteDocumentInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the Amazon Q Business application.

data_source_sync_id instance-attribute
data_source_sync_id: str | None

The identifier of the data source sync during which the documents were deleted.

documents instance-attribute

Documents deleted from the Amazon Q Business index.

index_id instance-attribute
index_id: Required[str]

The identifier of the Amazon Q Business index that contains the documents to delete.

BatchDeleteDocumentInput dataclass

Bases: _SerdeShape

Dataclass for BatchDeleteDocumentInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

The identifier of the Amazon Q Business application.

data_source_sync_id class-attribute instance-attribute
data_source_sync_id: str | None = ...

The identifier of the data source sync during which the documents were deleted.

documents class-attribute instance-attribute
documents: list[DeleteDocument] | None = ...

Documents deleted from the Amazon Q Business index.

index_id class-attribute instance-attribute
index_id: str | None = ...

The identifier of the Amazon Q Business index that contains the documents to delete.

Output

BatchDeleteDocumentOutput dataclass

Bases: _SerdeShape

Dataclass for BatchDeleteDocumentOutput structure.

Attributes

failed_documents class-attribute instance-attribute
failed_documents: list[FailedDocument] | 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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.