Class: Aws::Kendra::Types::DescribeThesaurusResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::DescribeThesaurusResponse
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#created_at ⇒ Time
The Unix timestamp when the thesaurus was created.
-
#description ⇒ String
The thesaurus description.
-
#error_message ⇒ String
When the
Status
field value isFAILED
, theErrorMessage
field provides more information. -
#file_size_bytes ⇒ Integer
The size of the thesaurus file in bytes.
-
#id ⇒ String
The identifier of the thesaurus.
-
#index_id ⇒ String
The identifier of the index for the thesaurus.
-
#name ⇒ String
The thesaurus name.
-
#role_arn ⇒ String
An IAM role that gives Amazon Kendra permissions to access thesaurus file specified in
SourceS3Path
. -
#source_s3_path ⇒ Types::S3Path
Information required to find a specific file in an Amazon S3 bucket.
-
#status ⇒ String
The current status of the thesaurus.
-
#synonym_rule_count ⇒ Integer
The number of synonym rules in the thesaurus file.
-
#term_count ⇒ Integer
The number of unique terms in the thesaurus file.
-
#updated_at ⇒ Time
The Unix timestamp when the thesaurus was last updated.
Instance Attribute Details
#created_at ⇒ Time
The Unix timestamp when the thesaurus was created.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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 |
#description ⇒ String
The thesaurus description.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_message ⇒ String
When the Status
field value is FAILED
, the ErrorMessage
field
provides more information.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_bytes ⇒ Integer
The size of the thesaurus file in bytes.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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 |
#id ⇒ String
The identifier of the thesaurus.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_id ⇒ String
The identifier of the index for the thesaurus.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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 |
#name ⇒ String
The thesaurus name.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_arn ⇒ String
An IAM role that gives Amazon Kendra permissions to access thesaurus
file specified in SourceS3Path
.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_path ⇒ Types::S3Path
Information required to find a specific file in an Amazon S3 bucket.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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 |
#status ⇒ String
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.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_count ⇒ Integer
The number of synonym rules in the thesaurus file.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_count ⇒ Integer
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.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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_at ⇒ Time
The Unix timestamp when the thesaurus was last updated.
4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 4327 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 |