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",
}

Specifies data for one or more attributes that describe the user who's associated with an endpoint.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#user_attributes ⇒ Hash<String,Array<String>>
One or more custom attributes that describe the user by associating a name with an array of values.
#user_id ⇒ String
The unique identifier for the user.

Instance Attribute Details

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

One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive.

An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.

Returns:

(Hash<String,Array<String>>)

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

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

#user_id ⇒ `String`

The unique identifier for the user.