AWS SDK Version 4 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.

Container for the parameters to the DescribeSuggesters operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudSearch.AmazonCloudSearchRequest
      Amazon.CloudSearch.Model.DescribeSuggestersRequest

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

Syntax

C#
public class DescribeSuggestersRequest : AmazonCloudSearchRequest
         IAmazonWebServiceRequest

The DescribeSuggestersRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeSuggestersRequest()

Properties

NameTypeDescription
Public Property Deployed System.Nullable<System.Boolean>

Gets and sets the property Deployed.

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

Public Property DomainName System.String

Gets and sets the property DomainName.

The name of the domain you want to describe.

Public Property SuggesterNames System.Collections.Generic.List<System.String>

Gets and sets the property SuggesterNames.

The suggesters you want to describe.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer