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

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 CreateThesaurusRequest data as a hash:

{
  index_id: "IndexId", # required
  name: "ThesaurusName", # required
  description: "Description",
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  source_s3_path: { # required
    bucket: "S3BucketName", # required
    key: "S3ObjectKey", # required
  },
  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 thesaurus. Multiple calls to the `CreateThesaurus` operation with the same client token will create only one index.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String)

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#descriptionString

The description for the new thesaurus.

Returns:

  • (String)

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#index_idString

The unique identifier of the index for the new thesaurus.

Returns:

  • (String)

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#nameString

The name for the new thesaurus.

Returns:

  • (String)

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#role_arnString

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access thesaurus file specified in `SourceS3Path`.

Returns:

  • (String)

2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#source_s3_pathTypes::S3Path

The thesaurus file Amazon S3 source path.

Returns:


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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

#tagsArray<Types::Tag>

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

Returns:


2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
# File 'lib/aws-sdk-kendra/types.rb', line 2046

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