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

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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-pinpoint/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 an end 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 an end user by associating a name with an array of values. For example, an attribute named "interests" might have the values ["science", "politics", "travel"]. You can use these attributes as selection criteria when you create a segment of users to engage with a messaging campaign. The following characters are not recommended in attribute names: # : ? \ /. The Amazon Pinpoint console does not display attributes that include these characters in the name. This limitation does not apply to attribute values.

Returns:

(Hash<String,Array<String>>)

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

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

#user_id ⇒ `String`

The unique ID of the user.