Skip to content

aws.cloudsearch.describe_analysis_schemes

Example SQL Queries

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

Description

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes 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 Configuring Analysis Schemes 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
analysis_scheme_names Input Column

The analysis schemes you want to describe.

VARCHAR[]
Show child fields
analysis_scheme_names[]
deployed Input Column

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

BOOLEAN
_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
analysis_schemes

The analysis scheme descriptions.

STRUCT(
"options" STRUCT(
"analysis_scheme_name" VARCHAR,
"analysis_scheme_language" VARCHAR,
"analysis_options" STRUCT(
"synonyms" VARCHAR,
"stopwords" VARCHAR,
"stemming_dictionary" VARCHAR,
"japanese_tokenization_dictionary" VARCHAR,
"algorithmic_stemming" VARCHAR
)
),
"status" STRUCT(
"creation_date" TIMESTAMP_S,
"update_date" TIMESTAMP_S,
"update_version" BIGINT,
"state" VARCHAR,
"pending_deletion" BOOLEAN
)
)[]
Show child fields
analysis_schemes[]
Show child fields
analysis_schemes[].options

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

Show child fields
analysis_schemes[].options.analysis_options

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

Show child fields
analysis_schemes[].options.analysis_options.algorithmic_stemming

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

analysis_schemes[].options.analysis_options.japanese_tokenization_dictionary

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

analysis_schemes[].options.analysis_options.stemming_dictionary

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

analysis_schemes[].options.analysis_options.stopwords

A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

analysis_schemes[].options.analysis_options.synonyms

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

analysis_schemes[].options.analysis_scheme_language

An IETF RFC 4646 language code or mul for multiple languages.

analysis_schemes[].options.analysis_scheme_name

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

analysis_schemes[].status

The status of domain configuration option.

Show child fields
analysis_schemes[].status.creation_date

A timestamp for when this option was created.

analysis_schemes[].status.pending_deletion

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

analysis_schemes[].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.
analysis_schemes[].status.update_date

A timestamp for when this option was last updated.

analysis_schemes[].status.update_version

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