Sends information about a user to Pinpoint. Sending user information allows you to associate a user to their user
profile and activities or actions in your application. Activity can be tracked across devices & platforms by using
the same userId.
The input object used to construct requests sent to Pinpoint's UpdateEndpoint API.
A promise that will resolve when the operation is complete.
service: UpdateEndpointException - Thrown when the underlying Pinpoint service returns an error.
validation: PushNotificationValidationErrorCode - Thrown when the provided parameters or library configuration is incorrect.
platform: PlatformNotSupportedError - Thrown if called against an unsupported platform. Currently, only React Native is supported by this API.
// Identify a user with Pinpoint
await identifyUser({
userId,
userProfile: {
email: 'userEmail@example.com'
customProperties: {
phoneNumber: ['555-555-5555'],
},
}
});
// Identify a user with Pinpoint specific options
await identifyUser({
userId,
userProfile: {
email: 'userEmail@example.com'
customProperties: {
phoneNumber: ['555-555-5555'],
},
demographic: {
platform: 'ios',
timezone: 'America/Los_Angeles'
}
},
options: {
address: 'device-address',
optOut: 'NONE',
userAttributes: {
interests: ['food']
},
},
The AmplifyContext to use for config and credentials.