Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.EndpointUser

Description

Synopsis

data EndpointUser = EndpointUser' {
- userAttributes :: Maybe (HashMap Text [Text])
- userId :: Maybe Text
}
newEndpointUser :: EndpointUser
endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text]))
endpointUser_userId :: Lens' EndpointUser (Maybe Text)

Documentation

data EndpointUser Source #

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

See: newEndpointUser smart constructor.

Constructors

EndpointUser'

Fields

userAttributes :: Maybe (HashMap Text [Text])
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.
userId :: Maybe Text
The unique identifier for the user.

Instances

Instances details

Eq EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods (==) :: EndpointUser -> EndpointUser -> Bool # (/=) :: EndpointUser -> EndpointUser -> Bool #
Read EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods readsPrec :: Int -> ReadS EndpointUser # readList :: ReadS [EndpointUser] # readPrec :: ReadPrec EndpointUser # readListPrec :: ReadPrec [EndpointUser] #
Show EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods showsPrec :: Int -> EndpointUser -> ShowS # show :: EndpointUser -> String # showList :: [EndpointUser] -> ShowS #
Generic EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Associated Types type Rep EndpointUser :: Type -> Type # Methods from :: EndpointUser -> Rep EndpointUser x # to :: Rep EndpointUser x -> EndpointUser #
NFData EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods rnf :: EndpointUser -> () #
Hashable EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods hashWithSalt :: Int -> EndpointUser -> Int # hash :: EndpointUser -> Int #
ToJSON EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods toJSON :: EndpointUser -> Value # toEncoding :: EndpointUser -> Encoding # toJSONList :: [EndpointUser] -> Value # toEncodingList :: [EndpointUser] -> Encoding #
FromJSON EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser Methods parseJSON :: Value -> Parser EndpointUser # parseJSONList :: Value -> Parser [EndpointUser] #
type Rep EndpointUser Source #
Instance details Defined in Amazonka.Pinpoint.Types.EndpointUser type Rep EndpointUser = D1 ('MetaData "EndpointUser" "Amazonka.Pinpoint.Types.EndpointUser" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "EndpointUser'" 'PrefixI 'True) (S1 ('MetaSel ('Just "userAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :*: S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newEndpointUser :: EndpointUser Source #

Create a value of EndpointUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:userAttributes:EndpointUser', endpointUser_userAttributes - 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.

$sel:userId:EndpointUser', endpointUser_userId - The unique identifier for the user.

endpointUser_userAttributes :: Lens' EndpointUser (Maybe (HashMap Text [Text])) Source #

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.

endpointUser_userId :: Lens' EndpointUser (Maybe Text) Source #

The unique identifier for the user.