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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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].

[1]: docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html

Returns:



918
919
920
921
922
923
924
925
 
# File 'lib/aws-sdk-kendra/types.rb', line 918

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].

[1]: docs.aws.amazon.com/kendra/latest/dg/quotas.html

Returns:



918
919
920
921
922
923
924
925
 
# File 'lib/aws-sdk-kendra/types.rb', line 918

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) 


918
919
920
921
922
923
924
925
 
# File 'lib/aws-sdk-kendra/types.rb', line 918

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].

[1]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html

Returns:

  • (String) 


918
919
920
921
922
923
924
925
 
# File 'lib/aws-sdk-kendra/types.rb', line 918

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