Class: Aws::Kendra::Types::FaqSummary

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::FaqSummary

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Summary information for frequently asked questions and answers included in an index.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The Unix timestamp when the FAQ was created.

• #file_format ⇒ String

  The file type used to create the FAQ.

• #id ⇒ String

  The identifier of the FAQ.

• #language_code ⇒ String

  The code for a language.

• #name ⇒ String

  The name that you assigned the FAQ when you created or updated the FAQ.

• #status ⇒ String

  The current status of the FAQ.

• #updated_at ⇒ Time

  The Unix timestamp when the FAQ was last updated.

Instance Attribute Details

#created_at ⇒ Time

The Unix timestamp when the FAQ was created.

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#file_format ⇒ String

The file type used to create the FAQ.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The identifier of the FAQ.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

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

[1]: docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name that you assigned the FAQ when you created or updated the FAQ.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the FAQ. When the status is ‘ACTIVE` the FAQ is ready for use.

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The Unix timestamp when the FAQ was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-kendra/types.rb', line 5273

class FaqSummary < Struct.new(
  :id,
  :name,
  :status,
  :created_at,
  :updated_at,
  :file_format,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end