class Aws::Kendra::Types::BatchPutDocumentRequest
@note When making an API call, you may pass BatchPutDocumentRequest
data as a hash: { index_id: "IndexId", # required role_arn: "RoleArn", documents: [ # required { id: "DocumentId", # required title: "Title", blob: "data", s3_path: { bucket: "S3BucketName", # required key: "S3ObjectKey", # required }, attributes: [ { key: "DocumentAttributeKey", # required value: { # required string_value: "DocumentAttributeStringValue", string_list_value: ["String"], long_value: 1, date_value: Time.now, }, }, ], access_control_list: [ { name: "PrincipalName", # required type: "USER", # required, accepts USER, GROUP access: "ALLOW", # required, accepts ALLOW, DENY data_source_id: "DataSourceId", }, ], hierarchical_access_control_list: [ { principal_list: [ # required { name: "PrincipalName", # required type: "USER", # required, accepts USER, GROUP access: "ALLOW", # required, accepts ALLOW, DENY data_source_id: "DataSourceId", }, ], }, ], content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT }, ], }
@!attribute [rw] index_id
The identifier of the index to add the documents to. You need to create the index first using the `CreateIndex` operation. @return [String]
@!attribute [rw] role_arn
The Amazon Resource Name (ARN) of a role that is allowed to run the `BatchPutDocument` operation. For more information, see [IAM Roles for Amazon Kendra][1]. [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html @return [String]
@!attribute [rw] documents
One or more documents to add to the index. Documents can include custom attributes. For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes that provide information on the synchronization of documents running on a data source. Note, 'DataSourceSyncJobId' could be an optional custom attribute as Amazon Kendra will use the ID of a running sync job. Documents have the following file size limits. * 5 MB total size for inline documents * 50 MB total size for files from an S3 bucket * 5 MB extracted text for any file For more information about file size and transaction per second quotas, see [Quotas][1]. [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html @return [Array<Types::Document>]
@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BatchPutDocumentRequest AWS API Documentation
Constants
- SENSITIVE