Use AWS SDK

Amplify iOS v1 is now in Maintenance Mode until May 31st, 2024. This means that we will continue to include updates to ensure compatibility with backend services and security. No new features will be introduced in v1.

Please use the latest version (v2) of Amplify Library for Swift to get started.

If you are currently using v1, follow these instructions to upgrade to v2.

Amplify libraries should be used for all new cloud connected applications. If you are currently using the AWS Mobile SDK for iOS, you can access the documentation here.

For advanced use cases where Amplify does not provide the functionality, you can retrieve the escape hatch to access the underlying Amazon Pinpoint client.

Add the following imports:

1import AWSPinpointAnalyticsPlugin // Imports the Amplify plugin interface
2import AWSPinpoint                // Imports the AWSPinpoint client escape hatch

1import AmplifyPlugins // Imports the Amplify plugin interface
2import AWSPinpoint    // Imports the AWSPinpoint client escape hatch

Then retrieve the escape hatch with this code:

1func getEscapeHatch() {
2    do {
3        let plugin = try Amplify.Analytics.getPlugin(for: "awsPinpointAnalyticsPlugin") as! AWSPinpointAnalyticsPlugin
4        let awsPinpoint = plugin.getEscapeHatch()
5    } catch {
6        print("Get escape hatch failed with error - \(error)")
7    }
8}

Use existing AWS resources

Data usage policy information