CloudSearch / Client / describe_suggesters

describe_suggesters#

CloudSearch.Client.describe_suggesters(**kwargs)#

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_suggesters(
    DomainName='string',
    SuggesterNames=[
        'string',
    ],
    Deployed=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain you want to describe.

  • SuggesterNames (list) –

    The suggesters you want to describe.

    • (string) –

      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

  • Deployed (boolean) – Whether to display the deployed configuration ( true) or include any pending changes ( false). Defaults to false.

Return type:

dict

Returns:

Response Syntax

{
    'Suggesters': [
        {
            'Options': {
                'SuggesterName': 'string',
                'DocumentSuggesterOptions': {
                    'SourceField': 'string',
                    'FuzzyMatching': 'none'|'low'|'high',
                    'SortExpression': 'string'
                }
            },
            'Status': {
                'CreationDate': datetime(2015, 1, 1),
                'UpdateDate': datetime(2015, 1, 1),
                'UpdateVersion': 123,
                'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
                'PendingDeletion': True|False
            }
        },
    ]
}

Response Structure

  • (dict) –

    The result of a DescribeSuggesters request.

    • Suggesters (list) –

      The suggesters configured for the domain specified in the request.

      • (dict) –

        The value of a Suggester and its current status.

        • Options (dict) –

          Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

          • SuggesterName (string) –

            Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

          • DocumentSuggesterOptions (dict) –

            Options for a search suggester.

            • SourceField (string) –

              The name of the index field you want to use for suggestions.

            • FuzzyMatching (string) –

              The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

            • SortExpression (string) –

              An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document’s relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

        • Status (dict) –

          The status of domain configuration option.

          • CreationDate (datetime) –

            A timestamp for when this option was created.

          • UpdateDate (datetime) –

            A timestamp for when this option was last updated.

          • UpdateVersion (integer) –

            A unique integer that indicates when this option was last updated.

          • State (string) –

            The state of processing a change to an option. Possible values:

            • RequiresIndexDocuments: the option’s latest value will not be deployed until IndexDocuments has been called and indexing is complete.

            • Processing: the option’s latest value is in the process of being activated.

            • Active: the option’s latest value is completely deployed.

            • FailedToValidate: the option value is not compatible with the domain’s data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

          • PendingDeletion (boolean) –

            Indicates that the option will be deleted once processing is complete.

Exceptions