Define Expression

cloudsearch_define_expression

R Documentation

Configures an Expression for the search domain

Description

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Usage

cloudsearch_define_expression(DomainName, Expression)

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).
Expression	[required] A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

Value

A list with the following syntax:

list(
  Expression = list(
    Options = list(
      ExpressionName = "string",
      ExpressionValue = "string"
    ),
    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_expression(
  DomainName = "string",
  Expression = list(
    ExpressionName = "string",
    ExpressionValue = "string"
  )
)