Skip to content

Commit 813c1f6

Browse files
author
awstools
committed
docs(client-amplify): This doc-only update identifies fields that are specific to Gen 1 and Gen 2 applications.
1 parent aeca658 commit 813c1f6

File tree

6 files changed

+52
-29
lines changed

6 files changed

+52
-29
lines changed

clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
3030
* <p>Creates a new backend environment for an Amplify app. </p>
3131
* <p>This API is available only to Amplify Gen 1 applications where the
3232
* backend is created using Amplify Studio or the Amplify
33-
* command line interface (CLI). This API isn’t available to applications created using the
34-
* Amplify Gen 2 public preview. When you deploy an application with
33+
* command line interface (CLI). This API isn’t available to Amplify Gen 2 applications.
34+
* When you deploy an application with
3535
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
3636
* code.</p>
3737
* @example

clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
2929
/**
3030
* <p>Deletes a backend environment for an Amplify app. </p>
3131
* <p>This API is available only to Amplify Gen 1 applications where the
32-
* backend was created using Amplify Studio or the Amplify
33-
* command line interface (CLI). This API isn’t available to applications created using the
34-
* Amplify Gen 2 public preview. When you deploy an application with
32+
* backend is created using Amplify Studio or the Amplify
33+
* command line interface (CLI). This API isn’t available to Amplify Gen 2 applications.
34+
* When you deploy an application with
3535
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
3636
* code.</p>
3737
* @example

clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
2929
/**
3030
* <p>Returns a backend environment for an Amplify app. </p>
3131
* <p>This API is available only to Amplify Gen 1 applications where the
32-
* backend was created using Amplify Studio or the Amplify
33-
* command line interface (CLI). This API isn’t available to applications created using the
34-
* Amplify Gen 2 public preview. When you deploy an application with
32+
* backend is created using Amplify Studio or the Amplify
33+
* command line interface (CLI). This API isn’t available to Amplify Gen 2 applications.
34+
* When you deploy an application with
3535
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
3636
* code.</p>
3737
* @example

clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
2929
/**
3030
* <p>Lists the backend environments for an Amplify app. </p>
3131
* <p>This API is available only to Amplify Gen 1 applications where the
32-
* backend was created using Amplify Studio or the Amplify
33-
* command line interface (CLI). This API isn’t available to applications created using the
34-
* Amplify Gen 2 public preview. When you deploy an application with
32+
* backend is created using Amplify Studio or the Amplify
33+
* command line interface (CLI). This API isn’t available to Amplify Gen 2 applications.
34+
* When you deploy an application with
3535
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
3636
* code.</p>
3737
* @example

clients/client-amplify/src/models/models_0.ts

+30-7
Original file line numberDiff line numberDiff line change
@@ -668,7 +668,10 @@ export interface CreateBackendEnvironmentRequest {
668668
}
669669

670670
/**
671-
* <p>Describes the backend environment for an Amplify app. </p>
671+
* <p>Describes the backend environment associated with a <code>Branch</code> of a Gen 1
672+
* Amplify app. Amplify Gen 1 applications are created
673+
* using Amplify Studio or the Amplify command line
674+
* interface (CLI).</p>
672675
* @public
673676
*/
674677
export interface BackendEnvironment {
@@ -745,8 +748,11 @@ export class NotFoundException extends __BaseException {
745748
}
746749

747750
/**
748-
* <p>Describes the backend properties associated with an Amplify
751+
* <p>Describes the backend associated with an Amplify
749752
* <code>Branch</code>.</p>
753+
* <p>This property is available to Amplify Gen 2 apps only. When you deploy an application with
754+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
755+
* code.</p>
750756
* @public
751757
*/
752758
export interface Backend {
@@ -870,15 +876,21 @@ export interface CreateBranchRequest {
870876
pullRequestEnvironmentName?: string;
871877

872878
/**
873-
* <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
879+
* <p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify
874880
* app. </p>
881+
* <p>This field is available to Amplify Gen 1 apps only where the
882+
* backend is created using Amplify Studio or the Amplify
883+
* command line interface (CLI).</p>
875884
* @public
876885
*/
877886
backendEnvironmentArn?: string;
878887

879888
/**
880889
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
881890
* backend created from an CloudFormation stack.</p>
891+
* <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with
892+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
893+
* code.</p>
882894
* @public
883895
*/
884896
backend?: Backend;
@@ -1052,15 +1064,20 @@ export interface Branch {
10521064
sourceBranch?: string;
10531065

10541066
/**
1055-
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
1056-
* app. </p>
1067+
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>
1068+
* <p>This property is available to Amplify Gen 1 apps only. When you deploy an application with
1069+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
1070+
* code.</p>
10571071
* @public
10581072
*/
10591073
backendEnvironmentArn?: string;
10601074

10611075
/**
1062-
* <p>Describes the backend properties associated with an Amplify
1076+
* <p>Describes the backend associated with an Amplify
10631077
* <code>Branch</code>.</p>
1078+
* <p>This property is available to Amplify Gen 2 apps only. When you deploy an application with
1079+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
1080+
* code.</p>
10641081
* @public
10651082
*/
10661083
backend?: Backend;
@@ -3041,15 +3058,21 @@ export interface UpdateBranchRequest {
30413058
pullRequestEnvironmentName?: string;
30423059

30433060
/**
3044-
* <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
3061+
* <p>The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify
30453062
* app. </p>
3063+
* <p>This field is available to Amplify Gen 1 apps only where the
3064+
* backend is created using Amplify Studio or the Amplify
3065+
* command line interface (CLI).</p>
30463066
* @public
30473067
*/
30483068
backendEnvironmentArn?: string;
30493069

30503070
/**
30513071
* <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
30523072
* backend created from an CloudFormation stack.</p>
3073+
* <p>This field is available to Amplify Gen 2 apps only. When you deploy an application with
3074+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
3075+
* code.</p>
30533076
* @public
30543077
*/
30553078
backend?: Backend;

codegen/sdk-codegen/aws-models/amplify.json

+11-11
Original file line numberDiff line numberDiff line change
@@ -1436,7 +1436,7 @@
14361436
}
14371437
},
14381438
"traits": {
1439-
"smithy.api#documentation": "<p>Describes the backend properties associated with an Amplify\n <code>Branch</code>.</p>"
1439+
"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>"
14401440
}
14411441
},
14421442
"com.amazonaws.amplify#BackendEnvironment": {
@@ -1484,7 +1484,7 @@
14841484
}
14851485
},
14861486
"traits": {
1487-
"smithy.api#documentation": "<p>Describes the backend environment for an Amplify app. </p>"
1487+
"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>"
14881488
}
14891489
},
14901490
"com.amazonaws.amplify#BackendEnvironmentArn": {
@@ -1706,7 +1706,7 @@
17061706
"backendEnvironmentArn": {
17071707
"target": "com.amazonaws.amplify#BackendEnvironmentArn",
17081708
"traits": {
1709-
"smithy.api#documentation": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>"
1709+
"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>"
17101710
}
17111711
},
17121712
"backend": {
@@ -2082,7 +2082,7 @@
20822082
}
20832083
],
20842084
"traits": {
2085-
"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>",
2085+
"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>",
20862086
"smithy.api#http": {
20872087
"method": "POST",
20882088
"uri": "/apps/{appId}/backendenvironments",
@@ -2290,13 +2290,13 @@
22902290
"backendEnvironmentArn": {
22912291
"target": "com.amazonaws.amplify#BackendEnvironmentArn",
22922292
"traits": {
2293-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>"
2293+
"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>"
22942294
}
22952295
},
22962296
"backend": {
22972297
"target": "com.amazonaws.amplify#Backend",
22982298
"traits": {
2299-
"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>"
2299+
"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>"
23002300
}
23012301
}
23022302
},
@@ -2787,7 +2787,7 @@
27872787
}
27882788
],
27892789
"traits": {
2790-
"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>",
2790+
"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>",
27912791
"smithy.api#http": {
27922792
"method": "DELETE",
27932793
"uri": "/apps/{appId}/backendenvironments/{environmentName}",
@@ -3719,7 +3719,7 @@
37193719
}
37203720
],
37213721
"traits": {
3722-
"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>",
3722+
"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>",
37233723
"smithy.api#http": {
37243724
"method": "GET",
37253725
"uri": "/apps/{appId}/backendenvironments/{environmentName}",
@@ -4497,7 +4497,7 @@
44974497
}
44984498
],
44994499
"traits": {
4500-
"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>",
4500+
"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>",
45014501
"smithy.api#http": {
45024502
"method": "GET",
45034503
"uri": "/apps/{appId}/backendenvironments",
@@ -6324,13 +6324,13 @@
63246324
"backendEnvironmentArn": {
63256325
"target": "com.amazonaws.amplify#BackendEnvironmentArn",
63266326
"traits": {
6327-
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app. </p>"
6327+
"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>"
63286328
}
63296329
},
63306330
"backend": {
63316331
"target": "com.amazonaws.amplify#Backend",
63326332
"traits": {
6333-
"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>"
6333+
"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>"
63346334
}
63356335
}
63366336
},

0 commit comments

Comments
 (0)