kendra / Client / batch_delete_document

batch_delete_document#

kendra.Client.batch_delete_document(**kwargs)#

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument API.

The documents are deleted asynchronously. You can see the progress of the deletion by using Amazon Web Services CloudWatch. Any error messages related to the processing of the batch are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus API to monitor the progress of deleting your documents.

Deleting documents from an index using BatchDeleteDocument could take up to an hour or more, depending on the number of documents you want to delete.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_document(
    IndexId='string',
    DocumentIdList=[
        'string',
    ],
    DataSourceSyncJobMetricTarget={
        'DataSourceId': 'string',
        'DataSourceSyncJobId': 'string'
    }
)
Parameters:

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index that contains the documents to delete.

  • DocumentIdList (list) –

    [REQUIRED]

    One or more identifiers for documents to delete from the index.

    • (string) –

  • DataSourceSyncJobMetricTarget (dict) –

    Maps a particular data source sync job to a particular data source.

    • DataSourceId (string) – [REQUIRED]

      The ID of the data source that is running the sync job.

    • DataSourceSyncJobId (string) –

      The ID of the sync job that is running on the data source.

      If the ID of a sync job is not provided and there is a sync job running, then the ID of this sync job is used and metrics are generated for this sync job.

      If the ID of a sync job is not provided and there is no sync job running, then no metrics are generated and documents are indexed/deleted at the index level without sync job metrics included.

Return type:

dict

Returns:

Response Syntax

{
    'FailedDocuments': [
        {
            'Id': 'string',
            'ErrorCode': 'InternalError'|'InvalidRequest',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • FailedDocuments (list) –

      A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn’t be removed from the index.

      • (dict) –

        Provides information about documents that could not be removed from an index by the BatchDeleteDocument API.

        • Id (string) –

          The identifier of the document that couldn’t be removed from the index.

        • ErrorCode (string) –

          The error code for why the document couldn’t be removed from the index.

        • ErrorMessage (string) –

          An explanation for why the document couldn’t be removed from the index.

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ConflictException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.InternalServerException