kendra / Client / list_featured_results_sets

list_featured_results_sets

kendra.Client.list_featured_results_sets(**kwargs)

Lists all your sets of featured results for a given index. Features 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: AWS API Documentation

Request Syntax

response = client.list_featured_results_sets(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

• IndexId (string) –

  [REQUIRED]

  The identifier of the index used for featuring results.

• NextToken (string) – If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.

• MaxResults (integer) – The maximum number of featured results sets to return.

Return type:

dict

Returns:

Response Syntax

{
    'FeaturedResultsSetSummaryItems': [
        {
            'FeaturedResultsSetId': 'string',
            'FeaturedResultsSetName': 'string',
            'Status': 'ACTIVE'|'INACTIVE',
            'LastUpdatedTimestamp': 123,
            'CreationTimestamp': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • FeaturedResultsSetSummaryItems (list) –

    An array of summary information for one or more featured results sets.

    • (dict) –

      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.

      • FeaturedResultsSetId (string) –

        The identifier of the set of featured results.

      • FeaturedResultsSetName (string) –

        The name for the set of featured results.

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

      • LastUpdatedTimestamp (integer) –

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

      • CreationTimestamp (integer) –

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

  • NextToken (string) –

    If the response is truncated, Amazon Kendra returns a pagination token in the response.

Exceptions

• kendra.Client.exceptions.ResourceNotFoundException

• kendra.Client.exceptions.AccessDeniedException

• kendra.Client.exceptions.ValidationException

• kendra.Client.exceptions.ThrottlingException

• kendra.Client.exceptions.InternalServerException