Class: Aws::Kendra::Types::CreateFeaturedResultsSetRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kendra::Types::CreateFeaturedResultsSetRequest
- Defined in:
- gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
A token that you provide to identify the request to create a set of featured results.
-
#description ⇒ String
A description for the set of featured results.
-
#featured_documents ⇒ Array<Types::FeaturedDocument>
A list of document IDs for the documents you want to feature at the top of the search results page.
-
#featured_results_set_name ⇒ String
A name for the set of featured results.
-
#index_id ⇒ String
The identifier of the index that you want to use for featuring results.
-
#query_texts ⇒ Array<String>
A list of queries for featuring results.
-
#status ⇒ String
The current status of the set of featured results.
-
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize the featured results set.
Instance Attribute Details
#client_token ⇒ String
A token that you provide to identify the request to create a set of
featured results. Multiple calls to the CreateFeaturedResultsSet
API with the same client token will create only one featured results
set.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description for the set of featured results.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#featured_documents ⇒ Array<Types::FeaturedDocument>
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 documents, see FeaturedResultsSet.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#featured_results_set_name ⇒ String
A name for the set of featured results.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#index_id ⇒ String
The identifier of the index that you want to use for featuring results.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#query_texts ⇒ Array<String>
A list of queries for featuring results. For more information on the list of queries, see FeaturedResultsSet.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The current status of the set of featured results. When the value is
ACTIVE
, featured results are ready for use. You can still
configure your settings before setting the status to ACTIVE
. You
can set the status to ACTIVE
or INACTIVE
using the
UpdateFeaturedResultsSet API. The queries you specify for
featured results must be unique per featured results set for each
index, whether the status is ACTIVE
or INACTIVE
.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Array<Types::Tag>
A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 |
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 2326 class CreateFeaturedResultsSetRequest < Struct.new( :index_id, :featured_results_set_name, :description, :client_token, :status, :query_texts, :featured_documents, :tags) SENSITIVE = [] include Aws::Structure end |