Class: Aws::Kendra::Types::FeaturedResultsSetSummary

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

Overview

Summary information for a set of featured results. Featured results are placed above all other results for certain queries. If there’s an exact match of a query, then one or more specific documents are featured in the search results.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_timestamp ⇒ Integer

The Unix timestamp when the set of featured results was created.

Returns:

  • (Integer) 


5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/aws-sdk-kendra/types.rb', line 5621

class FeaturedResultsSetSummary < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :status,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_id ⇒ String

The identifier of the set of featured results.

Returns:

  • (String) 


5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/aws-sdk-kendra/types.rb', line 5621

class FeaturedResultsSetSummary < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :status,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#featured_results_set_name ⇒ String

The name for the set of featured results.

Returns:

  • (String) 


5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/aws-sdk-kendra/types.rb', line 5621

class FeaturedResultsSetSummary < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :status,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_timestamp ⇒ Integer

The Unix timestamp when the set of featured results was last updated.

Returns:

  • (Integer) 


5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/aws-sdk-kendra/types.rb', line 5621

class FeaturedResultsSetSummary < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :status,
  :last_updated_timestamp,
  :creation_timestamp)
  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][1

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`.

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

Returns:

  • (String) 


5621
5622
5623
5624
5625
5626
5627
5628
5629
 
# File 'lib/aws-sdk-kendra/types.rb', line 5621

class FeaturedResultsSetSummary < Struct.new(
  :featured_results_set_id,
  :featured_results_set_name,
  :status,
  :last_updated_timestamp,
  :creation_timestamp)
  SENSITIVE = []
  include Aws::Structure
end