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.ChimeSDKMessaging.Types.SearchField

Description

Synopsis

Documentation

data SearchField Source #

A Field of the channel that you want to search.

See: newSearchField smart constructor.

Constructors

SearchField'

Fields

key :: SearchFieldKey
An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.
values :: NonEmpty Text
The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.
This operation isn't supported for AppInstanceUsers with large number of memberships.
operator :: SearchFieldOperator
The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.

Instances

Instances details

ToJSON SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods toJSON :: SearchField -> Value # toEncoding :: SearchField -> Encoding # toJSONList :: [SearchField] -> Value # toEncodingList :: [SearchField] -> Encoding #
Generic SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Associated Types type Rep SearchField :: Type -> Type # Methods from :: SearchField -> Rep SearchField x # to :: Rep SearchField x -> SearchField #
Read SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods readsPrec :: Int -> ReadS SearchField # readList :: ReadS [SearchField] # readPrec :: ReadPrec SearchField # readListPrec :: ReadPrec [SearchField] #
Show SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods showsPrec :: Int -> SearchField -> ShowS # show :: SearchField -> String # showList :: [SearchField] -> ShowS #
NFData SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods rnf :: SearchField -> () #
Eq SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods (==) :: SearchField -> SearchField -> Bool # (/=) :: SearchField -> SearchField -> Bool #
Hashable SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField Methods hashWithSalt :: Int -> SearchField -> Int # hash :: SearchField -> Int #
type Rep SearchField Source #
Instance details Defined in Amazonka.ChimeSDKMessaging.Types.SearchField type Rep SearchField = D1 ('MetaData "SearchField" "Amazonka.ChimeSDKMessaging.Types.SearchField" "amazonka-chime-sdk-messaging-2.0-BxY1AbjLoDB4AQUv82PCQZ" 'False) (C1 ('MetaCons "SearchField'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SearchFieldKey) :: (S1 ('MetaSel ('Just "values") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "operator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SearchFieldOperator))))

newSearchField Source #

Arguments

:: SearchFieldKey	`$sel:key:SearchField'`
-> NonEmpty Text	`$sel:values:SearchField'`
-> SearchFieldOperator	`$sel:operator:SearchField'`
-> SearchField

Create a value of SearchField 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:key:SearchField', searchField_key - An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

$sel:values:SearchField', searchField_values - The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

This operation isn't supported for AppInstanceUsers with large number of memberships.

$sel:operator:SearchField', searchField_operator - The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.

searchField_key :: Lens' SearchField SearchFieldKey Source #

An enum value that indicates the key to search the channel on. MEMBERS allows you to search channels based on memberships. You can use it with the EQUALS operator to get channels whose memberships are equal to the specified values, and with the INCLUDES operator to get channels whose memberships include the specified values.

searchField_values :: Lens' SearchField (NonEmpty Text) Source #

The values that you want to search for, a list of strings. The values must be AppInstanceUserArns specified as a list of strings.

This operation isn't supported for AppInstanceUsers with large number of memberships.

searchField_operator :: Lens' SearchField SearchFieldOperator Source #

The operator used to compare field values, currently EQUALS or INCLUDES. Use the EQUALS operator to find channels whose memberships equal the specified values. Use the INCLUDES operator to find channels whose memberships include the specified values.