API Reference

AWS will end support for Amazon Pinpoint on October 30, 2026,, and is no longer accepting any new users as of May 20 (see the linked doc). The guidance is to use AWS End User Messaging for push notifications and SMS, Amazon Simple Email Service for sending emails, Amazon Connect for campaigns, journeys, endpoints, and engagement analytics. Pinpoint recommends Amazon Kinesis for event collection and mobile analytics.

configureAutoTrack

Configures automatic event tracking for Pinpoint. This API will automatically transmit an analytic event when configured events are detected within your application. This can include: DOM element events (via the event tracker), session events (via the session tracker), and page view events (via the pageView tracker).

Parameters

Option	Required	Type	Description
`input`	true

Throws

service:UpdateEndpointException - Thrown when the underlying Pinpoint service returns an error.
validation:AnalyticsValidationErrorCode - Thrown when the provided parameters or library configuration is incorrect.

Returns

void

disable

Disables the Analytics category.

Returns

void

enable

Enables the Analytics category to permit the transmission of events.

Returns

void

flushEvents

Flushes all buffered Pinpoint events to the service.

Returns

void

identifyUser

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

Option	Required	Type	Description
`params`	true		The input object used to construct requests sent to Pinpoint's UpdateEndpoint API.

Throws

service:UpdateEndpointException - Thrown when the underlying Pinpoint service returns an error.
validation:AnalyticsValidationErrorCode - Thrown when the provided parameters or library configuration is incorrect.

Option	Required	Type	Description
`input`	true

Throws

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

Returns

void

Link Color Legend

Interface

Reference

Other