Class: Aws::Kendra::Types::CreateQuerySuggestionsBlockListRequest

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::CreateQuerySuggestionsBlockListRequest

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 query suggestions block list.

• #description ⇒ String

  A description for the block list.

• #index_id ⇒ String

  The identifier of the index you want to create a query suggestions block list for.

• #name ⇒ String

  A name for the block list.

• #role_arn ⇒ String

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

• #source_s3_path ⇒ Types::S3Path

  The S3 path to your block list text file in your S3 bucket.

• #tags ⇒ Array<Types::Tag>

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

Instance Attribute Details

#client_token ⇒ String

A token that you provide to identify the request to create a query suggestions block list.

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 2548

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

#description ⇒ String

A description for the block list.

For example, the description "List of all offensive words that can appear in user queries and need to be blocked from suggestions."

Returns:

• (String)

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

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

#index_id ⇒ String

The identifier of the index you want to create a query suggestions block list for.

Returns:

• (String)

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

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

#name ⇒ String

A name for the block list.

For example, the name 'offensive-words', which includes all offensive words that could appear in user queries and need to be blocked from suggestions.

Returns:

• (String)

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

class CreateQuerySuggestionsBlockListRequest < Struct.new(
  :index_id,
  :name,
  :description,
  :source_s3_path,
  :client_token,
  :role_arn,
  :tags)
  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 block list text file. For more information, see IAM access roles for Amazon Kendra.

Returns:

• (String)

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

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

#source_s3_path ⇒ Types::S3Path

The S3 path to your block list text file in your S3 bucket.

Each block word or phrase should be on a separate line in a text file.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

Returns:

• (Types::S3Path)

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

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

#tags ⇒ Array<Types::Tag>

A list of key-value pairs that identify or categorize the block list. 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 2548

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