Class: Aws::Kendra::Types::UpdateFeaturedResultsSetRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A new description for the set of featured results.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

A list of document IDs for the documents you want to feature at the top of the search results page. For more information on the list of featured documents, see [FeaturedResultsSet].

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

Returns:



10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

The identifier of the set of featured results that you want to update.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

A new name for the set of featured results.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

#index_idString

The identifier of the index used for featuring results.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

#query_textsArray<String>

A list of queries for featuring results. For more information on the list of queries, see [FeaturedResultsSet].

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

Returns:

  • (Array<String>)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

You can set the status to ‘ACTIVE` or `INACTIVE`. When the value is `ACTIVE`, featured results are ready for use. You can still configure your settings before setting the status to `ACTIVE`. The queries you specify for featured results must be unique per featured results set for each index, whether the status is `ACTIVE` or `INACTIVE`.

Returns:

  • (String)


10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
# File 'lib/aws-sdk-kendra/types.rb', line 10738

class UpdateFeaturedResultsSetRequest < Struct.new(
  :index_id,
  :featured_results_set_id,
  :featured_results_set_name,
  :description,
  :status,
  :query_texts,
  :featured_documents)
  SENSITIVE = []
  include Aws::Structure
end