AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Adds one or more documents to an index.
The BatchPutDocument API enables you to ingest inline documents or a set of
documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured
text into an index, add custom attributes to the documents, and to attach an access
control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using
Amazon Web Services CloudWatch. Any error messages related to processing the batch
are sent to your Amazon Web Services CloudWatch log. You can also use the BatchGetDocumentStatus
API to monitor the progress of indexing your documents.
For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.
For .NET Core this operation is only available in asynchronous form. Please refer to BatchPutDocumentAsync.
Namespace: Amazon.Kendra
Assembly: AWSSDK.Kendra.dll
Version: 3.x.y.z
public virtual BatchPutDocumentResponse BatchPutDocument( BatchPutDocumentRequest request )
Container for the necessary parameters to execute the BatchPutDocument service method.
| Exception | Condition |
|---|---|
| AccessDeniedException | You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again. |
| ConflictException | A conflict occurred with the request. Please fix any inconsistences with your resources and try again. |
| InternalServerException | An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help. |
| ResourceNotFoundException | The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again. |
| ServiceQuotaExceededException | You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits. |
| ThrottlingException | The request was denied due to request throttling. Please reduce the number of requests and try again. |
| ValidationException | The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again. |
.NET Framework:
Supported in: 4.5 and newer, 3.5