Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- data SearchExpression = SearchExpression' {}
- newSearchExpression :: SearchExpression
- searchExpression_subExpressions :: Lens' SearchExpression (Maybe (NonEmpty SearchExpression))
- searchExpression_operator :: Lens' SearchExpression (Maybe BooleanOperator)
- searchExpression_filters :: Lens' SearchExpression (Maybe (NonEmpty Filter))
- searchExpression_nestedFilters :: Lens' SearchExpression (Maybe (NonEmpty NestedFilters))
Documentation
data SearchExpression Source #
A multi-expression that searches for the specified resource or resources
in a search. All resource objects that satisfy the expression's
condition are included in the search results. You must specify at least
one subexpression, filter, or nested filter. A SearchExpression
can
contain up to twenty elements.
A SearchExpression
contains the following components:
- A list of
Filter
objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value. - A list of
NestedFilter
objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions. - A list of
SearchExpression
objects. A search expression object can be nested in a list of search expression objects. - A Boolean operator:
And
orOr
.
See: newSearchExpression
smart constructor.
SearchExpression' | |
|
Instances
newSearchExpression :: SearchExpression Source #
Create a value of SearchExpression
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subExpressions:SearchExpression'
, searchExpression_subExpressions
- A list of search expression objects.
$sel:operator:SearchExpression'
, searchExpression_operator
- A Boolean operator used to evaluate the search expression. If you want
every conditional statement in all lists to be satisfied for the entire
search expression to be true, specify And
. If only a single
conditional statement needs to be true for the entire search expression
to be true, specify Or
. The default value is And
.
$sel:filters:SearchExpression'
, searchExpression_filters
- A list of filter objects.
$sel:nestedFilters:SearchExpression'
, searchExpression_nestedFilters
- A list of nested filter objects.
searchExpression_subExpressions :: Lens' SearchExpression (Maybe (NonEmpty SearchExpression)) Source #
A list of search expression objects.
searchExpression_operator :: Lens' SearchExpression (Maybe BooleanOperator) Source #
A Boolean operator used to evaluate the search expression. If you want
every conditional statement in all lists to be satisfied for the entire
search expression to be true, specify And
. If only a single
conditional statement needs to be true for the entire search expression
to be true, specify Or
. The default value is And
.
searchExpression_filters :: Lens' SearchExpression (Maybe (NonEmpty Filter)) Source #
A list of filter objects.
searchExpression_nestedFilters :: Lens' SearchExpression (Maybe (NonEmpty NestedFilters)) Source #
A list of nested filter objects.