docs(client-amplify): Documentation updates for Amplify. Identifies t…

…he APIs available only to apps created using Amplify Gen 1.
aws · Mar 14, 2024 · 07675a9 · 07675a9
1 parent 6a6d341
commit 07675a9
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 4 deletions.
diff --git a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts
@@ -29,6 +29,12 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
 /**
  * @public
  * <p>Creates a new backend environment for an Amplify app. </p>
+ *          <p>This API is available only to Amplify Gen 1 applications where the
+ *             backend is created using Amplify Studio or the Amplify
+ *             command line interface (CLI). This API isn’t available to applications created using the
+ *             Amplify Gen 2 public preview. When you deploy an application with
+ *             Amplify Gen 2, you provision the app's backend infrastructure using Typescript
+ *             code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts
@@ -29,6 +29,12 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
 /**
  * @public
  * <p>Deletes a backend environment for an Amplify app. </p>
+ *          <p>This API is available only to Amplify Gen 1 applications where the
+ *             backend was created using Amplify Studio or the Amplify
+ *             command line interface (CLI). This API isn’t available to applications created using the
+ *             Amplify Gen 2 public preview. When you deploy an application with
+ *             Amplify Gen 2, you provision the app's backend infrastructure using Typescript
+ *             code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts
@@ -29,6 +29,12 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
 /**
  * @public
  * <p>Returns a backend environment for an Amplify app. </p>
+ *          <p>This API is available only to Amplify Gen 1 applications where the
+ *             backend was created using Amplify Studio or the Amplify
+ *             command line interface (CLI). This API isn’t available to applications created using the
+ *             Amplify Gen 2 public preview. When you deploy an application with
+ *             Amplify Gen 2, you provision the app's backend infrastructure using Typescript
+ *             code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts
@@ -29,6 +29,12 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
 /**
  * @public
  * <p>Lists the backend environments for an Amplify app. </p>
+ *          <p>This API is available only to Amplify Gen 1 applications where the
+ *             backend was created using Amplify Studio or the Amplify
+ *             command line interface (CLI). This API isn’t available to applications created using the
+ *                 Amplify Gen 2 public preview. When you deploy an application with
+ *             Amplify Gen 2, you provision the app's backend infrastructure using Typescript
+ *             code.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json
@@ -2082,7 +2082,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Creates a new backend environment for an Amplify app. </p>",
+        "smithy.api#documentation": "<p>Creates a new backend environment for an Amplify app. </p>\n         <p>This API is available only to Amplify Gen 1 applications where the\n            backend is created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to applications created using the\n            Amplify Gen 2 public preview. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>",
         "smithy.api#http": {
           "method": "POST",
           "uri": "/apps/{appId}/backendenvironments",
@@ -2787,7 +2787,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Deletes a backend environment for an Amplify app. </p>",
+        "smithy.api#documentation": "<p>Deletes a backend environment for an Amplify app. </p>\n         <p>This API is available only to Amplify Gen 1 applications where the\n            backend was created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to applications created using the\n            Amplify Gen 2 public preview. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>",
         "smithy.api#http": {
           "method": "DELETE",
           "uri": "/apps/{appId}/backendenvironments/{environmentName}",
@@ -3719,7 +3719,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Returns a backend environment for an Amplify app. </p>",
+        "smithy.api#documentation": "<p>Returns a backend environment for an Amplify app. </p>\n         <p>This API is available only to Amplify Gen 1 applications where the\n            backend was created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to applications created using the\n            Amplify Gen 2 public preview. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/apps/{appId}/backendenvironments/{environmentName}",
@@ -4497,7 +4497,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Lists the backend environments for an Amplify app. </p>",
+        "smithy.api#documentation": "<p>Lists the backend environments for an Amplify app. </p>\n         <p>This API is available only to Amplify Gen 1 applications where the\n            backend was created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to applications created using the\n                Amplify Gen 2 public preview. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>",
         "smithy.api#http": {
           "method": "GET",
           "uri": "/apps/{appId}/backendenvironments",