Class: Aws::Kendra::Types::UpdateThesaurusRequest

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

{
  id: "ThesaurusId", # required
  name: "ThesaurusName",
  index_id: "IndexId", # required
  description: "Description",
  role_arn: "RoleArn",
  source_s3_path: {
    bucket: "S3BucketName", # required
    key: "S3ObjectKey", # required
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

The updated description of the thesaurus.

Returns:

  • (String)

6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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

#idString

The identifier of the thesaurus to update.

Returns:

  • (String)

6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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

#index_idString

The identifier of the index associated with the thesaurus to update.

Returns:

  • (String)

6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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

#nameString

The updated name of the thesaurus.

Returns:

  • (String)

6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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

#role_arnString

The updated role ARN of the thesaurus.

Returns:

  • (String)

6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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

#source_s3_pathTypes::S3Path

Information required to find a specific file in an Amazon S3 bucket.

Returns:


6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
# File 'lib/aws-sdk-kendra/types.rb', line 6697

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