Class: Aws::ChimeSDKMessaging::Types::SearchField

Inherits:

Struct

• Object
• Struct
• Aws::ChimeSDKMessaging::Types::SearchField

Defined in:

gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb

Overview

A Field of the channel that you want to search.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #key ⇒ String

  An enum value that indicates the key to search the channel on.

• #operator ⇒ String

  The operator used to compare field values, currently EQUALS or INCLUDES.

• #values ⇒ Array<String>

  The values that you want to search for, a list of strings.

Instance Attribute Details

#key ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2945

class SearchField < Struct.new(
  :key,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end

#operator ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2945

class SearchField < Struct.new(
  :key,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ Array<String>

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 a large number of memberships.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-chimesdkmessaging/lib/aws-sdk-chimesdkmessaging/types.rb', line 2945

class SearchField < Struct.new(
  :key,
  :values,
  :operator)
  SENSITIVE = []
  include Aws::Structure
end