diff --git a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts index 07c51f1cfd05..c57e501fab3e 100644 --- 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 *
Creates a new backend environment for an Amplify app.
+ *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.
* @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 index b43afd462368..9d2008895c81 100644 --- 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 *Deletes a backend environment for an Amplify app.
+ *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.
* @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 index 9ae9fd8754e4..6cae17f6367d 100644 --- 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 *Returns a backend environment for an Amplify app.
+ *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.
* @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 index 774b8053f2ba..62248a85f2fe 100644 --- 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 *Lists the backend environments for an Amplify app.
+ *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.
* @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 index ed50820c4754..828287d73377 100644 --- a/codegen/sdk-codegen/aws-models/amplify.json +++ b/codegen/sdk-codegen/aws-models/amplify.json @@ -2082,7 +2082,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new backend environment for an Amplify app.
", + "smithy.api#documentation": "Creates a new backend environment for an Amplify app.
\nThis 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.
", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", @@ -2787,7 +2787,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a backend environment for an Amplify app.
", + "smithy.api#documentation": "Deletes a backend environment for an Amplify app.
\nThis 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.
", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -3719,7 +3719,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a backend environment for an Amplify app.
", + "smithy.api#documentation": "Returns a backend environment for an Amplify app.
\nThis 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.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -4497,7 +4497,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the backend environments for an Amplify app.
", + "smithy.api#documentation": "Lists the backend environments for an Amplify app.
\nThis 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.
", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments",