Classify pointing client config generator at metadata-less stack as user error (#2024)

Author: Kamil Sobol

.changeset/poor-owls-listen.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/client-config': patch
+---
+
+Classify pointing client config generator at metadata-less stack as user error

packages/client-config/src/unified_client_config_generator.test.ts

@@ -449,6 +449,39 @@ void describe('UnifiedClientConfigGenerator', () => {
       );
     });
 
+    void it('throws user error if the stack is missing metadata', async () => {
+      const outputRetrieval = mock.fn(() => {
+        throw new BackendOutputClientError(
+          BackendOutputClientErrorType.METADATA_RETRIEVAL_ERROR,
+          'Stack template metadata is not a string'
+        );
+      });
+      const modelSchemaAdapter = new ModelIntrospectionSchemaAdapter(
+        stubClientProvider
+      );
+
+      const configContributors = new ClientConfigContributorFactory(
+        modelSchemaAdapter
+      ).getContributors('1.1');
+
+      const clientConfigGenerator = new UnifiedClientConfigGenerator(
+        outputRetrieval,
+        configContributors
+      );
+
+      await assert.rejects(
+        () => clientConfigGenerator.generateClientConfig(),
+        (error: AmplifyUserError) => {
+          assert.strictEqual(
+            error.message,
+            'Stack was not created with Amplify.'
+          );
+          assert.ok(error.resolution);
+          return true;
+        }
+      );
+    });
+
     void it('throws user error if credentials are expired when getting backend outputs', async () => {
       const outputRetrieval = mock.fn(() => {
         throw new BackendOutputClientError(

packages/client-config/src/unified_client_config_generator.ts

@@ -66,6 +66,20 @@ export class UnifiedClientConfigGenerator implements ClientConfigGenerator {
           error
         );
       }
+      if (
+        error instanceof BackendOutputClientError &&
+        error.code === BackendOutputClientErrorType.METADATA_RETRIEVAL_ERROR
+      ) {
+        throw new AmplifyUserError(
+          'NonAmplifyStackError',
+          {
+            message: 'Stack was not created with Amplify.',
+            resolution:
+              'Ensure the CloudFormation stack ID references a main stack created with Amplify, then re-run this command.',
+          },
+          error
+        );
+      }
       if (
         error instanceof BackendOutputClientError &&
         error.code === BackendOutputClientErrorType.CREDENTIALS_ERROR