You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
  values: ["__string"], # required
}

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

Instance Attribute Summary collapse

#attribute_type ⇒ String
The type of segment dimension to use.
#values ⇒ Array<String>
The criteria values to use for the segment dimension.

Instance Attribute Details

#attribute_type ⇒ `String`

The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

Returns:

(String)

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

class AttributeDimension < Struct.new(
  :attribute_type,
  :values)
  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.