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

Class: Aws::Kendra::Types::CreateFaqRequest

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

Overview

Note:

When passing CreateFaqRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  index_id: "IndexId", # required
  name: "FaqName", # required
  description: "Description",
  s3_path: { # required
    bucket: "S3BucketName", # required
    key: "S3ObjectKey", # required
  },
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
  client_token: "ClientTokenName",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A token that you provide to identify the request to create a FAQ. Multiple calls to the CreateFaqRequest operation with the same client token will create only one FAQ.

Returns:

  • (String) —

    A token that you provide to identify the request to create a FAQ.

#description ⇒ String

A description of the FAQ.

Returns:

  • (String) —

    A description of the FAQ.

#file_format ⇒ String

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

Returns:

  • (String) —

    The format of the input file.

#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 should be associated with the FAQ.

Returns:

  • (String) —

    The name that should be associated with the FAQ.

#role_arn ⇒ String

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs.

#s3_path ⇒ Types::S3Path

The S3 location of the FAQ input data.

Returns:

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify the FAQ. You can use the tags to identify and organize your resources and to control access to resources.

Returns:

  • (Array<Types::Tag>) —

    A list of key-value pairs that identify the FAQ.