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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UpdateFeaturedResultsSetRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

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

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

• #featured_results_set_name ⇒ String

  A new name for the set of featured results.

• #index_id ⇒ String

  The identifier of the index used for featuring results.

• #query_texts ⇒ Array<String>

  A list of queries for featuring results.

• #status ⇒ String

  You can set the status to ‘ACTIVE` or `INACTIVE`.

Instance Attribute Details

#description ⇒ String

A new description for the set of featured results.

Returns:

• (String)

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

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

#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 featured documents, see [FeaturedResultsSet].

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

Returns:

• (Array<Types::FeaturedDocument>)

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

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

#featured_results_set_id ⇒ String

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

Returns:

• (String)

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

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

#featured_results_set_name ⇒ String

A new name for the set of featured results.

Returns:

• (String)

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

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

The identifier of the index used for featuring results.

Returns:

• (String)

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

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_texts ⇒ Array<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>)

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

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

#status ⇒ String

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)

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

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