Describe Suggesters

cloudsearch_describe_suggesters

R Documentation

Gets the suggesters configured for a domain

Description

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.

Usage

cloudsearch_describe_suggesters(DomainName, SuggesterNames, Deployed)

Arguments

DomainName

[required] The name of the domain you want to describe.

SuggesterNames

The suggesters you want to describe.

Deployed

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

Value

A list with the following syntax:

list(
  Suggesters = list(
    list(
      Options = list(
        SuggesterName = "string",
        DocumentSuggesterOptions = list(
          SourceField = "string",
          FuzzyMatching = "none"|"low"|"high",
          SortExpression = "string"
        )
      ),
      Status = list(
        CreationDate = as.POSIXct(
          "2015-01-01"
        ),
        UpdateDate = as.POSIXct(
          "2015-01-01"
        ),
        UpdateVersion = 123,
        State = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate",
        PendingDeletion = TRUE|FALSE
      )
    )
  )
)

Request syntax

svc$describe_suggesters(
  DomainName = "string",
  SuggesterNames = list(
    "string"
  ),
  Deployed = TRUE|FALSE
)