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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::CreateFaqRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #description ⇒ String

  A description for the FAQ.

• #file_format ⇒ String

  The format of the FAQ input file.

• #index_id ⇒ String

  The identifier of the index for the FAQ.

• #language_code ⇒ String

  The code for a language.

• #name ⇒ String

  A name for the FAQ.

• #role_arn ⇒ String

  The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file.

• #s3_path ⇒ Types::S3Path

  The path to the FAQ file in S3.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#client_token ⇒ String

A token that you provide to identify the request to create a FAQ. Multiple calls to the ‘CreateFaqRequest` API 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.

Returns:

• (String)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description for the FAQ.

Returns:

• (String)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#file_format ⇒ String

The format of the FAQ 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 default format is CSV.

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]: docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html

Returns:

• (String)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :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 2237

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The code for a language. This allows you to support a 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 2237

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

A name for the FAQ.

Returns:

• (String)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access the S3 bucket that contains the FAQ file. For more information, see [IAM access roles for Amazon Kendra].

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

Returns:

• (String)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#s3_path ⇒ Types::S3Path

The path to the FAQ file in S3.

Returns:

• (Types::S3Path)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

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

class CreateFaqRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :s3_path,
  :role_arn,
  :tags,
  :file_format,
  :client_token,
  :language_code)
  SENSITIVE = []
  include Aws::Structure
end