You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#created_at ⇒ Time

The date and time that the FAQ was created.

Returns:

  • (Time) —

    The date and time that the FAQ was created.

#description ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

Possible values:

  • CSV
  • CSV_WITH_HEADER
  • JSON

Returns:

  • (String) —

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

#id ⇒ String

The identifier of the FAQ.

Returns:

  • (String) —

    The identifier of the FAQ.

#index_id ⇒ String

The identifier of the index that contains the FAQ.

Returns:

  • (String) —

    The identifier of the index that contains the FAQ.

#name ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Types::S3Path) —

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

    .

#status ⇒ String

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

Possible values:

  • CREATING
  • UPDATING
  • ACTIVE
  • DELETING
  • FAILED

Returns:

  • (String) —

    The status of the FAQ.

#updated_at ⇒ Time

The date and time that the FAQ was last updated.

Returns:

  • (Time) —

    The date and time that the FAQ was last updated.