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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DescribeFaqResponse

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The Unix timestamp when the FAQ was created.

• #description ⇒ String

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

• #error_message ⇒ String

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

• #file_format ⇒ String

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

• #id ⇒ String

  The identifier of the FAQ.

• #index_id ⇒ String

  The identifier of the index for the FAQ.

• #language_code ⇒ String

  The code for a language.

• #name ⇒ String

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

• #role_arn ⇒ String

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

• #s3_path ⇒ Types::S3Path

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

• #status ⇒ String

  The 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 3640

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

#description ⇒ String

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

Returns:

• (String)

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

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_message ⇒ String

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

Returns:

• (String)

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

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_format ⇒ String

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

Returns:

• (String)

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

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

#id ⇒ String

The identifier of the FAQ.

Returns:

• (String)

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

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_id ⇒ String

The identifier of the index for the FAQ.

Returns:

• (String)

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

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_code ⇒ String

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].

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

Returns:

• (String)

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

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

#name ⇒ String

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

Returns:

• (String)

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

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_arn ⇒ String

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

Returns:

• (String)

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

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_path ⇒ Types::S3Path

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

Returns:

• (Types::S3Path)

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

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

#status ⇒ String

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

Returns:

• (String)

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

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_at ⇒ Time

The Unix timestamp when the FAQ was last updated.

Returns:

• (Time)

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

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