Merge remote-tracking branch 'origin/main' into pre-prod/main

Author: aws-amplify-bot

src/pages/[platform]/build-a-backend/add-aws-services/rest-api/set-up-rest-api/index.mdx

@@ -204,6 +204,13 @@ npm add aws-amplify @aws-amplify/react-native
 ## Initialize Amplify API
 
 <InlineFilter filters={['javascript', "angular", "react", "vue", "react-native", "nextjs"]}>
+
+<Callout info="true">
+
+**Important**: Custom REST APIs require explicit configuration. Unlike built-in Amplify resources (Auth, Data), custom APIs are not automatically included when calling `Amplify.configure(outputs)`.
+
+</Callout>
+
 To initialize the Amplify API category you need to configure Amplify with `Amplify.configure()`.
 
 Import and load the configuration file in your app. It's recommended you add the Amplify configuration step to your app's root entry point. For example `index.js` in React or `main.ts` in Angular.
@@ -221,7 +228,7 @@ Amplify.configure(
     ...amplifyConfig,
     API: {
       ...amplifyConfig.API,
-      REST: outputs.custom.API,
+      REST: outputs.custom.API, // ← Required for custom REST APIs
     },
   },
   {
@@ -250,7 +257,7 @@ Amplify.configure(
     ...amplifyConfig,
     API: {
       ...amplifyConfig.API,
-      REST: outputs.custom.API,
+      REST: outputs.custom.API, // ← Required for custom REST APIs
     },
   }, 
   {
@@ -271,4 +278,40 @@ Amplify.configure(
 Make sure you call `Amplify.configure` as early as possible in your application’s life-cycle. A missing configuration or `NoCredentials` error is thrown if `Amplify.configure` has not been called before other Amplify JavaScript APIs. Review the [Library Not Configured Troubleshooting guide](/[platform]/build-a-backend/troubleshooting/library-not-configured/) for possible causes of this issue.
 
 </Callout>
+
+<Callout warning="true">
+
+**Critical Configuration Step**: The line `REST: outputs.custom.API` is **required** to register your custom REST API. Without this, you'll encounter the error `API name is invalid` when trying to call your API.
+
+</Callout>
+
+## Troubleshooting
+
+### "API name is invalid" Error
+
+If you encounter the error `API name is invalid` when calling your REST API, ensure you have:
+
+1. **Added the custom API configuration**: Include `REST: outputs.custom.API` in your `Amplify.configure()` call
+2. **Used the correct API name**: The API name should match the `restApiName` defined in your `backend.ts` file
+3. **Called `Amplify.configure()`**: Make sure configuration happens before any API calls
+
+**Example of incorrect configuration** (missing custom API):
+```javascript
+// ❌ This will cause "API name is invalid" error
+Amplify.configure(outputs); // Missing custom REST API configuration
+```
+
+**Correct configuration**:
+```javascript
+// ✅ This includes custom REST APIs
+const amplifyConfig = parseAmplifyConfig(outputs);
+Amplify.configure({
+  ...amplifyConfig,
+  API: {
+    ...amplifyConfig.API,
+    REST: outputs.custom.API, // Required for custom APIs
+  },
+});
+```
+
 </InlineFilter>

src/pages/[platform]/build-a-backend/data/connect-event-api/index.mdx

@@ -346,146 +346,11 @@ let authorizer = AuthTokenAuthorizer(fetchLatestAuthToken: getUserPoolAccessToke
 
 #### AWS IAM
 
-If you are using Amplify Auth, you can use the following class to implement SigV4 signing logic:
-
-```swift
-import Foundation
-import Amplify 
-import AWSPluginsCore 
-import AwsCommonRuntimeKit 
-import AWSSDKHTTPAuth 
-import Smithy 
-import SmithyHTTPAPI
-import SmithyHTTPAuth
-import SmithyHTTPAuthAPI
-import SmithyIdentity
-
-class AppSyncEventsSigner {
-    
-    public static func createAppSyncSigner(region: String) -> ((URLRequest) async throws -> URLRequest) {
-        return { request in
-            try await signAppSyncRequest(request,
-                                         region: region)
-        }
-    }
-    
-    private static var signer = {
-        return AWSSigV4Signer()
-    }()
-    
-    static func signAppSyncRequest(_ urlRequest: URLRequest,
-                                   region: Swift.String,
-                                   signingName: Swift.String = "appsync",
-                                   date: Date = Date()) async throws -> URLRequest {
-        CommonRuntimeKit.initialize()
-        
-        // Convert URLRequest to SDK's HTTPRequest
-        guard let requestBuilder = try createAppSyncSdkHttpRequestBuilder(
-            urlRequest: urlRequest) else {
-            return urlRequest
-        }
-        
-        // Retrieve the credentials from credentials provider
-        let credentials: AWSCredentialIdentity
-        let authSession = try await Amplify.Auth.fetchAuthSession()
-        if let awsCredentialsProvider = authSession as? AuthAWSCredentialsProvider {
-            let awsCredentials = try awsCredentialsProvider.getAWSCredentials().get()
-            credentials = try awsCredentials.toAWSSDKCredentials()
-        } else {
-            let error = AuthError.unknown("Auth session does not include AWS credentials information")
-            throw error
-        }
-        
-        // Prepare signing
-        let flags = SigningFlags(useDoubleURIEncode: true,
-                                 shouldNormalizeURIPath: true,
-                                 omitSessionToken: false)
-        let signedBodyHeader: AWSSignedBodyHeader = .none
-        let signedBodyValue: AWSSignedBodyValue = .empty
-        let signingConfig = AWSSigningConfig(credentials: credentials,
-                                             signedBodyHeader: signedBodyHeader,
-                                             signedBodyValue: signedBodyValue,
-                                             flags: flags,
-                                             date: date,
-                                             service: signingName,
-                                             region: region,
-                                             signatureType: .requestHeaders,
-                                             signingAlgorithm: .sigv4)
-        
-        // Sign request
-        guard let httpRequest = await signer.sigV4SignedRequest(
-            requestBuilder: requestBuilder,
-            signingConfig: signingConfig
-        ) else {
-            return urlRequest
-        }
-        
-        // Update original request with new headers
-        return setHeaders(from: httpRequest, to: urlRequest)
-    }
-    
-    static func setHeaders(from sdkRequest: SmithyHTTPAPI.HTTPRequest, to urlRequest: URLRequest) -> URLRequest {
-        var urlRequest = urlRequest
-        for header in sdkRequest.headers.headers {
-            urlRequest.setValue(header.value.joined(separator: ","), forHTTPHeaderField: header.name)
-        }
-        return urlRequest
-    }
-    
-    static func createAppSyncSdkHttpRequestBuilder(urlRequest: URLRequest) throws -> HTTPRequestBuilder? {
-        
-        guard let url = urlRequest.url,
-              let host = url.host else {
-            return nil
-        }
-        
-        let headers = urlRequest.allHTTPHeaderFields ?? [:]
-        let httpMethod = (urlRequest.httpMethod?.uppercased())
-            .flatMap(HTTPMethodType.init(rawValue:)) ?? .get
-        
-        let queryItems = URLComponents(url: url, resolvingAgainstBaseURL: false)?.queryItems?
-            .map { URIQueryItem(name: $0.name, value: $0.value)} ?? []
-        
-        let requestBuilder = HTTPRequestBuilder()
-            .withHost(host)
-            .withPath(url.path)
-            .withQueryItems(queryItems)
-            .withMethod(httpMethod)
-            .withPort(443)
-            .withProtocol(.https)
-            .withHeaders(.init(headers))
-            .withBody(.data(urlRequest.httpBody))
-        
-        return requestBuilder
-    }
-}
-
-extension AWSPluginsCore.AWSCredentials {
-    
-    func toAWSSDKCredentials() throws -> AWSCredentialIdentity {
-        if let tempCredentials = self as? AWSTemporaryCredentials {
-            return AWSCredentialIdentity(
-                accessKey: tempCredentials.accessKeyId,
-                secret: tempCredentials.secretAccessKey,
-                expiration: tempCredentials.expiration,
-                sessionToken: tempCredentials.sessionToken
-            )
-        } else {
-            return AWSCredentialIdentity(
-                accessKey: accessKeyId,
-                secret: secretAccessKey,
-                expiration: nil
-            )
-        }
-    }
-}
-```
-
-Then, create an `IAMAuthorizer` with this helper class.
+If you are using Amplify Auth, you can initialize `IAMAuthorizer` with a helper method from `AWSCognitoAuthPlugin` like below:
 
 ```swift
 let authorizer = IAMAuthorizer(
-  signRequest: AppSyncEventsSigner.createAppSyncSigner(region: "region")
+  signRequest: AWSCognitoAuthPlugin.createAppSyncSigner(region: "region")
 )
 ```
 

src/pages/[platform]/build-a-backend/troubleshooting/cannot-find-module-amplify-env/index.mdx

@@ -2,10 +2,12 @@ import { getCustomStaticPath } from '@/utils/getCustomStaticPath';
 
 export const meta = {
   title: 'Troubleshoot "Cannot find module $amplify/env/<function-name>"',
-  description: 'Addressing "Cannot find module $amplify/env/<function-name>" error message',
+  description:
+    'Addressing "Cannot find module $amplify/env/<function-name>" error message',
   platforms: [
     'angular',
     'javascript',
+    'flutter',
     'nextjs',
     'react',
     'react-native',
@@ -25,7 +27,7 @@ export function getStaticProps(context) {
   };
 }
 
-<InlineFilter filters={["javascript",  "react-native", "angular", "nextjs", "react"]}>
+<InlineFilter filters={["javascript",  "react-native", "angular", "flutter", "nextjs", "react"]}>
 
 When deploying a Amplify Gen 2 app, you may encounter the error message `Cannot find module $amplify/env/<function-name>` in your frontend build on Amplify Console. This error occurs when your framework `tsconfig.json` configuration picks up the `amplify` directory and tries to resolve it as a module. This module is a placeholder for environment variables that are injected at build time by Amplify. To resolve this error, you need to exclude the `amplify` directory.
 
@@ -54,7 +56,6 @@ Alternatively, if you work within a monorepo you can move your backend to its ow
 
 </InlineFilter>
 
-
 <InlineFilter filters={["vue"]}>
 
 When deploying a Amplify Gen 2 app, you may encounter the error message `Cannot find module $amplify/env/<function-name>` in your frontend build on Amplify Console. This error occurs when your framework `tsconfig.json` configuration picks up the `amplify` directory and tries to resolve it as a module. This module is a placeholder for environment variables that are injected at build time by Amplify. To resolve this error, you will need to include the `resource.ts` files in your `tsconfig.app.json` file.