Define Index Field

cloudsearch_define_index_field

R Documentation

Configures an IndexField for the search domain

Description

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

Usage

cloudsearch_define_index_field(DomainName, IndexField)

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).
IndexField	[required] The index field and field options you want to configure.

Value

A list with the following syntax:

list(
  IndexField = list(
    Options = list(
      IndexFieldName = "string",
      IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array",
      IntOptions = list(
        DefaultValue = 123,
        SourceField = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE
      ),
      DoubleOptions = list(
        DefaultValue = 123.0,
        SourceField = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE
      ),
      LiteralOptions = list(
        DefaultValue = "string",
        SourceField = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE
      ),
      TextOptions = list(
        DefaultValue = "string",
        SourceField = "string",
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE,
        HighlightEnabled = TRUE|FALSE,
        AnalysisScheme = "string"
      ),
      DateOptions = list(
        DefaultValue = "string",
        SourceField = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE
      ),
      LatLonOptions = list(
        DefaultValue = "string",
        SourceField = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE,
        SortEnabled = TRUE|FALSE
      ),
      IntArrayOptions = list(
        DefaultValue = 123,
        SourceFields = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE
      ),
      DoubleArrayOptions = list(
        DefaultValue = 123.0,
        SourceFields = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE
      ),
      LiteralArrayOptions = list(
        DefaultValue = "string",
        SourceFields = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE
      ),
      TextArrayOptions = list(
        DefaultValue = "string",
        SourceFields = "string",
        ReturnEnabled = TRUE|FALSE,
        HighlightEnabled = TRUE|FALSE,
        AnalysisScheme = "string"
      ),
      DateArrayOptions = list(
        DefaultValue = "string",
        SourceFields = "string",
        FacetEnabled = TRUE|FALSE,
        SearchEnabled = TRUE|FALSE,
        ReturnEnabled = TRUE|FALSE
      )
    ),
    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_index_field(
  DomainName = "string",
  IndexField = list(
    IndexFieldName = "string",
    IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array",
    IntOptions = list(
      DefaultValue = 123,
      SourceField = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE
    ),
    DoubleOptions = list(
      DefaultValue = 123.0,
      SourceField = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE
    ),
    LiteralOptions = list(
      DefaultValue = "string",
      SourceField = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE
    ),
    TextOptions = list(
      DefaultValue = "string",
      SourceField = "string",
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE,
      HighlightEnabled = TRUE|FALSE,
      AnalysisScheme = "string"
    ),
    DateOptions = list(
      DefaultValue = "string",
      SourceField = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE
    ),
    LatLonOptions = list(
      DefaultValue = "string",
      SourceField = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE,
      SortEnabled = TRUE|FALSE
    ),
    IntArrayOptions = list(
      DefaultValue = 123,
      SourceFields = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE
    ),
    DoubleArrayOptions = list(
      DefaultValue = 123.0,
      SourceFields = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE
    ),
    LiteralArrayOptions = list(
      DefaultValue = "string",
      SourceFields = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE
    ),
    TextArrayOptions = list(
      DefaultValue = "string",
      SourceFields = "string",
      ReturnEnabled = TRUE|FALSE,
      HighlightEnabled = TRUE|FALSE,
      AnalysisScheme = "string"
    ),
    DateArrayOptions = list(
      DefaultValue = "string",
      SourceFields = "string",
      FacetEnabled = TRUE|FALSE,
      SearchEnabled = TRUE|FALSE,
      ReturnEnabled = TRUE|FALSE
    )
  )
)