diff --git a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts index 5857f17bf0ff..738250554c84 100644 --- 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 *

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 + * 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.

* @example diff --git a/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts index 4c4faccb0371..f9e7121121fe 100644 --- 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 /** *

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 + * 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.

* @example diff --git a/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts index 1d582781e7b6..b82e166004b6 100644 --- 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 /** *

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 + * 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.

* @example diff --git a/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts index 427183fc9be0..e186a1dfe4aa 100644 --- 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 /** *

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 + * 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.

* @example diff --git a/clients/client-amplify/src/models/models_0.ts b/clients/client-amplify/src/models/models_0.ts index 6b66d8432779..bc59a6f703de 100644 --- 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 { } /** - *

Describes the backend environment for an Amplify app.

+ *

Describes the backend environment associated with a Branch of a Gen 1 + * Amplify app. Amplify Gen 1 applications are created + * using Amplify Studio or the Amplify command line + * interface (CLI).

* @public */ export interface BackendEnvironment { @@ -745,8 +748,11 @@ export class NotFoundException extends __BaseException { } /** - *

Describes the backend properties associated with an Amplify + *

Describes the backend associated with an Amplify * Branch.

+ *

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.

* @public */ export interface Backend { @@ -870,8 +876,11 @@ export interface CreateBranchRequest { pullRequestEnvironmentName?: string; /** - *

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify + *

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify * app.

+ *

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).

* @public */ backendEnvironmentArn?: string; @@ -879,6 +888,9 @@ export interface CreateBranchRequest { /** *

The backend for a Branch of an Amplify app. Use for a * backend created from an CloudFormation stack.

+ *

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.

* @public */ backend?: Backend; @@ -1052,15 +1064,20 @@ export interface Branch { sourceBranch?: string; /** - *

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify - * app.

+ *

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

+ *

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.

* @public */ backendEnvironmentArn?: string; /** - *

Describes the backend properties associated with an Amplify + *

Describes the backend associated with an Amplify * Branch.

+ *

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.

* @public */ backend?: Backend; @@ -3041,8 +3058,11 @@ export interface UpdateBranchRequest { pullRequestEnvironmentName?: string; /** - *

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify + *

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify * app.

+ *

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).

* @public */ backendEnvironmentArn?: string; @@ -3050,6 +3070,9 @@ export interface UpdateBranchRequest { /** *

The backend for a Branch of an Amplify app. Use for a * backend created from an CloudFormation stack.

+ *

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.

* @public */ backend?: Backend; diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json index 77b01f00f7a2..c0be344d41e5 100644 --- a/codegen/sdk-codegen/aws-models/amplify.json +++ b/codegen/sdk-codegen/aws-models/amplify.json @@ -1436,7 +1436,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the backend properties associated with an Amplify\n Branch.

" + "smithy.api#documentation": "

Describes the backend associated with an Amplify\n Branch.

\n

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.

" } }, "com.amazonaws.amplify#BackendEnvironment": { @@ -1484,7 +1484,7 @@ } }, "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

" + "smithy.api#documentation": "

Describes the backend environment associated with a Branch 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).

" } }, "com.amazonaws.amplify#BackendEnvironmentArn": { @@ -1706,7 +1706,7 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.

\n

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.

" } }, "backend": { @@ -2082,7 +2082,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new backend environment for an Amplify app.

\n

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.

", + "smithy.api#documentation": "

Creates a new backend environment for an Amplify app.

\n

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.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", @@ -2290,13 +2290,13 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n app.

\n

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).

" } }, "backend": { "target": "com.amazonaws.amplify#Backend", "traits": { - "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

" + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

\n

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.

" } } }, @@ -2787,7 +2787,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a backend environment for an Amplify app.

\n

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.

", + "smithy.api#documentation": "

Deletes a backend environment for an Amplify app.

\n

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.

", "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.

\n

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.

", + "smithy.api#documentation": "

Returns a backend environment for an Amplify app.

\n

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.

", "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.

\n

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.

", + "smithy.api#documentation": "

Lists the backend environments for an Amplify app.

\n

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.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments", @@ -6324,13 +6324,13 @@ "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.

" + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify\n app.

\n

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).

" } }, "backend": { "target": "com.amazonaws.amplify#Backend", "traits": { - "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

" + "smithy.api#documentation": "

The backend for a Branch of an Amplify app. Use for a\n backend created from an CloudFormation stack.

\n

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.

" } } },