create_featured_results_set ¶

def create_featured_results_set(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    featured_results_set_name: "capo_kendra.types.featured_results_set_name.FeaturedResultsSetName",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
    description: Optional[
        "capo_kendra.types.featured_results_set_description.FeaturedResultsSetDescription"
    ] = None,
    client_token: Optional[
        "capo_kendra.types.client_token_name.ClientTokenName"
    ] = 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,
    tags: Optional["capo_kendra.types.tag_list.TagList"] = None,
) -> "capo_kendra.types.create_featured_results_set_response.CreateFeaturedResultsSetResponse":
    """<p>Creates a set of featured results to display at the top of the search results page. Featured 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, then one or more specific documents are featured in the search results.</p> <p>You can create up to 50 sets of featured results per index. You can request to increase this limit by contacting <a href="http://aws.amazon.com/contact-us/">Support</a>.</p>

    Args:
        index_id: <p>The identifier of the index that you want to use for featuring results.</p>
        featured_results_set_name: <p>A name for the set of featured results.</p>
        description: <p>A description for the set of featured results.</p>
        client_token: <p>A token that you provide to identify the request to create a set of featured results. Multiple calls to the <code>CreateFeaturedResultsSet</code> API with the same client token will create only one featured results set.</p>
        status: <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>
        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 documents, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_FeaturedResultsSet.html">FeaturedResultsSet</a>.</p>
        tags: <p>A list of key-value pairs that identify or categorize the featured results set. You can also use tags to help control access to the featured results set. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols:_ . : / = + - @.</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.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistences with your resources 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.create_featured_results_set_request.CreateFeaturedResultsSetRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.create_featured_results_set_response.CreateFeaturedResultsSetResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.create_featured_results_set

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateFeaturedResultsSet")
    )
    input_: capo_kendra.types.create_featured_results_set_request.CreateFeaturedResultsSetRequest = {
        "index_id": index_id,
        "featured_results_set_name": featured_results_set_name,
    }
    if description is not None:
        input_["description"] = description
    if client_token is not None:
        input_["client_token"] = client_token
    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
    if tags is not None:
        input_["tags"] = tags

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