batch_delete_featured_results_set async ¶

async def batch_delete_featured_results_set(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    featured_results_set_ids: "capo_kendra.types.featured_results_set_id_list.FeaturedResultsSetIdList",
    *,
    config_overrides: Optional[AsynckendraClientConfig] = None,
) -> "capo_kendra.types.batch_delete_featured_results_set_response.BatchDeleteFeaturedResultsSetResponse":
    """<p>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.</p>

    Args:
        index_id: <p>The identifier of the index used for featuring results.</p>
        featured_results_set_ids: <p>The identifiers of the featured results sets that you want to delete.</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.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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kendra.types.batch_delete_featured_results_set_request.BatchDeleteFeaturedResultsSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_kendra.types.batch_delete_featured_results_set_response.BatchDeleteFeaturedResultsSetResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.batch_delete_featured_results_set

        (
            output,
            http_response,
        ) = await capo_kendra._operations.aws_kendra_frontend_service.batch_delete_featured_results_set.async_batch_delete_featured_results_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchDeleteFeaturedResultsSet")
    )
    input_: capo_kendra.types.batch_delete_featured_results_set_request.BatchDeleteFeaturedResultsSetRequest = {
        "index_id": index_id,
        "featured_results_set_ids": featured_results_set_ids,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output