expressions

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

Overview

Name	expressions
Type	Resource
Id	aws.cloudsearch.expressions

Fields

The following fields are returned by SELECT queries:

describe_expressions

Name	Datatype	Description
options	string	The expression that is evaluated for sorting while processing a search request.
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_expressions	select	DomainName, region	ExpressionNames, Deployed	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.
delete_expression	delete	DomainName, ExpressionName, region		Removes an Expression from the search domain. For more information, see Configuring Expressions 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
DomainName	string
ExpressionName	string	The name of the Expression to delete.
region	string	AWS region (default: us-east-1)
Deployed	boolean	Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
ExpressionNames	array	Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

SELECT examples

describe_expressions

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.

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

DELETE examples

delete_expression

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

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