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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

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",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#descriptionString

A description of the FAQ.

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#file_formatString

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

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#index_idString

The identifier of the index that contains the FAQ.

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#nameString

The name that should be associated with the FAQ.

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#role_arnString

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

Returns:

  • (String)

1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#s3_pathTypes::S3Path

The S3 location of the FAQ input data.

Returns:


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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

#tagsArray<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:


1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'lib/aws-sdk-kendra/types.rb', line 1826

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