Class: Aws::Kendra::Types::DescribeFaqResponse

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 date and time that the FAQ was created.

Returns:

  • (Time)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the FAQ that you provided when it was created.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

If the Status field is FAILED, the ErrorMessage field contains the reason why the FAQ failed.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#file_formatString

The file format used by the input files for the FAQ.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#idString

The identifier of the FAQ.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index for the FAQ.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#language_codeString

The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see Adding documents in languages other than English.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name that you gave the FAQ when it was created.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#s3_pathTypes::S3Path

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

Returns:



3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The status of the FAQ. It is ready to use when the status is ACTIVE.

Returns:

  • (String)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

The date and time that the FAQ was last updated.

Returns:

  • (Time)


3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3179

class DescribeFaqResponse < Struct.new(
  :id,
  :index_id,
  :name,
  :description,
  :created_at,
  :updated_at,
  :s3_path,
  :status,
  :role_arn,
  :error_message,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end