Class: Aws::Kendra::Types::DescribeThesaurusResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

The Unix datetime that the thesaurus was created.

Returns:

  • (Time)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The thesaurus description.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

When the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#file_size_bytesInteger

The size of the thesaurus file in bytes.

Returns:

  • (Integer)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the thesaurus.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index associated with the thesaurus to describe.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The thesaurus name.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#source_s3_pathTypes::S3Path

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

Returns:


3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status of the thesaurus. When the value is `ACTIVE`, queries are able to use the thesaurus. If the `Status` field value is `FAILED`, the `ErrorMessage` field provides more information.

If the status is `ACTIVE_BUT_UPDATE_FAILED`, it means that Amazon Kendra could not ingest the new thesaurus file. The old thesaurus file is still active.

Returns:

  • (String)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#synonym_rule_countInteger

The number of synonym rules in the thesaurus file.

Returns:

  • (Integer)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#term_countInteger

The number of unique terms in the thesaurus file. For example, the synonyms `a,b,c` and `a=>d`, the term count would be 4.

Returns:

  • (Integer)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The Unix datetime that the thesaurus was last updated.

Returns:

  • (Time)

3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
# File 'lib/aws-sdk-kendra/types.rb', line 3193

class DescribeThesaurusResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :role_arn,
  :source_s3_path,
  :file_size_bytes,
  :term_count,
  :synonym_rule_count)
  SENSITIVE = []
  include Aws::Structure
end