analysis_schemes

Creates, updates, deletes, gets or lists an analysis_schemes resource.

Overview

Name	analysis_schemes
Type	Resource
Id	aws.cloudsearch.analysis_schemes

Fields

The following fields are returned by SELECT queries:

describe_analysis_schemes

Name	Datatype	Description
options	string	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.
status	string	The status of domain configuration option.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_analysis_schemes	select	DomainName, region	AnalysisSchemeNames, Deployed	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.
delete_analysis_scheme	delete	DomainName, AnalysisSchemeName, region		Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
AnalysisSchemeName	string	The name of the analysis scheme you want to delete.
DomainName	string
region	string	AWS region (default: us-east-1)
AnalysisSchemeNames	array	The analysis schemes you want to describe.
Deployed	boolean	Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

SELECT examples

describe_analysis_schemes

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.

SELECT
options,
status
FROM aws.cloudsearch.analysis_schemes
WHERE DomainName = '{{ DomainName }}' -- required
AND region = '{{ region }}' -- required
AND AnalysisSchemeNames = '{{ AnalysisSchemeNames }}'
AND Deployed = '{{ Deployed }}'
;

DELETE examples

delete_analysis_scheme

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

DELETE FROM aws.cloudsearch.analysis_schemes
WHERE DomainName = '{{ DomainName }}' --required
AND AnalysisSchemeName = '{{ AnalysisSchemeName }}' --required
AND region = '{{ region }}' --required
;