Skip to content

FeaturedResultsSetSummary

Source code in docs_src/capo_kendra/types/featured_results_set_summary.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class FeaturedResultsSetSummary(TypedDict, closed=True):
    featured_results_set_id: NotRequired[
        "capo_kendra.types.featured_results_set_id.FeaturedResultsSetId"
    ]
    """<p>The identifier of the set of featured results.</p>"""
    featured_results_set_name: NotRequired[
        "capo_kendra.types.featured_results_set_name.FeaturedResultsSetName"
    ]
    """<p>The name for the set of featured results.</p>"""
    status: NotRequired[
        "capo_kendra.types.featured_results_set_status.FeaturedResultsSetStatus"
    ]
    """<p>The current status of the set of featured results. When the value is <code>ACTIVE</code>, featured results are ready for use. You can still configure your settings before setting the status to <code>ACTIVE</code>. You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code> using the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateFeaturedResultsSet.html">UpdateFeaturedResultsSet</a> API. The queries you specify for featured results must be unique per featured results set for each index, whether the status is <code>ACTIVE</code> or <code>INACTIVE</code>.</p>"""
    last_updated_timestamp: NotRequired["capo_kendra.types.long.Long"]
    """<p>The Unix timestamp when the set of featured results was last updated.</p>"""
    creation_timestamp: NotRequired["capo_kendra.types.long.Long"]
    """<p>The Unix timestamp when the set of featured results was created.</p>"""

creation_timestamp instance-attribute 

creation_timestamp: NotRequired[Long]

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

featured_results_set_id instance-attribute 

featured_results_set_id: NotRequired[FeaturedResultsSetId]

The identifier of the set of featured results.

featured_results_set_name instance-attribute 

featured_results_set_name: NotRequired[FeaturedResultsSetName]

The name for the set of featured results.

last_updated_timestamp instance-attribute 

last_updated_timestamp: NotRequired[Long]

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

status instance-attribute 

status: NotRequired[FeaturedResultsSetStatus]

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.