Class: Aws::Kendra::Types::Document

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 Document data as a hash:

{
  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
}

A document in an index.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_control_listArray<Types::Principal>

Information to use for user context filtering.

Returns:


3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#attributesArray<Types::DocumentAttribute>

Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.

Returns:


3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#blobString

The contents of the document.

Documents passed to the `Blob` parameter must be base64 encoded. Your code might not need to encode the document file bytes if you're using an AWS SDK to call Amazon Kendra operations. If you are calling the Amazon Kendra endpoint directly using REST, you must base64 encode the contents before sending.

Returns:

  • (String)

3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#content_typeString

The file type of the document in the `Blob` field.

Returns:

  • (String)

3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#idString

A unique identifier of the document in the index.

Returns:

  • (String)

3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#s3_pathTypes::S3Path

Information required to find a specific file in an Amazon S3 bucket.

Returns:


3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

The title of the document.

Returns:

  • (String)

3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
# File 'lib/aws-sdk-kendra/types.rb', line 3284

class Document < Struct.new(
  :id,
  :title,
  :blob,
  :s3_path,
  :attributes,
  :access_control_list,
  :content_type)
  SENSITIVE = []
  include Aws::Structure
end