libZSservicesZSamazonka-docdbZSamazonka-docdb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DocumentDB.Types.Filter

Description

 
Synopsis

Documentation

data Filter Source #

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

See: newFilter smart constructor.

Constructors

Filter' 

Fields

  • name :: Text

    The name of the filter. Filter names are case sensitive.

  • values :: [Text]

    One or more filter values. Filter values are case sensitive.

Instances

Instances details
Eq Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

(==) :: Filter -> Filter -> Bool #

(/=) :: Filter -> Filter -> Bool #

Read Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Show Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Generic Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Associated Types

type Rep Filter :: Type -> Type #

Methods

from :: Filter -> Rep Filter x #

to :: Rep Filter x -> Filter #

NFData Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

rnf :: Filter -> () #

Hashable Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

Methods

hashWithSalt :: Int -> Filter -> Int #

hash :: Filter -> Int #

ToQuery Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

type Rep Filter Source # 
Instance details

Defined in Amazonka.DocumentDB.Types.Filter

type Rep Filter = D1 ('MetaData "Filter" "Amazonka.DocumentDB.Types.Filter" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newFilter Source #

Create a value of Filter 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:name:Filter', filter_name - The name of the filter. Filter names are case sensitive.

$sel:values:Filter', filter_values - One or more filter values. Filter values are case sensitive.

filter_name :: Lens' Filter Text Source #

The name of the filter. Filter names are case sensitive.

filter_values :: Lens' Filter [Text] Source #

One or more filter values. Filter values are case sensitive.