update_featured_results_set ¶

def update_featured_results_set(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    featured_results_set_id: "capo_kendra.types.featured_results_set_id.FeaturedResultsSetId",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    featured_results_set_name: Optional[
        "capo_kendra.types.featured_results_set_name.FeaturedResultsSetName"
    ] = None,
    description: Optional[
        "capo_kendra.types.featured_results_set_description.FeaturedResultsSetDescription"
    ] = None,
    status: Optional[
        "capo_kendra.types.featured_results_set_status.FeaturedResultsSetStatus"
    ] = None,
    query_texts: Optional["capo_kendra.types.query_text_list.QueryTextList"] = None,
    featured_documents: Optional[
        "capo_kendra.types.featured_document_list.FeaturedDocumentList"
    ] = None,
) -> "capo_kendra.types.update_featured_results_set_response.UpdateFeaturedResultsSetResponse":
    """<p>Updates a set of featured results. Features results are placed above all other results for certain queries. You map specific queries to specific documents for featuring in the results. If a query contains an exact match of a query, then one or more specific documents are featured in the search results.</p>

    Args:
        index_id: <p>The identifier of the index used for featuring results.</p>
        featured_results_set_id: <p>The identifier of the set of featured results that you want to update.</p>
        featured_results_set_name: <p>A new name for the set of featured results.</p>
        description: <p>A new description for the set of featured results.</p>
        status: <p>You can set the status to <code>ACTIVE</code> or <code>INACTIVE</code>. 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>. 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>
        query_texts: <p>A list of queries for featuring results. For more information on the list of queries, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
        featured_documents: <p>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 <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>

    Raises:
        capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra.errors.featured_results_conflict_exception.FeaturedResultsConflictException: <p>An error message with a list of conflicting queries used across different sets of featured results. This occurred with the request for a new featured results set. Check that the queries you specified for featured results are unique per featured results set for each index.</p>
        capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
        capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
        capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.update_featured_results_set_request.UpdateFeaturedResultsSetRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.update_featured_results_set_response.UpdateFeaturedResultsSetResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.update_featured_results_set

        output, http_response = (
            capo_kendra._operations.aws_kendra_frontend_service.update_featured_results_set.update_featured_results_set(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFeaturedResultsSet")
    )
    input_: capo_kendra.types.update_featured_results_set_request.UpdateFeaturedResultsSetRequest = {
        "index_id": index_id,
        "featured_results_set_id": featured_results_set_id,
    }
    if featured_results_set_name is not None:
        input_["featured_results_set_name"] = featured_results_set_name
    if description is not None:
        input_["description"] = description
    if status is not None:
        input_["status"] = status
    if query_texts is not None:
        input_["query_texts"] = query_texts
    if featured_documents is not None:
        input_["featured_documents"] = featured_documents

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output