Class: Aws::CustomerProfiles::Types::ObjectFilter

Inherits:

Struct

Object
Struct
Aws::CustomerProfiles::Types::ObjectFilter

show all

Defined in:: gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Note:

When making an API call, you may pass ObjectFilter data as a hash:

{
  key_name: "name", # required
  values: ["string1To255"], # required
}

The filter applied to ListProfileObjects response to include profile objects with the specified index values. This filter is only supported for ObjectTypeName _asset, _case and _order.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#key_name ⇒ String
A searchable identifier of a standard profile object.
#values ⇒ Array<String>
A list of key values.

Instance Attribute Details

#key_name ⇒ `String`

A searchable identifier of a standard profile object. The predefined keys you can use to search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can use to search for _case include: _caseId. The predefined keys you can use to search for _order include: _orderId.

Returns:

(String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 3580

class ObjectFilter < Struct.new(
  :key_name,
  :values)
  SENSITIVE = []
  include Aws::Structure
end

#values ⇒ `Array<String>`

A list of key values.