AWS Amplify Update: This doc-only update identifies fields that are specific to Gen 1 and Gen 2 applications.

AWS · AWS · commit 9ff881bb317e · 2024-06-03T18:11:32.000Z
diff --git a/.changes/next-release/feature-AWSAmplify-60aeac3.json b/.changes/next-release/feature-AWSAmplify-60aeac3.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS Amplify",
+    "contributor": "",
+    "description": "This doc-only update identifies fields that are specific to Gen 1 and Gen 2 applications."
+}
diff --git a/services/amplify/src/main/resources/codegen-resources/service-2.json b/services/amplify/src/main/resources/codegen-resources/service-2.json
@@ -46,7 +46,7 @@
         {"shape":"InternalFailureException"},
         {"shape":"LimitExceededException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<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 Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
     },
     "CreateBranch":{
       "name":"CreateBranch",
@@ -150,7 +150,7 @@
         {"shape":"InternalFailureException"},
         {"shape":"DependentServiceFailureException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<p>Deletes a 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 Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
     },
     "DeleteBranch":{
       "name":"DeleteBranch",
@@ -283,7 +283,7 @@
         {"shape":"NotFoundException"},
         {"shape":"InternalFailureException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<p>Returns a 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 Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
     },
     "GetBranch":{
       "name":"GetBranch",
@@ -395,7 +395,7 @@
         {"shape":"UnauthorizedException"},
         {"shape":"InternalFailureException"}
       ],
-      "documentation":"<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>"
+      "documentation":"<p>Lists the backend environments 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 Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
     },
     "ListBranches":{
       "name":"ListBranches",
@@ -892,7 +892,7 @@
           "documentation":"<p>The Amazon Resource Name (ARN) for the CloudFormation stack.</p>"
         }
       },
-      "documentation":"<p>Describes the backend properties associated with an Amplify <code>Branch</code>.</p>"
+      "documentation":"<p>Describes the backend associated with an Amplify <code>Branch</code>.</p> <p>This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
     },
     "BackendEnvironment":{
       "type":"structure",
@@ -928,7 +928,7 @@
           "documentation":"<p>The last updated date and time for a backend environment that is part of an Amplify app. </p>"
         }
       },
-      "documentation":"<p>Describes the backend environment for an Amplify app. </p>"
+      "documentation":"<p>Describes the backend environment associated with a <code>Branch</code> of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI).</p>"
     },
     "BackendEnvironmentArn":{
       "type":"string",
@@ -1083,7 +1083,7 @@
         },
         "backendEnvironmentArn":{
           "shape":"BackendEnvironmentArn",
-          "documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
+          "documentation":"<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p> <p>This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
         },
         "backend":{"shape":"Backend"}
       },
@@ -1391,11 +1391,11 @@
         },
         "backendEnvironmentArn":{
           "shape":"BackendEnvironmentArn",
-          "documentation":"<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
+          "documentation":"<p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. </p> <p>This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).</p>"
         },
         "backend":{
           "shape":"Backend",
-          "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p>"
+          "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
         }
       },
       "documentation":"<p> The request structure for the create branch request. </p>"
@@ -3367,11 +3367,11 @@
         },
         "backendEnvironmentArn":{
           "shape":"BackendEnvironmentArn",
-          "documentation":"<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
+          "documentation":"<p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. </p> <p>This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).</p>"
         },
         "backend":{
           "shape":"Backend",
-          "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p>"
+          "documentation":"<p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p> <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.</p>"
         }
       },
       "documentation":"<p>The request structure for the update branch request. </p>"
