SearchField
A Field
of the channel that you want to search.
Note
This operation isn't supported for AppInstanceUsers
with a large number of memberships.
Contents
- 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 theEQUALS
operator to get channels whose memberships are equal to the specified values, and with theINCLUDES
operator to get channels whose memberships include the specified values.Type: String
Valid Values:
MEMBERS
Required: Yes
- Operator
-
The operator used to compare field values, currently
EQUALS
orINCLUDES
. Use theEQUALS
operator to find channels whose memberships equal the specified values. Use theINCLUDES
operator to find channels whose memberships include the specified values.Type: String
Valid Values:
EQUALS | INCLUDES
Required: Yes
- Values
-
The values that you want to search for, a list of strings. The values must be
AppInstanceUserArns
specified as a list of strings.Note
This operation isn't supported for
AppInstanceUsers
with a large number of memberships.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\s\S]*
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: