Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribeSuggestersCommand

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.

example

Use a bare-bones client and the command you need to make an API call.

import { CloudSearchClient, DescribeSuggestersCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import
// const { CloudSearchClient, DescribeSuggestersCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import
const client = new CloudSearchClient(config);
const command = new DescribeSuggestersCommand(input);
const response = await client.send(command);
see

DescribeSuggestersCommandInput for command's input shape.

see

DescribeSuggestersCommandOutput for command's response shape.

see

config for CloudSearchClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: DescribeSuggestersCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions