docs(client-amplify): This doc-only update identifies fields that are…

… specific to Gen 1 and Gen 2 applications.
aws · Jun 3, 2024 · 813c1f6 · 813c1f6
1 parent aeca658
commit 813c1f6
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 29 deletions.
diff --git a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts
@@ -30,8 +30,8 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
  * <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
+ *             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>
  * @example

diff --git a/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts
@@ -29,9 +29,9 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
 /**
  * <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
+ *             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>
  * @example

diff --git a/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts
@@ -29,9 +29,9 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
 /**
  * <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
+ *             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>
  * @example

diff --git a/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts
@@ -29,9 +29,9 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
 /**
  * <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
+ *             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>
  * @example

diff --git a/clients/client-amplify/src/models/models_0.ts b/clients/client-amplify/src/models/models_0.ts
@@ -668,7 +668,10 @@ export interface CreateBackendEnvironmentRequest {
 }
 
 /**
- * <p>Describes the backend environment for an Amplify app. </p>
+ * <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>
  * @public
  */
 export interface BackendEnvironment {
@@ -745,8 +748,11 @@ export class NotFoundException extends __BaseException {
 }
 
 /**
- * <p>Describes the backend properties associated with an Amplify
+ * <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>
  * @public
  */
 export interface Backend {
@@ -870,15 +876,21 @@ export interface CreateBranchRequest {
   pullRequestEnvironmentName?: string;
 
   /**
-   * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
+   * <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>
    * @public
    */
   backendEnvironmentArn?: string;
 
   /**
    * <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>
    * @public
    */
   backend?: Backend;
@@ -1052,15 +1064,20 @@ export interface Branch {
   sourceBranch?: string;
 
   /**
-   * <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
-   *             app. </p>
+   * <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>
    * @public
    */
   backendEnvironmentArn?: string;
 
   /**
-   * <p>Describes the backend properties associated with an Amplify
+   * <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>
    * @public
    */
   backend?: Backend;
@@ -3041,15 +3058,21 @@ export interface UpdateBranchRequest {
   pullRequestEnvironmentName?: string;
 
   /**
-   * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
+   * <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>
    * @public
    */
   backendEnvironmentArn?: string;
 
   /**
    * <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>
    * @public
    */
   backend?: Backend;

diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json
@@ -1436,7 +1436,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Describes the backend properties associated with an Amplify\n            <code>Branch</code>.</p>"
+        "smithy.api#documentation": "<p>Describes the backend associated with an Amplify\n            <code>Branch</code>.</p>\n         <p>This property is available to Amplify Gen 2 apps only. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>"
       }
     },
     "com.amazonaws.amplify#BackendEnvironment": {
@@ -1484,7 +1484,7 @@
         }
       },
       "traits": {
-        "smithy.api#documentation": "<p>Describes the backend environment for an Amplify app. </p>"
+        "smithy.api#documentation": "<p>Describes the backend environment associated with a <code>Branch</code> of a Gen 1\n                Amplify app. Amplify Gen 1 applications are created\n            using Amplify Studio or the Amplify command line\n            interface (CLI).</p>"
       }
     },
     "com.amazonaws.amplify#BackendEnvironmentArn": {
@@ -1706,7 +1706,7 @@
         "backendEnvironmentArn": {
           "target": "com.amazonaws.amplify#BackendEnvironmentArn",
           "traits": {
-            "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n            app. </p>"
+            "smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>\n         <p>This property is available to Amplify Gen 1 apps only. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>"
           }
         },
         "backend": {
@@ -2082,7 +2082,7 @@
         }
       ],
       "traits": {
-        "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#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 Amplify Gen 2 applications. \n            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",
@@ -2290,13 +2290,13 @@
         "backendEnvironmentArn": {
           "target": "com.amazonaws.amplify#BackendEnvironmentArn",
           "traits": {
-            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n            app. </p>"
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n            app. </p>\n         <p>This field is available to Amplify Gen 1 apps only where the\n            backend is created using Amplify Studio or the Amplify\n            command line interface (CLI).</p>"
           }
         },
         "backend": {
           "target": "com.amazonaws.amplify#Backend",
           "traits": {
-            "smithy.api#documentation": "<p>The backend for a <code>Branch</code> of an Amplify app. Use for a\n            backend created from an CloudFormation stack.</p>"
+            "smithy.api#documentation": "<p>The backend for a <code>Branch</code> of an Amplify app. Use for a\n            backend created from an CloudFormation stack.</p>\n         <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>"
           }
         }
       },
@@ -2787,7 +2787,7 @@
         }
       ],
       "traits": {
-        "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#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 is created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n            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>\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#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 is created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n            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>\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#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 is created using Amplify Studio or the Amplify\n            command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. \n            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",
@@ -6324,13 +6324,13 @@
         "backendEnvironmentArn": {
           "target": "com.amazonaws.amplify#BackendEnvironmentArn",
           "traits": {
-            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n            app. </p>"
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n            app. </p>\n         <p>This field is available to Amplify Gen 1 apps only where the\n            backend is created using Amplify Studio or the Amplify\n            command line interface (CLI).</p>"
           }
         },
         "backend": {
           "target": "com.amazonaws.amplify#Backend",
           "traits": {
-            "smithy.api#documentation": "<p>The backend for a <code>Branch</code> of an Amplify app. Use for a\n            backend created from an CloudFormation stack.</p>"
+            "smithy.api#documentation": "<p>The backend for a <code>Branch</code> of an Amplify app. Use for a\n            backend created from an CloudFormation stack.</p>\n         <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with\n            Amplify Gen 2, you provision the app's backend infrastructure using Typescript\n            code.</p>"
           }
         }
       },