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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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 for the thesaurus.

Returns:

  • (String)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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 IAM role that gives Amazon Kendra permissions to access thesaurus file specified in SourceS3Path.

Returns:

  • (String)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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:



6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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)


6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 6122

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