AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

Note:

For PCL this operation is only available in asynchronous form. Please refer to SuggestAsync.

Namespace: Amazon.CloudSearchDomain
Assembly: AWSSDK.CloudSearchDomain.dll
Version: 3.x.y.z

Syntax

C#
public virtual SuggestResponse Suggest(
         SuggestRequest request
)
Parameters
request
Type: Amazon.CloudSearchDomain.Model.SuggestRequest

Container for the necessary parameters to execute the Suggest service method.

Return Value
The response from the Suggest service method, as returned by CloudSearchDomain.

Exceptions

ExceptionCondition
SearchException Information about any problems encountered while processing a search request.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms