Class: Aws::Kendra::Types::DescribeQuerySuggestionsBlockListResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

Shows the date-time a block list for query suggestions was created.

Returns:

  • (Time)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

Shows the description for the block list.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#error_messageString

Shows the error message with details when there are issues in processing the block list.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#file_size_bytesInteger

Shows the current size of the block list text file in S3.

Returns:

  • (Integer)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#idString

Shows the unique identifier of the block list.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

Shows the identifier of the index for the block list.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#item_countInteger

Shows the current number of valid, non-empty words or phrases in the block list text file.

Returns:

  • (Integer)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

Shows the name of the block list.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

Shows the current IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.

The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#source_s3_pathTypes::S3Path

Shows the current 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:



3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

Shows whether the current status of the block list is ACTIVE or INACTIVE.

Returns:

  • (String)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#updated_atTime

Shows the date-time a block list for query suggestions was last updated.

Returns:

  • (Time)


3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3961

class DescribeQuerySuggestionsBlockListResponse < Struct.new(
  :index_id,
  :id,
  :name,
  :description,
  :status,
  :error_message,
  :created_at,
  :updated_at,
  :source_s3_path,
  :item_count,
  :file_size_bytes,
  :role_arn)
  SENSITIVE = []
  include Aws::Structure
end