Page updated Nov 14, 2023


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're looking for, you can retrieve the escape hatch to access the underlying SDK.

The escape hatch provides access to the underlying AWSMobileClient instance.

1import AWSCognitoAuthPlugin // Imports the Amplify plugin interface
1import AmplifyPlugins // Imports the Amplify plugin interface

Then retrieve the escape hatch with this code:

1func getEscapeHatch() {
2 do {
3 let plugin = try Amplify.Auth.getPlugin(for: "awsCognitoAuthPlugin") as! AWSCognitoAuthPlugin
4 guard case let .awsMobileClient(awsmobileclient) = plugin.getEscapeHatch() else {
5 print("Failed to fetch escape hatch")
6 return
7 }
8 print("Fetched escape hatch - \(awsmobileclient)")
9 } catch {
10 print("Error occurred while fetching the escape hatch \(error)")
11 }

It is not recommended to useAWSMobileClient credentials apis like getToken, getAWSCredentials through the escape hatch object.

You can use the escape hatch to federatedSignIn with a valid token from other social providers. Find more details here

2 token: "<APPLE_TOKEN_HERE>") { (userState, error) in
3 if let error = error {
4 print("Error in federatedSignIn: \(error)")
5 return
6 }
8 guard let userState = userState else {
9 print("userState unexpectedly nil")
10 return
11 }
12 print("federatedSignIn successful: \(userState)")