Skip to content

aws.cloudsearch.describe_suggesters

Example SQL Queries

SELECT * FROM
aws.cloudsearch.describe_suggesters
WHERE
"domain_name" = 'VALUE';

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.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of the domain you want to describe.

VARCHAR
deployed Input Column

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

BOOLEAN
suggester_names Input Column

The suggesters you want to describe.

VARCHAR[]
Show child fields
suggester_names[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
suggesters

The suggesters configured for the domain specified in the request.

STRUCT(
"options" STRUCT(
"suggester_name" VARCHAR,
"document_suggester_options" STRUCT(
"source_field" VARCHAR,
"fuzzy_matching" VARCHAR,
"sort_expression" VARCHAR
)
),
"status" STRUCT(
"creation_date" TIMESTAMP_S,
"update_date" TIMESTAMP_S,
"update_version" BIGINT,
"state" VARCHAR,
"pending_deletion" BOOLEAN
)
)[]
Show child fields
suggesters[]
Show child fields
suggesters[].options

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

Show child fields
suggesters[].options.document_suggester_options

Options for a search suggester.

Show child fields
suggesters[].options.document_suggester_options.fuzzy_matching

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

suggesters[].options.document_suggester_options.sort_expression

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

suggesters[].options.document_suggester_options.source_field

The name of the index field you want to use for suggestions.

suggesters[].options.suggester_name

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

suggesters[].status

The status of domain configuration option.

Show child fields
suggesters[].status.creation_date

A timestamp for when this option was created.

suggesters[].status.pending_deletion

Indicates that the option will be deleted once processing is complete.

suggesters[].status.state

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
suggesters[].status.update_date

A timestamp for when this option was last updated.

suggesters[].status.update_version

A unique integer that indicates when this option was last updated.