Class: Aws::Pinpoint::Types::AttributeDimension

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::AttributeDimension

show all

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

Overview

Note:

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

{
  attribute_type: "INCLUSIVE", # accepts INCLUSIVE, EXCLUSIVE, CONTAINS, BEFORE, AFTER, BETWEEN, ON
  values: ["__string"], # required
}

Specifies attribute-based criteria for including or excluding endpoints from a segment.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attribute_type ⇒ String
- INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
#values ⇒ Array<String>
The criteria values to use for the segment dimension.

Instance Attribute Details

#attribute_type ⇒ `String`

INCLUSIVE - endpoints that have attributes matching the values are included in the segment.
EXCLUSIVE - endpoints that have attributes matching the values are excluded in the segment.
CONTAINS - endpoints that have attributes' substrings match the values are included in the segment.
BEFORE - endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
AFTER - endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
ON - endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
BETWEEN - endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.

Returns:

(String)

# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2052

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

#values ⇒ `Array<String>`

The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.