Documentation

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

See: newSearchFilter smart constructor.

Create a value of SearchFilter 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:attribute:SearchFilter', searchFilter_attribute - The result attribute to which the filter values are applied. Valid values vary by API action.

$sel:values:SearchFilter', searchFilter_values - The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

$sel:operator:SearchFilter', searchFilter_operator - The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

The result attribute to which the filter values are applied. Valid values vary by API action.

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.