Describe Expressions

cloudsearch_describe_expressions

R Documentation

Gets the expressions configured for the search domain¶

Description¶

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions 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 Expressions in the Amazon CloudSearch Developer Guide.

Usage¶

cloudsearch_describe_expressions(DomainName, ExpressionNames, Deployed)

Arguments¶

DomainName

[required] The name of the domain you want to describe.

ExpressionNames

Limits the describe_expressions response to the specified expressions. If not specified, all expressions are shown.

Deployed

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

Value¶

A list with the following syntax:

list(
  Expressions = list(
    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$describe_expressions(
  DomainName = "string",
  ExpressionNames = list(
    "string"
  ),
  Deployed = TRUE|FALSE
)