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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::DescribeQuerySuggestionsBlockListResponse

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The Unix timestamp when a block list for query suggestions was created.

• #description ⇒ String

  The description for the block list.

• #error_message ⇒ String

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

• #file_size_bytes ⇒ Integer

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

• #id ⇒ String

  The identifier of the block list.

• #index_id ⇒ String

  The identifier of the index for the block list.

• #item_count ⇒ Integer

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

• #name ⇒ String

  The name of the block list.

• #role_arn ⇒ String

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

• #source_s3_path ⇒ Types::S3Path

  Shows the current S3 path to your block list text file in your S3 bucket.

• #status ⇒ String

  The current status of the block list.

• #updated_at ⇒ Time

  The Unix timestamp when a block list for query suggestions was last updated.

Instance Attribute Details

#created_at ⇒ Time

The Unix timestamp when a block list for query suggestions was created.

Returns:

• (Time)

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

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

#description ⇒ String

The description for the block list.

Returns:

• (String)

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

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_message ⇒ String

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

Returns:

• (String)

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

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_bytes ⇒ Integer

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

Returns:

• (Integer)

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

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

#id ⇒ String

The identifier of the block list.

Returns:

• (String)

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

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_id ⇒ String

The identifier of the index for the block list.

Returns:

• (String)

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

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_count ⇒ Integer

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

Returns:

• (Integer)

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

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

#name ⇒ String

The name of the block list.

Returns:

• (String)

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

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_arn ⇒ String

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)

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

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_path ⇒ Types::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].

[1]: docs.aws.amazon.com/kendra/latest/dg/quotas.html

Returns:

• (Types::S3Path)

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

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

#status ⇒ String

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

Returns:

• (String)

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

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_at ⇒ Time

The Unix timestamp when a block list for query suggestions was last updated.

Returns:

• (Time)

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

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