suggesters

Creates, updates, deletes, gets or lists a suggesters resource.

Overview

Name	suggesters
Type	Resource
Id	aws.cloudsearch.suggesters

Fields

The following fields are returned by SELECT queries:

describe_suggesters

Name	Datatype	Description
options	string	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.
status	string	The status of domain configuration option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_suggesters	select	DomainName, region	SuggesterNames, Deployed	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.
delete_suggester	delete	DomainName, SuggesterName, region		Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
build_suggesters	exec	DomainName, region		Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
DomainName	string
SuggesterName	string	Specifies the name of the suggester you want to delete.
region	string	AWS region (default: us-east-1)
Deployed	boolean	Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
SuggesterNames	array	The suggesters you want to describe.

SELECT examples

describe_suggesters

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.

SELECT
options,
status
FROM aws.cloudsearch.suggesters
WHERE DomainName = '{{ DomainName }}' -- required
AND region = '{{ region }}' -- required
AND SuggesterNames = '{{ SuggesterNames }}'
AND Deployed = '{{ Deployed }}'
;

DELETE examples

delete_suggester

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

DELETE FROM aws.cloudsearch.suggesters
WHERE DomainName = '{{ DomainName }}' --required
AND SuggesterName = '{{ SuggesterName }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

build_suggesters

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

EXEC aws.cloudsearch.suggesters.build_suggesters 
@DomainName='{{ DomainName }}' --required, 
@region='{{ region }}' --required
;