Skip to content

Define Analysis Scheme

cloudsearch_define_analysis_scheme R Documentation

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options

Description

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

Usage

cloudsearch_define_analysis_scheme(DomainName, AnalysisScheme)

Arguments

DomainName

[required] A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
AnalysisScheme

[required] 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.

Value

A list with the following syntax:

list(
  AnalysisScheme = list(
    Options = list(
      AnalysisSchemeName = "string",
      AnalysisSchemeLanguage = "ar"|"bg"|"ca"|"cs"|"da"|"de"|"el"|"en"|"es"|"eu"|"fa"|"fi"|"fr"|"ga"|"gl"|"he"|"hi"|"hu"|"hy"|"id"|"it"|"ja"|"ko"|"lv"|"mul"|"nl"|"no"|"pt"|"ro"|"ru"|"sv"|"th"|"tr"|"zh-Hans"|"zh-Hant",
      AnalysisOptions = list(
        Synonyms = "string",
        Stopwords = "string",
        StemmingDictionary = "string",
        JapaneseTokenizationDictionary = "string",
        AlgorithmicStemming = "none"|"minimal"|"light"|"full"
      )
    ),
    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$define_analysis_scheme(
  DomainName = "string",
  AnalysisScheme = list(
    AnalysisSchemeName = "string",
    AnalysisSchemeLanguage = "ar"|"bg"|"ca"|"cs"|"da"|"de"|"el"|"en"|"es"|"eu"|"fa"|"fi"|"fr"|"ga"|"gl"|"he"|"hi"|"hu"|"hy"|"id"|"it"|"ja"|"ko"|"lv"|"mul"|"nl"|"no"|"pt"|"ro"|"ru"|"sv"|"th"|"tr"|"zh-Hans"|"zh-Hant",
    AnalysisOptions = list(
      Synonyms = "string",
      Stopwords = "string",
      StemmingDictionary = "string",
      JapaneseTokenizationDictionary = "string",
      AlgorithmicStemming = "none"|"minimal"|"light"|"full"
    )
  )
)