Welcome to the documentation for AWS PushManager, a powerful tool for sending push notifications in your iOS apps. Whether you are new to push notifications or experienced with implementing them, this guide will provide you with detailed instructions and best practices to get started with AWS PushManager.

Table of Contents


In order to get started with AWS PushManager, you need to install it in your iOS project by following these steps:

  1. Open your project in Xcode.
  2. Navigate to the “File” menu and select “Swift Packages” → “Add Package Dependency”.
  3. In the text field, paste the following URL: ``. Click “Next”.
  4. Select the version or branch you want to use and click “Finish”.
  5. After the package is added successfully, you can import AWS PushManager in your code files.


Once AWS PushManager is installed, you need to configure it to work with your AWS account. Follow these steps to perform the configuration:

  1. Open your project’s AppDelegate file.
  2. Add the following code inside the `didFinishLaunchingWithOptions` method:
import AWSPushManager // ... other code ... func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool { // ... your existing code ... AWSPushManager.shared.configure(appId: "YOUR_AWS_APP_ID", privateKey: "YOUR_PRIVATE_KEY", teamId: "YOUR_TEAM_ID", publicKeyId: "YOUR_PUBLIC_KEY_ID") // ... your existing code ... return true }

Note: Replace the placeholders (`YOUR_AWS_APP_ID`, `YOUR_PRIVATE_KEY`, `YOUR_TEAM_ID`, `YOUR_PUBLIC_KEY_ID`) with your actual AWS App ID and credentials.

Notification Setup

To enable push notifications in your app, you need to configure the necessary settings in the AWS Management Console and your Xcode project:

  1. Create an App ID in the Apple Developer Portal that supports push notifications and note down the App ID.
  2. Set up a provisioning profile for your app in the Apple Developer Portal that includes the necessary entitlements for push notifications and download it.
  3. In the AWS Management Console, navigate to the AWS SNS service and create a platform application.
  4. Enter the App ID and upload the provisioning profile you downloaded.
  5. Copy the Application ARN provided by AWS SNS and save it for later use.
  6. In Xcode, open your project and go to the “Signing & Capabilities” tab.
  7. Enable the “Push Notifications” capability and select your team.
  8. Paste the Application ARN you saved earlier in the “Key” field.
  9. Build and run your app on a physical device to test push notifications.

Sending Push Notifications

With AWS PushManager, sending push notifications to your iOS app is simplified. The following steps outline the process:

  1. Ensure your app has successfully registered for push notifications by calling `AWSPushManager.shared.registerForPushNotifications()`.
  2. Use the `AWSPushManager.shared.sendPushNotification` method to send push notifications to one or more devices. Provide the device tokens and the notification payload.
  3. Handle the success or failure callback using the `AWSPushManagerDelegate` methods.

Handling Received Notifications

When your app receives a push notification, you can customize the behavior by following these steps:

  1. Implement the `UNUserNotificationCenterDelegate` protocol for handling notification events.
  2. Call `AWSPushManager.shared.processNotification(with: response)` from the `userNotificationCenter(_:didReceive:withCompletionHandler:)` delegate method to handle the notification.

Frequently Asked Questions

Here are some answers to frequently asked questions about AWS PushManager:

How do I handle foreground notifications?

You can customize the behavior for foreground push notifications by implementing the `AWSPushManagerDelegate` method `didReceiveForegroundNotification(payload:)` in your AppDelegate or in an appropriate view controller.

Can I send silent (background) push notifications?

Yes, you can send silent push notifications to wake your app in the background and perform tasks. Use the `AWSPushManagerDelegate` method `didReceiveSilentNotification(payload:)` to handle silent notifications.

How can I personalize push notifications?

AWS PushManager allows you to include custom data in your push notification payload. Use this data to personalize notifications for your app users.

How can I track the delivery status of push notifications?

AWS provides event tracking and analytics for push notifications through Amazon Pinpoint. You can integrate with Pinpoint to track delivery status, engagements, and other metrics.