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

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

Overview

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
        },
      ],
      content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#documentsArray<Types::Document>

One or more documents to add to the index.

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]: docs.aws.amazon.com/kendra/latest/dg/quotas.html

Returns:


645
646
647
648
649
650
651
# File 'lib/aws-sdk-kendra/types.rb', line 645

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

#index_idString

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

Returns:

  • (String)

645
646
647
648
649
650
651
# File 'lib/aws-sdk-kendra/types.rb', line 645

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

#role_arnString

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]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html

Returns:

  • (String)

645
646
647
648
649
650
651
# File 'lib/aws-sdk-kendra/types.rb', line 645

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