Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeSuggestersRequest

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Hierarchy

Index

Properties

Optional Deployed

Deployed: undefined | false | true

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

DomainName

DomainName: string | undefined

The name of the domain you want to describe.

Optional SuggesterNames

SuggesterNames: string[]

The suggesters you want to describe.