Class: Aws::Kendra::Types::CreateThesaurusRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::CreateThesaurusRequest

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 thesaurus.

• #description ⇒ String

  A description for the thesaurus.

• #index_id ⇒ String

  The identifier of the index for the thesaurus.

• #name ⇒ String

  A name for the thesaurus.

• #role_arn ⇒ String

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

• #source_s3_path ⇒ Types::S3Path

  The path to the thesaurus file in S3.

• #tags ⇒ Array<Types::Tag>

  A list of key-value pairs that identify or categorize the thesaurus.

Instance Attribute Details

#client_token ⇒ String

A token that you provide to identify the request to create a thesaurus. Multiple calls to the ‘CreateThesaurus` API with the same client token will create only one thesaurus.

**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 2583

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

#description ⇒ String

A description for the thesaurus.

Returns:

• (String)

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

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

#index_id ⇒ String

The identifier of the index for the thesaurus.

Returns:

• (String)

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

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

#name ⇒ String

A name for the thesaurus.

Returns:

• (String)

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

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus 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 2583

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

#source_s3_path ⇒ Types::S3Path

The path to the thesaurus file in S3.

Returns:

• (Types::S3Path)

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

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

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

• (Array<Types::Tag>)

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

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