Class: Aws::Kendra::Types::UpdateQuerySuggestionsBlockListRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateQuerySuggestionsBlockListRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A new description for the block list.

• #id ⇒ String

  The identifier of the block list you want to update.

• #index_id ⇒ String

  The identifier of the index for the block list.

• #name ⇒ String

  A new name for the block list.

• #role_arn ⇒ String

  The IAM (Identity and Access Management) role used to access the block list text file in S3.

• #source_s3_path ⇒ Types::S3Path

  The S3 path where your block list text file sits in S3.

Instance Attribute Details

#description ⇒ String

A new description for the block list.

Returns:

• (String)

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

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

#id ⇒ String

The identifier of the block list you want to update.

Returns:

• (String)

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

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

#index_id ⇒ String

The identifier of the index for the block list.

Returns:

• (String)

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

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

#name ⇒ String

A new name for the block list.

Returns:

• (String)

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

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

#role_arn ⇒ String

The IAM (Identity and Access Management) role used to access the block list text file in S3.

Returns:

• (String)

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

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

#source_s3_path ⇒ Types::S3Path

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the ‘UpdateQuerySuggestionsBlockList` API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

Returns:

• (Types::S3Path)

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

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