add changeset

.changeset/small-gorillas-remain.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/backend-cli': patch
+---
+
+throw user error when sandbox identifier validation fails

packages/cli/src/commands/sandbox/sandbox_command.test.ts

@@ -21,6 +21,7 @@ import { createSandboxSecretCommand } from './sandbox-secret/sandbox_secret_comm
 import { ClientConfigGeneratorAdapter } from '../../client-config/client_config_generator_adapter.js';
 import { CommandMiddleware } from '../../command_middleware.js';
 import { PackageManagerController } from '@aws-amplify/plugin-types';
+import { AmplifyUserError } from '@aws-amplify/platform-core';
 
 mock.method(fsp, 'mkdir', () => Promise.resolve());
 
@@ -121,6 +122,27 @@ void describe('sandbox command', () => {
     );
   });
 
+  void it('throws AmplifyUserError if invalid identifier is provided', async () => {
+    const invalidIdentifier = 'invalid@';
+    const invalidIdentifierError = new AmplifyUserError(
+      'InvalidCommandInputError',
+      {
+        message: `Invalid --identifier provided: ${invalidIdentifier}`,
+        resolution:
+          'Use an identifier that matches [a-zA-Z0-9-] and is less than 15 characters.',
+      }
+    );
+    await assert.rejects(
+      () =>
+        commandRunner.runCommand(`sandbox --identifier ${invalidIdentifier}`), // invalid identifier
+      (err: TestCommandError) => {
+        assert.deepStrictEqual(err.error, invalidIdentifierError);
+        return true;
+      }
+    );
+    assert.equal(sandboxStartMock.mock.callCount(), 0);
+  });
+
   void it('shows available options in help output', async () => {
     const output = await commandRunner.runCommand('sandbox --help');
     assert.match(output, /--identifier/);

packages/cli/src/commands/sandbox/sandbox_command.ts

@@ -21,6 +21,7 @@ import { CommandMiddleware } from '../../command_middleware.js';
 import { SandboxCommandGlobalOptions } from './option_types.js';
 import { ArgumentsKebabCase } from '../../kebab_case.js';
 import { PackageManagerController } from '@aws-amplify/plugin-types';
+import { AmplifyUserError } from '@aws-amplify/platform-core';
 
 export type SandboxCommandOptionsKebabCase = ArgumentsKebabCase<
   {
@@ -254,9 +255,11 @@ export class SandboxCommand
           if (argv.identifier) {
             const identifierRegex = /^[a-zA-Z0-9-]{1,15}$/;
             if (!argv.identifier.match(identifierRegex)) {
-              throw new Error(
-                `--identifier should match [a-zA-Z0-9-] and be less than 15 characters.`
-              );
+              throw new AmplifyUserError('InvalidCommandInputError', {
+                message: `Invalid --identifier provided: ${argv.identifier}`,
+                resolution:
+                  'Use an identifier that matches [a-zA-Z0-9-] and is less than 15 characters.',
+              });
             }
           }
           return true;