Function identifyUser

  • identifyUser(params): Promise<void>

  • 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.

    Parameters

    • params: IdentifyUserInput

      The input object used to construct requests sent to Pinpoint's UpdateEndpoint API.

    Returns Promise<void>

    A promise that will resolve when the operation is complete.

    Throws

    service: UpdateEndpointException - Thrown when the underlying Pinpoint service returns an error.

    Throws

    validation: AnalyticsValidationErrorCode - Thrown when the provided parameters or library configuration is incorrect.

    Example

    // Identify a user with Pinpoint
    await identifyUser({
        userId,
        userProfile: {
            email: 'userEmail@example.com'
            customProperties: {
                phoneNumber: ['555-555-5555'],
            },
        }
    });

    Example

    // Identify a user with Pinpoint with some additional demographics
    await identifyUser({
        userId,
        userProfile: {
            email: 'userEmail@example.com'
            customProperties: {
                phoneNumber: ['555-555-5555'],
            },
            demographic: {
                platform: 'ios',
                timezone: 'America/Los_Angeles'
            }
        }
    });

Settings

Member Visibility

Theme