Skip to content

describe_query_suggestions_config

describe_query_suggestions_config(
    index_id: IndexId, *, config_overrides: Optional[kendraClientConfig] = None
) -> DescribeQuerySuggestionsConfigResponse

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

DescribeQuerySuggestionsConfig is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Parameters:

  • index_id (IndexId) –

    The identifier of the index with query suggestions that you want to get information on.

Raises:

  • AccessDeniedException –

    You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

  • ResourceNotFoundException –

    The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

  • ThrottlingException –

    The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ValidationException –

    The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_kendra/_services/kendra.py
def describe_query_suggestions_config(
    self,
    index_id: "capo_kendra.types.index_id.IndexId",
    *,
    config_overrides: Optional[kendraClientConfig] = None,
) -> "capo_kendra.types.describe_query_suggestions_config_response.DescribeQuerySuggestionsConfigResponse":
    """<p>Gets information on the settings of query suggestions for an index.</p> <p>This is used to check the current settings applied to query suggestions.</p> <p> <code>DescribeQuerySuggestionsConfig</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>

    Args:
        index_id: <p>The identifier of the index with query suggestions that you want to get information on.</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.
    """

    def _handler(
        req: "OperationRequest[capo_kendra.types.describe_query_suggestions_config_request.DescribeQuerySuggestionsConfigRequest]",
    ) -> OperationResponse[
        "capo_kendra.types.describe_query_suggestions_config_response.DescribeQuerySuggestionsConfigResponse"
    ]:
        import capo_kendra._operations.aws_kendra_frontend_service.describe_query_suggestions_config

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeQuerySuggestionsConfig")
    )
    input_: capo_kendra.types.describe_query_suggestions_config_request.DescribeQuerySuggestionsConfigRequest = {
        "index_id": index_id
    }

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