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

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

Returns:

  • (Time)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The description for the block list.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The error message containing details if there are issues processing the block list.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

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

Returns:

  • (Integer)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The identifier of the block list.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The identifier of the index for the block list.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

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

Returns:

  • (Integer)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The name of the block list.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The 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)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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:



3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

The current status of the block list. When the value is ACTIVE, the block list is ready for use.

Returns:

  • (String)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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

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

Returns:

  • (Time)


3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 3473

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