Class: Aws::Pinpoint::Types::EndpointUser

Inherits:

Struct

Object
Struct
Aws::Pinpoint::Types::EndpointUser

show all

Includes:: Structure

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

Overview

Note:

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

{
  user_attributes: {
    "__string" => ["__string"],
  },
  user_id: "__string",
}

Endpoint user specific custom userAttributes

Instance Attribute Summary collapse

#user_attributes ⇒ Hash<String,Array<String>>

Custom attributes that describe the user by associating a name with an array of values.
#user_id ⇒ String

The unique ID of the user.

Instance Attribute Details

#user_attributes ⇒ `Hash<String,Array<String>>`

Custom attributes that describe the user by associating a name with an array of values. For example, an attribute named “interests” might have the following values: [“science”, “politics”, “travel”]. You can use these attributes as selection criteria when you create segments. The Amazon Pinpoint console can’t display attribute names that include the following characters: hash/pound sign (#), colon (:), question mark (?), backslash (\), and forward slash (/). For this reason, you should avoid using these characters in the names of custom attributes.

Returns:

(Hash<String,Array<String>>)

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

class EndpointUser < Struct.new(
  :user_attributes,
  :user_id)
  include Aws::Structure
end

#user_id ⇒ `String`

The unique ID of the user.