class Aws::Kendra::Types::CreateFaqRequest

@note When making an API call, you may pass CreateFaqRequest

data as a 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",
    }

@!attribute [rw] index_id

The identifier of the index that contains the FAQ.
@return [String]

@!attribute [rw] name

The name that should be associated with the FAQ.
@return [String]

@!attribute [rw] description

A description of the FAQ.
@return [String]

@!attribute [rw] s3_path

The S3 location of the FAQ input data.
@return [Types::S3Path]

@!attribute [rw] role_arn

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

[1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
@return [String]

@!attribute [rw] tags

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.
@return [Array<Types::Tag>]

@!attribute [rw] file_format

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

[1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
@return [String]

@!attribute [rw] client_token

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.

**A suitable default value is auto-generated.** You should normally
not need to pass this option.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation

Constants

SENSITIVE