Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.IdentityStore.Types.Filter

Description

Synopsis

data Filter = Filter' {
- attributePath :: Text
- attributeValue :: Sensitive Text
}
newFilter :: Text -> Text -> Filter
filter_attributePath :: Lens' Filter Text
filter_attributeValue :: Lens' Filter Text

Documentation

data Filter Source #

A query filter used by ListUsers and ListGroups. This filter object provides the attribute name and attribute value to search users or groups.

See: newFilter smart constructor.

Constructors

Filter'

Fields

attributePath :: Text
The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.
attributeValue :: Sensitive Text
Represents the data for an attribute. Each attribute value is described as a name-value pair.

Instances

Instances details

ToJSON Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods toJSON :: Filter -> Value # toEncoding :: Filter -> Encoding # toJSONList :: [Filter] -> Value # toEncodingList :: [Filter] -> Encoding #
Generic Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Associated Types type Rep Filter :: Type -> Type # Methods from :: Filter -> Rep Filter x # to :: Rep Filter x -> Filter #
Show Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods showsPrec :: Int -> Filter -> ShowS # show :: Filter -> String # showList :: [Filter] -> ShowS #
NFData Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods rnf :: Filter -> () #
Eq Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods (==) :: Filter -> Filter -> Bool # (/=) :: Filter -> Filter -> Bool #
Hashable Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter Methods hashWithSalt :: Int -> Filter -> Int # hash :: Filter -> Int #
type Rep Filter Source #
Instance details Defined in Amazonka.IdentityStore.Types.Filter type Rep Filter = D1 ('MetaData "Filter" "Amazonka.IdentityStore.Types.Filter" "amazonka-identitystore-2.0-FD6RUaLi6gx9YE16ATGTMj" 'False) (C1 ('MetaCons "Filter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "attributeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))

newFilter Source #

Arguments

:: Text	`$sel:attributePath:Filter'`
-> Text	`$sel:attributeValue:Filter'`
-> Filter

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:attributePath:Filter', filter_attributePath - The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

$sel:attributeValue:Filter', filter_attributeValue - Represents the data for an attribute. Each attribute value is described as a name-value pair.

filter_attributePath :: Lens' Filter Text Source #

The attribute path that is used to specify which attribute name to search. Length limit is 255 characters. For example, UserName is a valid attribute path for the ListUsers API, and DisplayName is a valid attribute path for the ListGroups API.

filter_attributeValue :: Lens' Filter Text Source #

Represents the data for an attribute. Each attribute value is described as a name-value pair.