docs: add migration guide for Pinpoint-backed features - #8612
Merged
Conversation
ekjotmultani
marked this pull request as ready for review
July 27, 2026 14:44
harsh62
approved these changes
Jul 27, 2026
thisisabhash
approved these changes
Jul 27, 2026
|
Tick the box to add this pull request to the merge queue (same as
|
soberm
added a commit
that referenced
this pull request
Jul 29, 2026
Addresses inline review feedback from @thisisabhash on #8613: - Remove the unused `connectcampaignsv` cspell entry. It was the only occurrence of the string in the repo (the definition itself), so it added a dictionary word no page uses. Spellcheck still passes. - Add a Layout test case for a Customer Profiles push-notifications child route (.../customer-profiles/register-device/). The existing guard matches without a trailing slash so child routes are already handled correctly; this locks in that behaviour so a future refactor to an exact-path check cannot silently reintroduce the Pinpoint EOL banner on these pages. - Link the push notifications backend overview to the new Pinpoint migration guide, since many readers arrive from Pinpoint push. Also merges origin/main to bring in the pinpoint-migration page (#8612) so the new link resolves, keeping both nav entries in directory.mjs. The platform-scoping feedback on the build-a-backend/notifications pages is left unchanged pending a product decision; the Customer Profiles push client provider requires @aws-amplify/react-native, so expanding these pages to Swift/Android would advertise a client path that does not exist.
soberm
added a commit
that referenced
this pull request
Jul 30, 2026
* docs: add Amazon Connect Customer Profiles push notifications (backend + client) * docs: correct device-storage model, expand framework visibility, and fix push template authoring for Connect Customer Profiles push * docs: fix spellcheck and lint issues for Connect Customer Profiles push notifications * docs: rename push notifications nav items and hide Pinpoint EOL banner on Customer Profiles pages * docs: tidy prose in Customer Profiles push notifications pages * docs: simplify push message template matching explanation * docs: scope Customer Profiles push notifications to React Native only * docs: add permissions, device token, notification interaction, and badge count pages for Customer Profiles push * docs: address review feedback on Customer Profiles push notifications Addresses inline review feedback from @thisisabhash on #8613: - Remove the unused `connectcampaignsv` cspell entry. It was the only occurrence of the string in the repo (the definition itself), so it added a dictionary word no page uses. Spellcheck still passes. - Add a Layout test case for a Customer Profiles push-notifications child route (.../customer-profiles/register-device/). The existing guard matches without a trailing slash so child routes are already handled correctly; this locks in that behaviour so a future refactor to an exact-path check cannot silently reintroduce the Pinpoint EOL banner on these pages. - Link the push notifications backend overview to the new Pinpoint migration guide, since many readers arrive from Pinpoint push. Also merges origin/main to bring in the pinpoint-migration page (#8612) so the new link resolves, keeping both nav entries in directory.mjs. The platform-scoping feedback on the build-a-backend/notifications pages is left unchanged pending a product decision; the Customer Profiles push client provider requires @aws-amplify/react-native, so expanding these pages to Swift/Android would advertise a client path that does not exist. * docs: expand notification backend pages to all platforms Addresses review feedback from @thisisabhash on #8613: the four build-a-backend/add-aws-services/notifications/ pages were scoped to platforms: ['react-native'], so a Swift, Android, Flutter, or web developer landing on them got a 404 with no other page describing how to provision the resource. Nothing on these pages is React Native specific — defineNotifications, the apns/fcm channel config, the qconnect CLI template authoring, and the domainName attach mode are backend-only and identical for every client. Expand all four to the canonical nine-platform set used by the other build-a-backend pages (109 pages use this exact set). Verified with a full production build: all 36 routes (9 platforms x 4 pages) prerender, and every link on these pages resolves on all nine platforms except the client-library links, which remain React Native only and are reported separately. * docs: remove React Native only client links from notification backend pages The four build-a-backend/add-aws-services/notifications/ pages now build for all nine platforms, but they still linked to the push notifications client pages, which remain platforms: ['react-native']. Those links resolved only under /react-native/ and 404'd on the other eight platforms. - index.mdx: drop the trailing "To call the notification APIs from your application, see Push notifications" sentence. The preceding clause about amplify_outputs.json and Amplify.configure() is backend content and is kept. - set-up-notifications: drop the Push notifications bullet from "Next steps". The Author message templates bullet remains, so the section is still populated. - author-message-templates: reword the Attributes sentence to "including custom attributes set on the profile", removing the identifyUser link while keeping the sentence and the handlebars example it introduces. - author-message-templates: drop the "Next steps" section, whose only entry was the client link. The client pages stay registered in directory.mjs and still link back to these backend pages, so React Native readers keep both paths. Verified with a full production build: all 36 routes (9 platforms x 4 pages) prerender and zero references to /frontend/push-notifications/customer-profiles/ remain in any of them. * docs: bound the Pinpoint banner carve-out and align markdown tables Addresses review feedback from @osama-rizk on #8613. Layout.tsx: the Customer Profiles carve-out matched the unbounded substring '/push-notifications/customer-profiles', so a future sibling route such as '/push-notifications/customer-profiles-legacy/' would also have had the Pinpoint EOL banner silently suppressed. Anchor the match with a trailing slash. next.config sets trailingSlash: true, so both the overview route and its child routes still match. Layout.test.tsx: add a positive case asserting the banner still renders for a Gen 2 push-notifications route that is not Customer Profiles. This pins the over-matching boundary that the previous positive tests (gen1 and analytics) did not cover. Verified the test is meaningful: it fails against the old unbounded match and passes with the anchored one. interact-with-notifications: align the two markdown tables. Cell text is unchanged, padding only. No content or platform changes in this commit. The platform scope of the client pages is left as is pending confirmation.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Amazon Pinpoint reaches end of support on October 30, 2026, and the Pinpoint-backed Analytics and Push Notifications features in the Amplify libraries end support on the same date. The customer notification for this deprecation links to an Amplify migration guide that does not exist yet. This PR adds that guide.
New page:
/[platform]/build-a-backend/add-aws-services/pinpoint-migration(all platforms), registered in the navigation directory.The initial version covers:
@aws-amplify/backend-notificationsresource, updatingidentifyUsercalls to the new Customer Profiles provider, and letting profiles repopulate as users sign inCoordinated with the backend construct (aws-amplify/amplify-backend#3265) and the JS provider (aws-amplify/amplify-js#14866). This guide should merge once those are released; the detailed endpoint data workflow will follow in later PRs.
Checks