Skip to content

Commit 07675a9

Browse files
author
awstools
committed
docs(client-amplify): Documentation updates for Amplify. Identifies the APIs available only to apps created using Amplify Gen 1.
1 parent 6a6d341 commit 07675a9

File tree

5 files changed

+28
-4
lines changed

5 files changed

+28
-4
lines changed

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

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi
2929
/**
3030
* @public
3131
* <p>Creates a new backend environment for an Amplify app. </p>
32+
* <p>This API is available only to Amplify Gen 1 applications where the
33+
* backend is created using Amplify Studio or the Amplify
34+
* command line interface (CLI). This API isn’t available to applications created using the
35+
* Amplify Gen 2 public preview. When you deploy an application with
36+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
37+
* code.</p>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

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

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi
2929
/**
3030
* @public
3131
* <p>Deletes a backend environment for an Amplify app. </p>
32+
* <p>This API is available only to Amplify Gen 1 applications where the
33+
* backend was created using Amplify Studio or the Amplify
34+
* command line interface (CLI). This API isn’t available to applications created using the
35+
* Amplify Gen 2 public preview. When you deploy an application with
36+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
37+
* code.</p>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

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

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen
2929
/**
3030
* @public
3131
* <p>Returns a backend environment for an Amplify app. </p>
32+
* <p>This API is available only to Amplify Gen 1 applications where the
33+
* backend was created using Amplify Studio or the Amplify
34+
* command line interface (CLI). This API isn’t available to applications created using the
35+
* Amplify Gen 2 public preview. When you deploy an application with
36+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
37+
* code.</p>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

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

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron
2929
/**
3030
* @public
3131
* <p>Lists the backend environments for an Amplify app. </p>
32+
* <p>This API is available only to Amplify Gen 1 applications where the
33+
* backend was created using Amplify Studio or the Amplify
34+
* command line interface (CLI). This API isn’t available to applications created using the
35+
* Amplify Gen 2 public preview. When you deploy an application with
36+
* Amplify Gen 2, you provision the app's backend infrastructure using Typescript
37+
* code.</p>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

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

+4-4
Original file line numberDiff line numberDiff line change
@@ -2082,7 +2082,7 @@
20822082
}
20832083
],
20842084
"traits": {
2085-
"smithy.api#documentation": "<p>Creates a new backend environment for an Amplify app. </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 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>",
20862086
"smithy.api#http": {
20872087
"method": "POST",
20882088
"uri": "/apps/{appId}/backendenvironments",
@@ -2787,7 +2787,7 @@
27872787
}
27882788
],
27892789
"traits": {
2790-
"smithy.api#documentation": "<p>Deletes a backend environment for an Amplify app. </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 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>",
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>",
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>",
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>",
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>",
45014501
"smithy.api#http": {
45024502
"method": "GET",
45034503
"uri": "/apps/{appId}/backendenvironments",

0 commit comments

Comments
 (0)