kendra / Client / batch_delete_featured_results_set

batch_delete_featured_results_set

kendra.Client.batch_delete_featured_results_set(**kwargs)

Removes one or more sets of featured results. 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.batch_delete_featured_results_set(
    IndexId='string',
    FeaturedResultsSetIds=[
        'string',
    ]
)

Parameters:

• IndexId (string) –

  [REQUIRED]

  The identifier of the index used for featuring results.

• FeaturedResultsSetIds (list) –

  [REQUIRED]

  The identifiers of the featured results sets that you want to delete.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Errors': [
        {
            'Id': 'string',
            'ErrorCode': 'InternalError'|'InvalidRequest',
            'ErrorMessage': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Errors (list) –

    The list of errors for the featured results set IDs, explaining why they couldn’t be removed from the index.

    • (dict) –

      Provides information about a set of featured results that couldn’t be removed from an index by the BatchDeleteFeaturedResultsSet API.

      • Id (string) –

        The identifier of the set of featured results that couldn’t be removed from the index.

      • ErrorCode (string) –

        The error code for why the set of featured results couldn’t be removed from the index.

      • ErrorMessage (string) –

        An explanation for why the set of featured results couldn’t be removed from the index.

Exceptions

• kendra.Client.exceptions.ResourceNotFoundException

• kendra.Client.exceptions.AccessDeniedException

• kendra.Client.exceptions.ValidationException

• kendra.Client.exceptions.ThrottlingException

• kendra.Client.exceptions.InternalServerException