Class: Aws::Kendra::Types::BatchPutDocumentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_document_enrichment_configuration ⇒ Types::CustomDocumentEnrichmentConfiguration

Configuration information for altering your document metadata and content during the document ingestion process when you use the BatchPutDocument API.

For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see Customizing document metadata during the ingestion process.

Returns:



905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 905

class BatchPutDocumentRequest < Struct.new(
  :index_id,
  :role_arn,
  :documents,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#documents ⇒ Array<Types::Document>

One or more documents to add to the index.

Documents have the following file size limits.

  • 50 MB total size for any file

  • 5 MB extracted text for any file

For more information, see Quotas.

Returns:



905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 905

class BatchPutDocumentRequest < Struct.new(
  :index_id,
  :role_arn,
  :documents,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#index_id ⇒ String

The identifier of the index to add the documents to. You need to create the index first using the CreateIndex API.

Returns:

  • (String) 


905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 905

class BatchPutDocumentRequest < Struct.new(
  :index_id,
  :role_arn,
  :documents,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see IAM access roles for Amazon Kendra.

Returns:

  • (String) 


905
906
907
908
909
910
911
912
 
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 905

class BatchPutDocumentRequest < Struct.new(
  :index_id,
  :role_arn,
  :documents,
  :custom_document_enrichment_configuration)
  SENSITIVE = []
  include Aws::Structure
end