From df2f16b239507830a7bbaaae846ae1d41b14dd25 Mon Sep 17 00:00:00 2001 From: awstools Date: Tue, 31 Oct 2023 18:29:50 +0000 Subject: [PATCH] feat(client-amplify): Add backend field to CreateBranch and UpdateBranch requests. Add pagination support for ListApps, ListDomainAssociations, ListBranches, and ListJobs --- clients/client-amplify/README.md | 4 +- clients/client-amplify/src/Amplify.ts | 4 +- clients/client-amplify/src/AmplifyClient.ts | 4 +- .../src/commands/CreateAppCommand.ts | 12 +- .../CreateBackendEnvironmentCommand.ts | 12 +- .../src/commands/CreateBranchCommand.ts | 18 +- .../src/commands/CreateDeploymentCommand.ts | 14 +- .../CreateDomainAssociationCommand.ts | 12 +- .../src/commands/CreateWebhookCommand.ts | 14 +- .../src/commands/DeleteAppCommand.ts | 12 +- .../DeleteBackendEnvironmentCommand.ts | 12 +- .../src/commands/DeleteBranchCommand.ts | 13 +- .../DeleteDomainAssociationCommand.ts | 10 +- .../src/commands/DeleteJobCommand.ts | 10 +- .../src/commands/DeleteWebhookCommand.ts | 12 +- .../src/commands/GenerateAccessLogsCommand.ts | 10 +- .../src/commands/GetAppCommand.ts | 10 +- .../src/commands/GetArtifactUrlCommand.ts | 12 +- .../commands/GetBackendEnvironmentCommand.ts | 10 +- .../src/commands/GetBranchCommand.ts | 11 +- .../commands/GetDomainAssociationCommand.ts | 8 +- .../src/commands/GetJobCommand.ts | 10 +- .../src/commands/GetWebhookCommand.ts | 12 +- .../src/commands/ListAppsCommand.ts | 8 +- .../src/commands/ListArtifactsCommand.ts | 10 +- .../ListBackendEnvironmentsCommand.ts | 8 +- .../src/commands/ListBranchesCommand.ts | 9 +- .../commands/ListDomainAssociationsCommand.ts | 6 +- .../src/commands/ListJobsCommand.ts | 8 +- .../commands/ListTagsForResourceCommand.ts | 8 +- .../src/commands/ListWebhooksCommand.ts | 10 +- .../src/commands/StartDeploymentCommand.ts | 16 +- .../src/commands/StartJobCommand.ts | 10 +- .../src/commands/StopJobCommand.ts | 10 +- .../src/commands/TagResourceCommand.ts | 8 +- .../src/commands/UntagResourceCommand.ts | 8 +- .../src/commands/UpdateAppCommand.ts | 10 +- .../src/commands/UpdateBranchCommand.ts | 16 +- .../UpdateDomainAssociationCommand.ts | 10 +- .../src/commands/UpdateWebhookCommand.ts | 12 +- clients/client-amplify/src/index.ts | 5 +- clients/client-amplify/src/models/models_0.ts | 529 ++++++++-------- .../src/pagination/Interfaces.ts | 11 + .../src/pagination/ListAppsPaginator.ts | 46 ++ .../src/pagination/ListBranchesPaginator.ts | 50 ++ .../ListDomainAssociationsPaginator.ts | 50 ++ .../src/pagination/ListJobsPaginator.ts | 46 ++ .../client-amplify/src/pagination/index.ts | 6 + .../src/protocols/Aws_restJson1.ts | 8 + codegen/sdk-codegen/aws-models/amplify.json | 599 ++++++++++-------- 50 files changed, 1053 insertions(+), 710 deletions(-) create mode 100644 clients/client-amplify/src/pagination/Interfaces.ts create mode 100644 clients/client-amplify/src/pagination/ListAppsPaginator.ts create mode 100644 clients/client-amplify/src/pagination/ListBranchesPaginator.ts create mode 100644 clients/client-amplify/src/pagination/ListDomainAssociationsPaginator.ts create mode 100644 clients/client-amplify/src/pagination/ListJobsPaginator.ts create mode 100644 clients/client-amplify/src/pagination/index.ts diff --git a/clients/client-amplify/README.md b/clients/client-amplify/README.md index b4303d9e1d518..e8d6b4bac8557 100644 --- a/clients/client-amplify/README.md +++ b/clients/client-amplify/README.md @@ -7,8 +7,8 @@ AWS SDK for JavaScript Amplify Client for Node.js, Browser and React Native.

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. -The Amplify Console provides a continuous delivery and hosting service for web -applications. For more information, see the Amplify Console User Guide. The +Amplify Hosting provides a continuous delivery and hosting service for web +applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework.

diff --git a/clients/client-amplify/src/Amplify.ts b/clients/client-amplify/src/Amplify.ts index 50745d227e192..88b09744541d6 100644 --- a/clients/client-amplify/src/Amplify.ts +++ b/clients/client-amplify/src/Amplify.ts @@ -667,8 +667,8 @@ export interface Amplify { /** * @public *

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. - * The Amplify Console provides a continuous delivery and hosting service for web - * applications. For more information, see the Amplify Console User Guide. The + * Amplify Hosting provides a continuous delivery and hosting service for web + * applications. For more information, see the Amplify Hosting User Guide. The * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation * for client app development. For more information, see the Amplify Framework. *

diff --git a/clients/client-amplify/src/AmplifyClient.ts b/clients/client-amplify/src/AmplifyClient.ts index 633346ac1d006..613baa914bf5b 100644 --- a/clients/client-amplify/src/AmplifyClient.ts +++ b/clients/client-amplify/src/AmplifyClient.ts @@ -385,8 +385,8 @@ export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfig /** * @public *

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. - * The Amplify Console provides a continuous delivery and hosting service for web - * applications. For more information, see the Amplify Console User Guide. The + * Amplify Hosting provides a continuous delivery and hosting service for web + * applications. For more information, see the Amplify Hosting User Guide. The * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation * for client app development. For more information, see the Amplify Framework. *

diff --git a/clients/client-amplify/src/commands/CreateAppCommand.ts b/clients/client-amplify/src/commands/CreateAppCommand.ts index 4e9422b7d0955..32c07fa8deb0f 100644 --- a/clients/client-amplify/src/commands/CreateAppCommand.ts +++ b/clients/client-amplify/src/commands/CreateAppCommand.ts @@ -42,7 +42,7 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare /** * @public - *

Creates a new Amplify app.

+ *

Creates a new Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -167,19 +167,19 @@ export interface CreateAppCommandOutput extends CreateAppResult, __MetadataBeare * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts index fabee1bd71486..4969f7c370ed7 100644 --- a/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts +++ b/clients/client-amplify/src/commands/CreateBackendEnvironmentCommand.ts @@ -37,7 +37,7 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi /** * @public - *

Creates a new backend environment for an Amplify app.

+ *

Creates a new backend environment for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,19 +72,19 @@ export interface CreateBackendEnvironmentCommandOutput extends CreateBackendEnvi * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/CreateBranchCommand.ts b/clients/client-amplify/src/commands/CreateBranchCommand.ts index f1c7d8c7285ab..c11c43b344582 100644 --- a/clients/client-amplify/src/commands/CreateBranchCommand.ts +++ b/clients/client-amplify/src/commands/CreateBranchCommand.ts @@ -72,6 +72,9 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat * enablePullRequestPreview: true || false, * pullRequestEnvironmentName: "STRING_VALUE", * backendEnvironmentArn: "STRING_VALUE", + * backend: { // Backend + * stackArn: "STRING_VALUE", + * }, * }; * const command = new CreateBranchCommand(input); * const response = await client.send(command); @@ -112,6 +115,9 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat * // destinationBranch: "STRING_VALUE", * // sourceBranch: "STRING_VALUE", * // backendEnvironmentArn: "STRING_VALUE", + * // backend: { // Backend + * // stackArn: "STRING_VALUE", + * // }, * // }, * // }; * @@ -124,22 +130,22 @@ export interface CreateBranchCommandOutput extends CreateBranchResult, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/CreateDeploymentCommand.ts b/clients/client-amplify/src/commands/CreateDeploymentCommand.ts index 8cdf58f68ba05..464d461f190a0 100644 --- a/clients/client-amplify/src/commands/CreateDeploymentCommand.ts +++ b/clients/client-amplify/src/commands/CreateDeploymentCommand.ts @@ -37,8 +37,12 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _ /** * @public - *

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are + *

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are * not connected to a repository.

+ *

The maximum duration between the CreateDeployment call and the + * StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the + * StartDeployment call and the associated Job will + * fail.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -71,16 +75,16 @@ export interface CreateDeploymentCommandOutput extends CreateDeploymentResult, _ * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/CreateDomainAssociationCommand.ts b/clients/client-amplify/src/commands/CreateDomainAssociationCommand.ts index 4987ac7c8c436..b93d504ccbe29 100644 --- a/clients/client-amplify/src/commands/CreateDomainAssociationCommand.ts +++ b/clients/client-amplify/src/commands/CreateDomainAssociationCommand.ts @@ -96,22 +96,22 @@ export interface CreateDomainAssociationCommandOutput extends CreateDomainAssoci * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/CreateWebhookCommand.ts b/clients/client-amplify/src/commands/CreateWebhookCommand.ts index 1ae639c414ae5..4d68ab19348a3 100644 --- a/clients/client-amplify/src/commands/CreateWebhookCommand.ts +++ b/clients/client-amplify/src/commands/CreateWebhookCommand.ts @@ -37,7 +37,7 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad /** * @public - *

Creates a new webhook on an Amplify app.

+ *

Creates a new webhook on an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,22 +72,22 @@ export interface CreateWebhookCommandOutput extends CreateWebhookResult, __Metad * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteAppCommand.ts b/clients/client-amplify/src/commands/DeleteAppCommand.ts index 76d83cb5aca93..677b82ea18786 100644 --- a/clients/client-amplify/src/commands/DeleteAppCommand.ts +++ b/clients/client-amplify/src/commands/DeleteAppCommand.ts @@ -37,7 +37,7 @@ export interface DeleteAppCommandOutput extends DeleteAppResult, __MetadataBeare /** * @public - *

Deletes an existing Amplify app specified by an app ID.

+ *

Deletes an existing Amplify app specified by an app ID.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -118,19 +118,19 @@ export interface DeleteAppCommandOutput extends DeleteAppResult, __MetadataBeare * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts index 63cacd21a9cce..f497dd621161e 100644 --- a/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts +++ b/clients/client-amplify/src/commands/DeleteBackendEnvironmentCommand.ts @@ -37,7 +37,7 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi /** * @public - *

Deletes a backend environment for an Amplify app.

+ *

Deletes a backend environment for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,19 +70,19 @@ export interface DeleteBackendEnvironmentCommandOutput extends DeleteBackendEnvi * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteBranchCommand.ts b/clients/client-amplify/src/commands/DeleteBranchCommand.ts index 6f903069c590e..e43835ce8d8ca 100644 --- a/clients/client-amplify/src/commands/DeleteBranchCommand.ts +++ b/clients/client-amplify/src/commands/DeleteBranchCommand.ts @@ -87,6 +87,9 @@ export interface DeleteBranchCommandOutput extends DeleteBranchResult, __Metadat * // destinationBranch: "STRING_VALUE", * // sourceBranch: "STRING_VALUE", * // backendEnvironmentArn: "STRING_VALUE", + * // backend: { // Backend + * // stackArn: "STRING_VALUE", + * // }, * // }, * // }; * @@ -99,19 +102,19 @@ export interface DeleteBranchCommandOutput extends DeleteBranchResult, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteDomainAssociationCommand.ts b/clients/client-amplify/src/commands/DeleteDomainAssociationCommand.ts index 89f84ef5c2b3c..5bbf1c6766b5d 100644 --- a/clients/client-amplify/src/commands/DeleteDomainAssociationCommand.ts +++ b/clients/client-amplify/src/commands/DeleteDomainAssociationCommand.ts @@ -84,19 +84,19 @@ export interface DeleteDomainAssociationCommandOutput extends DeleteDomainAssoci * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteJobCommand.ts b/clients/client-amplify/src/commands/DeleteJobCommand.ts index 9050554c89069..8ba777a7dc177 100644 --- a/clients/client-amplify/src/commands/DeleteJobCommand.ts +++ b/clients/client-amplify/src/commands/DeleteJobCommand.ts @@ -74,19 +74,19 @@ export interface DeleteJobCommandOutput extends DeleteJobResult, __MetadataBeare * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/DeleteWebhookCommand.ts b/clients/client-amplify/src/commands/DeleteWebhookCommand.ts index 17c7695aad64a..041b64c3698bd 100644 --- a/clients/client-amplify/src/commands/DeleteWebhookCommand.ts +++ b/clients/client-amplify/src/commands/DeleteWebhookCommand.ts @@ -37,7 +37,7 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookResult, __Metad /** * @public - *

Deletes a webhook.

+ *

Deletes a webhook.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,19 +70,19 @@ export interface DeleteWebhookCommandOutput extends DeleteWebhookResult, __Metad * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GenerateAccessLogsCommand.ts b/clients/client-amplify/src/commands/GenerateAccessLogsCommand.ts index a3c3f26c79da5..bdcd408667819 100644 --- a/clients/client-amplify/src/commands/GenerateAccessLogsCommand.ts +++ b/clients/client-amplify/src/commands/GenerateAccessLogsCommand.ts @@ -37,7 +37,7 @@ export interface GenerateAccessLogsCommandOutput extends GenerateAccessLogsResul /** * @public - *

Returns the website access logs for a specific time range using a presigned URL. + *

Returns the website access logs for a specific time range using a presigned URL. *

* @example * Use a bare-bones client and the command you need to make an API call. @@ -66,16 +66,16 @@ export interface GenerateAccessLogsCommandOutput extends GenerateAccessLogsResul * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetAppCommand.ts b/clients/client-amplify/src/commands/GetAppCommand.ts index bacd6e6a18d1b..f3b784acfba18 100644 --- a/clients/client-amplify/src/commands/GetAppCommand.ts +++ b/clients/client-amplify/src/commands/GetAppCommand.ts @@ -37,7 +37,7 @@ export interface GetAppCommandOutput extends GetAppResult, __MetadataBearer {} /** * @public - *

Returns an existing Amplify app by appID.

+ *

Returns an existing Amplify app specified by an app ID.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -118,16 +118,16 @@ export interface GetAppCommandOutput extends GetAppResult, __MetadataBearer {} * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetArtifactUrlCommand.ts b/clients/client-amplify/src/commands/GetArtifactUrlCommand.ts index c9bd0231c09ad..156a0de01fdce 100644 --- a/clients/client-amplify/src/commands/GetArtifactUrlCommand.ts +++ b/clients/client-amplify/src/commands/GetArtifactUrlCommand.ts @@ -37,7 +37,7 @@ export interface GetArtifactUrlCommandOutput extends GetArtifactUrlResult, __Met /** * @public - *

Returns the artifact info that corresponds to an artifact id.

+ *

Returns the artifact info that corresponds to an artifact id.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,19 +63,19 @@ export interface GetArtifactUrlCommandOutput extends GetArtifactUrlResult, __Met * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts b/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts index 2051808784f22..174b7110ba3a4 100644 --- a/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts +++ b/clients/client-amplify/src/commands/GetBackendEnvironmentCommand.ts @@ -37,7 +37,7 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen /** * @public - *

Returns a backend environment for an Amplify app.

+ *

Returns a backend environment for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,16 +70,16 @@ export interface GetBackendEnvironmentCommandOutput extends GetBackendEnvironmen * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetBranchCommand.ts b/clients/client-amplify/src/commands/GetBranchCommand.ts index 44b9173e33521..039390cf71e20 100644 --- a/clients/client-amplify/src/commands/GetBranchCommand.ts +++ b/clients/client-amplify/src/commands/GetBranchCommand.ts @@ -87,6 +87,9 @@ export interface GetBranchCommandOutput extends GetBranchResult, __MetadataBeare * // destinationBranch: "STRING_VALUE", * // sourceBranch: "STRING_VALUE", * // backendEnvironmentArn: "STRING_VALUE", + * // backend: { // Backend + * // stackArn: "STRING_VALUE", + * // }, * // }, * // }; * @@ -99,16 +102,16 @@ export interface GetBranchCommandOutput extends GetBranchResult, __MetadataBeare * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetDomainAssociationCommand.ts b/clients/client-amplify/src/commands/GetDomainAssociationCommand.ts index 9307f8e1e3122..595e6faadf53a 100644 --- a/clients/client-amplify/src/commands/GetDomainAssociationCommand.ts +++ b/clients/client-amplify/src/commands/GetDomainAssociationCommand.ts @@ -84,16 +84,16 @@ export interface GetDomainAssociationCommandOutput extends GetDomainAssociationR * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetJobCommand.ts b/clients/client-amplify/src/commands/GetJobCommand.ts index aa561c6b13355..a57c272316933 100644 --- a/clients/client-amplify/src/commands/GetJobCommand.ts +++ b/clients/client-amplify/src/commands/GetJobCommand.ts @@ -93,19 +93,19 @@ export interface GetJobCommandOutput extends GetJobResult, __MetadataBearer {} * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/GetWebhookCommand.ts b/clients/client-amplify/src/commands/GetWebhookCommand.ts index 2661f4fa43da3..4aef3bce58eec 100644 --- a/clients/client-amplify/src/commands/GetWebhookCommand.ts +++ b/clients/client-amplify/src/commands/GetWebhookCommand.ts @@ -37,7 +37,7 @@ export interface GetWebhookCommandOutput extends GetWebhookResult, __MetadataBea /** * @public - *

Returns the webhook information that corresponds to a specified webhook ID.

+ *

Returns the webhook information that corresponds to a specified webhook ID.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -70,19 +70,19 @@ export interface GetWebhookCommandOutput extends GetWebhookResult, __MetadataBea * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListAppsCommand.ts b/clients/client-amplify/src/commands/ListAppsCommand.ts index be34678e694ff..30f93e3e3747a 100644 --- a/clients/client-amplify/src/commands/ListAppsCommand.ts +++ b/clients/client-amplify/src/commands/ListAppsCommand.ts @@ -37,7 +37,7 @@ export interface ListAppsCommandOutput extends ListAppsResult, __MetadataBearer /** * @public - *

Returns a list of the existing Amplify apps.

+ *

Returns a list of the existing Amplify apps.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -122,13 +122,13 @@ export interface ListAppsCommandOutput extends ListAppsResult, __MetadataBearer * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListArtifactsCommand.ts b/clients/client-amplify/src/commands/ListArtifactsCommand.ts index 6e0158bcd90d8..c4e42ca4b8692 100644 --- a/clients/client-amplify/src/commands/ListArtifactsCommand.ts +++ b/clients/client-amplify/src/commands/ListArtifactsCommand.ts @@ -37,7 +37,7 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad /** * @public - *

Returns a list of artifacts for a specified app, branch, and job.

+ *

Returns a list of artifacts for a specified app, branch, and job.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,16 +72,16 @@ export interface ListArtifactsCommandOutput extends ListArtifactsResult, __Metad * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts b/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts index 557fba71636d1..e88662e7f1d88 100644 --- a/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts +++ b/clients/client-amplify/src/commands/ListBackendEnvironmentsCommand.ts @@ -37,7 +37,7 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron /** * @public - *

Lists the backend environments for an Amplify app.

+ *

Lists the backend environments for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,13 +75,13 @@ export interface ListBackendEnvironmentsCommandOutput extends ListBackendEnviron * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListBranchesCommand.ts b/clients/client-amplify/src/commands/ListBranchesCommand.ts index 07fee23593e37..c8706fa198100 100644 --- a/clients/client-amplify/src/commands/ListBranchesCommand.ts +++ b/clients/client-amplify/src/commands/ListBranchesCommand.ts @@ -89,6 +89,9 @@ export interface ListBranchesCommandOutput extends ListBranchesResult, __Metadat * // destinationBranch: "STRING_VALUE", * // sourceBranch: "STRING_VALUE", * // backendEnvironmentArn: "STRING_VALUE", + * // backend: { // Backend + * // stackArn: "STRING_VALUE", + * // }, * // }, * // ], * // nextToken: "STRING_VALUE", @@ -103,13 +106,13 @@ export interface ListBranchesCommandOutput extends ListBranchesResult, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListDomainAssociationsCommand.ts b/clients/client-amplify/src/commands/ListDomainAssociationsCommand.ts index e8ccd439b7b92..4b9a011e6a4bd 100644 --- a/clients/client-amplify/src/commands/ListDomainAssociationsCommand.ts +++ b/clients/client-amplify/src/commands/ListDomainAssociationsCommand.ts @@ -88,13 +88,13 @@ export interface ListDomainAssociationsCommandOutput extends ListDomainAssociati * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListJobsCommand.ts b/clients/client-amplify/src/commands/ListJobsCommand.ts index 45bd5535aefce..e2e8909ecbacf 100644 --- a/clients/client-amplify/src/commands/ListJobsCommand.ts +++ b/clients/client-amplify/src/commands/ListJobsCommand.ts @@ -78,16 +78,16 @@ export interface ListJobsCommandOutput extends ListJobsResult, __MetadataBearer * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListTagsForResourceCommand.ts b/clients/client-amplify/src/commands/ListTagsForResourceCommand.ts index aed64f6892e78..72186332164a7 100644 --- a/clients/client-amplify/src/commands/ListTagsForResourceCommand.ts +++ b/clients/client-amplify/src/commands/ListTagsForResourceCommand.ts @@ -37,7 +37,7 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes /** * @public - *

Returns a list of tags for a specified Amazon Resource Name (ARN).

+ *

Returns a list of tags for a specified Amazon Resource Name (ARN).

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -64,13 +64,13 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An operation failed due to a non-existent resource.

+ *

An operation failed due to a non-existent resource.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/ListWebhooksCommand.ts b/clients/client-amplify/src/commands/ListWebhooksCommand.ts index 2e3fb1cfd4f08..1dacffd65675c 100644 --- a/clients/client-amplify/src/commands/ListWebhooksCommand.ts +++ b/clients/client-amplify/src/commands/ListWebhooksCommand.ts @@ -37,7 +37,7 @@ export interface ListWebhooksCommandOutput extends ListWebhooksResult, __Metadat /** * @public - *

Returns a list of webhooks for an Amplify app.

+ *

Returns a list of webhooks for an Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -75,16 +75,16 @@ export interface ListWebhooksCommandOutput extends ListWebhooksResult, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/StartDeploymentCommand.ts b/clients/client-amplify/src/commands/StartDeploymentCommand.ts index 2666779c21047..818847679b4d9 100644 --- a/clients/client-amplify/src/commands/StartDeploymentCommand.ts +++ b/clients/client-amplify/src/commands/StartDeploymentCommand.ts @@ -37,8 +37,12 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M /** * @public - *

Starts a deployment for a manually deployed app. Manually deployed apps are not + *

Starts a deployment for a manually deployed app. Manually deployed apps are not * connected to a repository.

+ *

The maximum duration between the CreateDeployment call and the + * StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the + * StartDeployment call and the associated Job will + * fail.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -76,19 +80,19 @@ export interface StartDeploymentCommandOutput extends StartDeploymentResult, __M * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/StartJobCommand.ts b/clients/client-amplify/src/commands/StartJobCommand.ts index c9756bdbc0bb5..5a6ff150440cb 100644 --- a/clients/client-amplify/src/commands/StartJobCommand.ts +++ b/clients/client-amplify/src/commands/StartJobCommand.ts @@ -79,19 +79,19 @@ export interface StartJobCommandOutput extends StartJobResult, __MetadataBearer * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/StopJobCommand.ts b/clients/client-amplify/src/commands/StopJobCommand.ts index a19d8d59f7cd7..eaf679931e290 100644 --- a/clients/client-amplify/src/commands/StopJobCommand.ts +++ b/clients/client-amplify/src/commands/StopJobCommand.ts @@ -74,19 +74,19 @@ export interface StopJobCommandOutput extends StopJobResult, __MetadataBearer {} * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link LimitExceededException} (client fault) - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/TagResourceCommand.ts b/clients/client-amplify/src/commands/TagResourceCommand.ts index 7bc62afa42909..2101f8e3411eb 100644 --- a/clients/client-amplify/src/commands/TagResourceCommand.ts +++ b/clients/client-amplify/src/commands/TagResourceCommand.ts @@ -37,7 +37,7 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat /** * @public - *

Tags the resource with a tag key and value.

+ *

Tags the resource with a tag key and value.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,13 +63,13 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An operation failed due to a non-existent resource.

+ *

An operation failed due to a non-existent resource.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/UntagResourceCommand.ts b/clients/client-amplify/src/commands/UntagResourceCommand.ts index d149c3a237390..b8a20358742da 100644 --- a/clients/client-amplify/src/commands/UntagResourceCommand.ts +++ b/clients/client-amplify/src/commands/UntagResourceCommand.ts @@ -37,7 +37,7 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met /** * @public - *

Untags a resource with a specified Amazon Resource Name (ARN).

+ *

Untags a resource with a specified Amazon Resource Name (ARN).

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -63,13 +63,13 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link ResourceNotFoundException} (client fault) - *

An operation failed due to a non-existent resource.

+ *

An operation failed due to a non-existent resource.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/UpdateAppCommand.ts b/clients/client-amplify/src/commands/UpdateAppCommand.ts index 24955f3adc29e..87e9c364c1b31 100644 --- a/clients/client-amplify/src/commands/UpdateAppCommand.ts +++ b/clients/client-amplify/src/commands/UpdateAppCommand.ts @@ -42,7 +42,7 @@ export interface UpdateAppCommandOutput extends UpdateAppResult, __MetadataBeare /** * @public - *

Updates an existing Amplify app.

+ *

Updates an existing Amplify app.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -165,16 +165,16 @@ export interface UpdateAppCommandOutput extends UpdateAppResult, __MetadataBeare * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/UpdateBranchCommand.ts b/clients/client-amplify/src/commands/UpdateBranchCommand.ts index 882fa020bf881..f83d600fe20a0 100644 --- a/clients/client-amplify/src/commands/UpdateBranchCommand.ts +++ b/clients/client-amplify/src/commands/UpdateBranchCommand.ts @@ -69,6 +69,9 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat * enablePullRequestPreview: true || false, * pullRequestEnvironmentName: "STRING_VALUE", * backendEnvironmentArn: "STRING_VALUE", + * backend: { // Backend + * stackArn: "STRING_VALUE", + * }, * }; * const command = new UpdateBranchCommand(input); * const response = await client.send(command); @@ -109,6 +112,9 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat * // destinationBranch: "STRING_VALUE", * // sourceBranch: "STRING_VALUE", * // backendEnvironmentArn: "STRING_VALUE", + * // backend: { // Backend + * // stackArn: "STRING_VALUE", + * // }, * // }, * // }; * @@ -121,19 +127,19 @@ export interface UpdateBranchCommandOutput extends UpdateBranchResult, __Metadat * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/UpdateDomainAssociationCommand.ts b/clients/client-amplify/src/commands/UpdateDomainAssociationCommand.ts index c19d9e4bee39d..da30dfd4fae2c 100644 --- a/clients/client-amplify/src/commands/UpdateDomainAssociationCommand.ts +++ b/clients/client-amplify/src/commands/UpdateDomainAssociationCommand.ts @@ -95,19 +95,19 @@ export interface UpdateDomainAssociationCommandOutput extends UpdateDomainAssoci * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/commands/UpdateWebhookCommand.ts b/clients/client-amplify/src/commands/UpdateWebhookCommand.ts index e9337a7f7a5a9..03a3ff523fcb4 100644 --- a/clients/client-amplify/src/commands/UpdateWebhookCommand.ts +++ b/clients/client-amplify/src/commands/UpdateWebhookCommand.ts @@ -37,7 +37,7 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookResult, __Metad /** * @public - *

Updates a webhook.

+ *

Updates a webhook.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript @@ -72,19 +72,19 @@ export interface UpdateWebhookCommandOutput extends UpdateWebhookResult, __Metad * @see {@link AmplifyClientResolvedConfig | config} for AmplifyClient's `config` shape. * * @throws {@link BadRequestException} (client fault) - *

A request contains unexpected data.

+ *

A request contains unexpected data.

* * @throws {@link DependentServiceFailureException} (server fault) - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

* * @throws {@link InternalFailureException} (server fault) - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

* * @throws {@link NotFoundException} (client fault) - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

* * @throws {@link UnauthorizedException} (client fault) - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

* * @throws {@link AmplifyServiceException} *

Base exception class for all service exceptions from Amplify service.

diff --git a/clients/client-amplify/src/index.ts b/clients/client-amplify/src/index.ts index 9588dae7e658a..d25d8776eb103 100644 --- a/clients/client-amplify/src/index.ts +++ b/clients/client-amplify/src/index.ts @@ -2,8 +2,8 @@ /* eslint-disable */ /** *

Amplify enables developers to develop and deploy cloud-powered mobile and web apps. - * The Amplify Console provides a continuous delivery and hosting service for web - * applications. For more information, see the Amplify Console User Guide. The + * Amplify Hosting provides a continuous delivery and hosting service for web + * applications. For more information, see the Amplify Hosting User Guide. The * Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation * for client app development. For more information, see the Amplify Framework. *

@@ -14,6 +14,7 @@ export * from "./AmplifyClient"; export * from "./Amplify"; export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters"; export * from "./commands"; +export * from "./pagination"; export * from "./models"; import "@aws-sdk/util-endpoints"; diff --git a/clients/client-amplify/src/models/models_0.ts b/clients/client-amplify/src/models/models_0.ts index d85dae673f378..95e75773365c0 100644 --- a/clients/client-amplify/src/models/models_0.ts +++ b/clients/client-amplify/src/models/models_0.ts @@ -5,7 +5,7 @@ import { AmplifyServiceException as __BaseException } from "./AmplifyServiceExce /** * @public - *

A request contains unexpected data.

+ *

A request contains unexpected data.

*/ export class BadRequestException extends __BaseException { readonly name: "BadRequestException" = "BadRequestException"; @@ -42,36 +42,36 @@ export type Stage = (typeof Stage)[keyof typeof Stage]; /** * @public - *

Describes the automated branch creation configuration.

+ *

Describes the automated branch creation configuration.

*/ export interface AutoBranchCreationConfig { /** * @public - *

Describes the current stage for the autocreated branch.

+ *

Describes the current stage for the autocreated branch.

*/ stage?: Stage; /** * @public - *

The framework for the autocreated branch.

+ *

The framework for the autocreated branch.

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

Enables auto building for the autocreated branch.

+ *

Enables auto building for the autocreated branch.

*/ enableAutoBuild?: boolean; /** * @public - *

The environment variables for the autocreated branch.

+ *

The environment variables for the autocreated branch.

*/ environmentVariables?: Record; /** * @public - *

The basic authorization credentials for the autocreated branch. You must + *

The basic authorization credentials for the autocreated branch. You must * base64-encode the authorization credentials and provide them in the format * user:password.

*/ @@ -79,7 +79,7 @@ export interface AutoBranchCreationConfig { /** * @public - *

Enables basic authorization for the autocreated branch.

+ *

Enables basic authorization for the autocreated branch.

*/ enableBasicAuth?: boolean; @@ -94,43 +94,43 @@ export interface AutoBranchCreationConfig { /** * @public - *

The build specification (build spec) for the autocreated branch.

+ *

The build specification (build spec) for the autocreated branch.

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

Enables pull request previews for the autocreated branch.

+ *

Enables pull request previews for the autocreated branch.

*/ enablePullRequestPreview?: boolean; /** * @public - *

The Amplify environment name for the pull request.

+ *

The Amplify environment name for the pull request.

*/ pullRequestEnvironmentName?: string; } /** * @public - *

Describes a custom rewrite or redirect rule.

+ *

Describes a custom rewrite or redirect rule.

*/ export interface CustomRule { /** * @public - *

The source pattern for a URL rewrite or redirect rule.

+ *

The source pattern for a URL rewrite or redirect rule.

*/ source: string | undefined; /** * @public - *

The target pattern for a URL rewrite or redirect rule.

+ *

The target pattern for a URL rewrite or redirect rule.

*/ target: string | undefined; /** * @public - *

The status code for a URL rewrite or redirect rule.

+ *

The status code for a URL rewrite or redirect rule.

*
*
200
*
@@ -159,7 +159,7 @@ export interface CustomRule { /** * @public - *

The condition for a URL rewrite or redirect rule, such as a country code.

+ *

The condition for a URL rewrite or redirect rule, such as a country code.

*/ condition?: string; } @@ -181,30 +181,30 @@ export type Platform = (typeof Platform)[keyof typeof Platform]; /** * @public - *

The request structure used to create apps in Amplify.

+ *

The request structure used to create apps in Amplify.

*/ export interface CreateAppRequest { /** * @public - *

The name for an Amplify app.

+ *

The name of the Amplify app.

*/ name: string | undefined; /** * @public - *

The description for an Amplify app.

+ *

The description of the Amplify app.

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

The repository for an Amplify app.

+ *

The Git repository for the Amplify app.

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

The platform for the Amplify app. For a static app, set the platform type to WEB. + *

The platform for the Amplify app. For a static app, set the platform type to WEB. * For a dynamic server-side rendered (SSR) app, set the platform type to * WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to * WEB_DYNAMIC.

@@ -213,7 +213,7 @@ export interface CreateAppRequest { /** * @public - *

The AWS Identity and Access Management (IAM) service role for an Amplify app.

+ *

The AWS Identity and Access Management (IAM) service role for an Amplify app.

*/ iamServiceRoleArn?: string; @@ -229,7 +229,7 @@ export interface CreateAppRequest { * create a new app.

*

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub - * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the + * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the * Amplify User Guide .

*/ oauthToken?: string; @@ -245,40 +245,41 @@ export interface CreateAppRequest { * create a new app.

*

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub - * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the + * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the * Amplify User Guide .

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

The environment variables map for an Amplify app.

+ *

The environment variables map for an Amplify app.

+ *

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

*/ environmentVariables?: Record; /** * @public - *

Enables the auto building of branches for an Amplify app.

+ *

Enables the auto building of branches for an Amplify app.

*/ enableBranchAutoBuild?: boolean; /** * @public - *

Automatically disconnects a branch in the Amplify Console when you delete a branch + *

Automatically disconnects a branch in the Amplify console when you delete a branch * from your Git repository.

*/ enableBranchAutoDeletion?: boolean; /** * @public - *

Enables basic authorization for an Amplify app. This will apply to all branches that + *

Enables basic authorization for an Amplify app. This will apply to all branches that * are part of this app.

*/ enableBasicAuth?: boolean; /** * @public - *

The credentials for basic authorization for an Amplify app. You must base64-encode + *

The credentials for basic authorization for an Amplify app. You must base64-encode * the authorization credentials and provide them in the format * user:password.

*/ @@ -286,19 +287,19 @@ export interface CreateAppRequest { /** * @public - *

The custom rewrite and redirect rules for an Amplify app.

+ *

The custom rewrite and redirect rules for an Amplify app.

*/ customRules?: CustomRule[]; /** * @public - *

The tag for an Amplify app.

+ *

The tag for an Amplify app.

*/ tags?: Record; /** * @public - *

The build specification (build spec) for an Amplify app.

+ *

The build specification (build spec) for an Amplify app.

*/ buildSpec?: string; @@ -310,49 +311,49 @@ export interface CreateAppRequest { /** * @public - *

Enables automated branch creation for an Amplify app.

+ *

Enables automated branch creation for an Amplify app.

*/ enableAutoBranchCreation?: boolean; /** * @public - *

The automated branch creation glob patterns for an Amplify app.

+ *

The automated branch creation glob patterns for an Amplify app.

*/ autoBranchCreationPatterns?: string[]; /** * @public - *

The automated branch creation configuration for an Amplify app.

+ *

The automated branch creation configuration for an Amplify app.

*/ autoBranchCreationConfig?: AutoBranchCreationConfig; } /** * @public - *

Describes the information about a production branch for an Amplify app.

+ *

Describes the information about a production branch for an Amplify app.

*/ export interface ProductionBranch { /** * @public - *

The last deploy time of the production branch.

+ *

The last deploy time of the production branch.

*/ lastDeployTime?: Date; /** * @public - *

The status of the production branch.

+ *

The status of the production branch.

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

The thumbnail URL for the production branch.

+ *

The thumbnail URL for the production branch.

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

The branch name for the production branch.

+ *

The branch name for the production branch.

*/ branchName?: string; } @@ -374,49 +375,49 @@ export type RepositoryCloneMethod = (typeof RepositoryCloneMethod)[keyof typeof /** * @public - *

Represents the different branches of a repository for building, deploying, and + *

Represents the different branches of a repository for building, deploying, and * hosting an Amplify app.

*/ export interface App { /** * @public - *

The unique ID of the Amplify app.

+ *

The unique ID of the Amplify app.

*/ appId: string | undefined; /** * @public - *

The Amazon Resource Name (ARN) of the Amplify app.

+ *

The Amazon Resource Name (ARN) of the Amplify app.

*/ appArn: string | undefined; /** * @public - *

The name for the Amplify app.

+ *

The name for the Amplify app.

*/ name: string | undefined; /** * @public - *

The tag for the Amplify app.

+ *

The tag for the Amplify app.

*/ tags?: Record; /** * @public - *

The description for the Amplify app.

+ *

The description for the Amplify app.

*/ description: string | undefined; /** * @public - *

The Git repository for the Amplify app.

+ *

The Git repository for the Amplify app.

*/ repository: string | undefined; /** * @public - *

The platform for the Amplify app. For a static app, set the platform type to WEB. + *

The platform for the Amplify app. For a static app, set the platform type to WEB. * For a dynamic server-side rendered (SSR) app, set the platform type to * WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to * WEB_DYNAMIC.

@@ -425,57 +426,58 @@ export interface App { /** * @public - *

Creates a date and time for the Amplify app.

+ *

Creates a date and time for the Amplify app.

*/ createTime: Date | undefined; /** * @public - *

Updates the date and time for the Amplify app.

+ *

Updates the date and time for the Amplify app.

*/ updateTime: Date | undefined; /** * @public - *

The AWS Identity and Access Management (IAM) service role for the Amazon Resource + *

The AWS Identity and Access Management (IAM) service role for the Amazon Resource * Name (ARN) of the Amplify app.

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

The environment variables for the Amplify app.

+ *

The environment variables for the Amplify app.

+ *

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

*/ environmentVariables: Record | undefined; /** * @public - *

The default domain for the Amplify app.

+ *

The default domain for the Amplify app.

*/ defaultDomain: string | undefined; /** * @public - *

Enables the auto-building of branches for the Amplify app.

+ *

Enables the auto-building of branches for the Amplify app.

*/ enableBranchAutoBuild: boolean | undefined; /** * @public - *

Automatically disconnect a branch in the Amplify Console when you delete a branch - * from your Git repository.

+ *

Automatically disconnect a branch in the Amplify console when you delete a branch + * from your Git repository.

*/ enableBranchAutoDeletion?: boolean; /** * @public - *

Enables basic authorization for the Amplify app's branches.

+ *

Enables basic authorization for the Amplify app's branches.

*/ enableBasicAuth: boolean | undefined; /** * @public - *

The basic authorization credentials for branches for the Amplify app. You must + *

The basic authorization credentials for branches for the Amplify app. You must * base64-encode the authorization credentials and provide them in the format * user:password.

*/ @@ -483,19 +485,19 @@ export interface App { /** * @public - *

Describes the custom redirect and rewrite rules for the Amplify app.

+ *

Describes the custom redirect and rewrite rules for the Amplify app.

*/ customRules?: CustomRule[]; /** * @public - *

Describes the information about a production branch of the Amplify app.

+ *

Describes the information about a production branch of the Amplify app.

*/ productionBranch?: ProductionBranch; /** * @public - *

Describes the content of the build specification (build spec) for the Amplify app. + *

Describes the content of the build specification (build spec) for the Amplify app. *

*/ buildSpec?: string; @@ -508,19 +510,19 @@ export interface App { /** * @public - *

Enables automated branch creation for the Amplify app.

+ *

Enables automated branch creation for the Amplify app.

*/ enableAutoBranchCreation?: boolean; /** * @public - *

Describes the automated branch creation glob patterns for the Amplify app.

+ *

Describes the automated branch creation glob patterns for the Amplify app.

*/ autoBranchCreationPatterns?: string[]; /** * @public - *

Describes the automated branch creation configuration for the Amplify app.

+ *

Describes the automated branch creation configuration for the Amplify app.

*/ autoBranchCreationConfig?: AutoBranchCreationConfig; @@ -543,7 +545,7 @@ export interface App { export interface CreateAppResult { /** * @public - *

Represents the different branches of a repository for building, deploying, and + *

Represents the different branches of a repository for building, deploying, and * hosting an Amplify app.

*/ app: App | undefined; @@ -551,7 +553,7 @@ export interface CreateAppResult { /** * @public - *

An operation failed because a dependent service threw an exception.

+ *

An operation failed because a dependent service threw an exception.

*/ export class DependentServiceFailureException extends __BaseException { readonly name: "DependentServiceFailureException" = "DependentServiceFailureException"; @@ -571,7 +573,7 @@ export class DependentServiceFailureException extends __BaseException { /** * @public - *

The service failed to perform an operation due to an internal issue.

+ *

The service failed to perform an operation due to an internal issue.

*/ export class InternalFailureException extends __BaseException { readonly name: "InternalFailureException" = "InternalFailureException"; @@ -591,7 +593,7 @@ export class InternalFailureException extends __BaseException { /** * @public - *

A resource could not be created because service quotas were exceeded.

+ *

A resource could not be created because service quotas were exceeded.

*/ export class LimitExceededException extends __BaseException { readonly name: "LimitExceededException" = "LimitExceededException"; @@ -611,7 +613,7 @@ export class LimitExceededException extends __BaseException { /** * @public - *

An operation failed due to a lack of access.

+ *

An operation failed due to a lack of access.

*/ export class UnauthorizedException extends __BaseException { readonly name: "UnauthorizedException" = "UnauthorizedException"; @@ -631,74 +633,74 @@ export class UnauthorizedException extends __BaseException { /** * @public - *

The request structure for the backend environment create request.

+ *

The request structure for the backend environment create request.

*/ export interface CreateBackendEnvironmentRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name for the backend environment.

+ *

The name for the backend environment.

*/ environmentName: string | undefined; /** * @public - *

The AWS CloudFormation stack name of a backend environment.

+ *

The AWS CloudFormation stack name of a backend environment.

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

The name of deployment artifacts.

+ *

The name of deployment artifacts.

*/ deploymentArtifacts?: string; } /** * @public - *

Describes the backend environment for an Amplify app.

+ *

Describes the backend environment for an Amplify app.

*/ export interface BackendEnvironment { /** * @public - *

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 an Amplify * app.

*/ backendEnvironmentArn: string | undefined; /** * @public - *

The name for a backend environment that is part of an Amplify app.

+ *

The name for a backend environment that is part of an Amplify app.

*/ environmentName: string | undefined; /** * @public - *

The AWS CloudFormation stack name of a backend environment.

+ *

The AWS CloudFormation stack name of a backend environment.

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

The name of deployment artifacts.

+ *

The name of deployment artifacts.

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

The creation date and time for a backend environment that is part of an Amplify app. + *

The creation date and time for a backend environment that is part of an Amplify app. *

*/ createTime: Date | undefined; /** * @public - *

The last updated date and time for a backend environment that is part of an Amplify + *

The last updated date and time for a backend environment that is part of an Amplify * app.

*/ updateTime: Date | undefined; @@ -706,19 +708,19 @@ export interface BackendEnvironment { /** * @public - *

The result structure for the create backend environment request.

+ *

The result structure for the create backend environment request.

*/ export interface CreateBackendEnvironmentResult { /** * @public - *

Describes the backend environment for an Amplify app.

+ *

Describes the backend environment for an Amplify app.

*/ backendEnvironment: BackendEnvironment | undefined; } /** * @public - *

An entity was not found during an operation.

+ *

An entity was not found during an operation.

*/ export class NotFoundException extends __BaseException { readonly name: "NotFoundException" = "NotFoundException"; @@ -736,6 +738,18 @@ export class NotFoundException extends __BaseException { } } +/** + * @public + *

Describes the backend properties associated with an Amplify Branch.

+ */ +export interface Backend { + /** + * @public + *

The Amazon Resource Name (ARN) for the CloudFormation stack.

+ */ + stackArn?: string; +} + /** * @public *

The request structure for the create branch request.

@@ -749,19 +763,19 @@ export interface CreateBranchRequest { /** * @public - *

The name for the branch.

+ *

The name for the branch.

*/ branchName: string | undefined; /** * @public - *

The description for the branch.

+ *

The description for the branch.

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

Describes the current stage for the branch.

+ *

Describes the current stage for the branch.

*/ stage?: Stage; @@ -850,10 +864,16 @@ export interface CreateBranchRequest { /** * @public - *

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 an Amplify * app.

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

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

+ */ + backend?: Backend; } /** @@ -1029,6 +1049,12 @@ export interface Branch { * app.

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

Describes the backend properties associated with an Amplify Branch.

+ */ + backend?: Backend; } /** @@ -1057,7 +1083,7 @@ export interface CreateDeploymentRequest { /** * @public - *

The name for the branch, for the job.

+ *

The name of the branch to use for the job.

*/ branchName: string | undefined; @@ -1279,108 +1305,108 @@ export interface CreateDomainAssociationResult { /** * @public - *

The request structure for the create webhook request.

+ *

The request structure for the create webhook request.

*/ export interface CreateWebhookRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name for a branch that is part of an Amplify app.

+ *

The name for a branch that is part of an Amplify app.

*/ branchName: string | undefined; /** * @public - *

The description for a webhook.

+ *

The description for a webhook.

*/ description?: string; } /** * @public - *

Describes a webhook that connects repository events to an Amplify app.

+ *

Describes a webhook that connects repository events to an Amplify app.

*/ export interface Webhook { /** * @public - *

The Amazon Resource Name (ARN) for the webhook.

+ *

The Amazon Resource Name (ARN) for the webhook.

*/ webhookArn: string | undefined; /** * @public - *

The ID of the webhook.

+ *

The ID of the webhook.

*/ webhookId: string | undefined; /** * @public - *

The URL of the webhook.

+ *

The URL of the webhook.

*/ webhookUrl: string | undefined; /** * @public - *

The name for a branch that is part of an Amplify app.

+ *

The name for a branch that is part of an Amplify app.

*/ branchName: string | undefined; /** * @public - *

The description for a webhook.

+ *

The description for a webhook.

*/ description: string | undefined; /** * @public - *

The create date and time for a webhook.

+ *

The create date and time for a webhook.

*/ createTime: Date | undefined; /** * @public - *

Updates the date and time for a webhook.

+ *

Updates the date and time for a webhook.

*/ updateTime: Date | undefined; } /** * @public - *

The result structure for the create webhook request.

+ *

The result structure for the create webhook request.

*/ export interface CreateWebhookResult { /** * @public - *

Describes a webhook that connects repository events to an Amplify app.

+ *

Describes a webhook that connects repository events to an Amplify app.

*/ webhook: Webhook | undefined; } /** * @public - *

Describes the request structure for the delete app request.

+ *

Describes the request structure for the delete app request.

*/ export interface DeleteAppRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; } /** * @public - *

The result structure for the delete app request.

+ *

The result structure for the delete app request.

*/ export interface DeleteAppResult { /** * @public - *

Represents the different branches of a repository for building, deploying, and + *

Represents the different branches of a repository for building, deploying, and * hosting an Amplify app.

*/ app: App | undefined; @@ -1388,30 +1414,30 @@ export interface DeleteAppResult { /** * @public - *

The request structure for the delete backend environment request.

+ *

The request structure for the delete backend environment request.

*/ export interface DeleteBackendEnvironmentRequest { /** * @public - *

The unique ID of an Amplify app.

+ *

The unique ID of an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name of a backend environment of an Amplify app.

+ *

The name of a backend environment of an Amplify app.

*/ environmentName: string | undefined; } /** * @public - *

The result structure of the delete backend environment result.

+ *

The result structure of the delete backend environment result.

*/ export interface DeleteBackendEnvironmentResult { /** * @public - *

Describes the backend environment for an Amplify app.

+ *

Describes the backend environment for an Amplify app.

*/ backendEnvironment: BackendEnvironment | undefined; } @@ -1429,19 +1455,19 @@ export interface DeleteBranchRequest { /** * @public - *

The name for the branch.

+ *

The name of the branch.

*/ branchName: string | undefined; } /** * @public - *

The result structure for the delete branch request.

+ *

The result structure for the delete branch request.

*/ export interface DeleteBranchResult { /** * @public - *

The branch for an Amplify app, which maps to a third-party repository branch.

+ *

The branch for an Amplify app, which maps to a third-party repository branch.

*/ branch: Branch | undefined; } @@ -1489,7 +1515,7 @@ export interface DeleteJobRequest { /** * @public - *

The name for the branch, for the job.

+ *

The name of the branch to use for the job.

*/ branchName: string | undefined; @@ -1613,80 +1639,80 @@ export interface DeleteJobResult { /** * @public - *

The request structure for the delete webhook request.

+ *

The request structure for the delete webhook request.

*/ export interface DeleteWebhookRequest { /** * @public - *

The unique ID for a webhook.

+ *

The unique ID for a webhook.

*/ webhookId: string | undefined; } /** * @public - *

The result structure for the delete webhook request.

+ *

The result structure for the delete webhook request.

*/ export interface DeleteWebhookResult { /** * @public - *

Describes a webhook that connects repository events to an Amplify app.

+ *

Describes a webhook that connects repository events to an Amplify app.

*/ webhook: Webhook | undefined; } /** * @public - *

The request structure for the generate access logs request.

+ *

The request structure for the generate access logs request.

*/ export interface GenerateAccessLogsRequest { /** * @public - *

The time at which the logs should start. The time range specified is inclusive of the + *

The time at which the logs should start. The time range specified is inclusive of the * start time.

*/ startTime?: Date; /** * @public - *

The time at which the logs should end. The time range specified is inclusive of the + *

The time at which the logs should end. The time range specified is inclusive of the * end time.

*/ endTime?: Date; /** * @public - *

The name of the domain.

+ *

The name of the domain.

*/ domainName: string | undefined; /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; } /** * @public - *

The result structure for the generate access logs request.

+ *

The result structure for the generate access logs request.

*/ export interface GenerateAccessLogsResult { /** * @public - *

The pre-signed URL for the requested access logs.

+ *

The pre-signed URL for the requested access logs.

*/ logUrl?: string; } /** * @public - *

The request structure for the get app request.

+ *

The request structure for the get app request.

*/ export interface GetAppRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; } @@ -1697,7 +1723,7 @@ export interface GetAppRequest { export interface GetAppResult { /** * @public - *

Represents the different branches of a repository for building, deploying, and + *

Represents the different branches of a repository for building, deploying, and * hosting an Amplify app.

*/ app: App | undefined; @@ -1705,60 +1731,60 @@ export interface GetAppResult { /** * @public - *

Returns the request structure for the get artifact request.

+ *

Returns the request structure for the get artifact request.

*/ export interface GetArtifactUrlRequest { /** * @public - *

The unique ID for an artifact.

+ *

The unique ID for an artifact.

*/ artifactId: string | undefined; } /** * @public - *

Returns the result structure for the get artifact request.

+ *

Returns the result structure for the get artifact request.

*/ export interface GetArtifactUrlResult { /** * @public - *

The unique ID for an artifact.

+ *

The unique ID for an artifact.

*/ artifactId: string | undefined; /** * @public - *

The presigned URL for the artifact.

+ *

The presigned URL for the artifact.

*/ artifactUrl: string | undefined; } /** * @public - *

The request structure for the get backend environment request.

+ *

The request structure for the get backend environment request.

*/ export interface GetBackendEnvironmentRequest { /** * @public - *

The unique id for an Amplify app.

+ *

The unique id for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name for the backend environment.

+ *

The name for the backend environment.

*/ environmentName: string | undefined; } /** * @public - *

The result structure for the get backend environment result.

+ *

The result structure for the get backend environment result.

*/ export interface GetBackendEnvironmentResult { /** * @public - *

Describes the backend environment for an Amplify app.

+ *

Describes the backend environment for an Amplify app.

*/ backendEnvironment: BackendEnvironment | undefined; } @@ -1776,7 +1802,7 @@ export interface GetBranchRequest { /** * @public - *

The name for the branch.

+ *

The name of the branch.

*/ branchName: string | undefined; } @@ -1825,24 +1851,24 @@ export interface GetDomainAssociationResult { /** * @public - *

The request structure for the get job request.

+ *

The request structure for the get job request.

*/ export interface GetJobRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The branch name for the job.

+ *

The name of the branch to use for the job.

*/ branchName: string | undefined; /** * @public - *

The unique ID for the job.

+ *

The unique ID for the job.

*/ jobId: string | undefined; } @@ -1951,61 +1977,61 @@ export interface GetJobResult { /** * @public - *

The request structure for the get webhook request.

+ *

The request structure for the get webhook request.

*/ export interface GetWebhookRequest { /** * @public - *

The unique ID for a webhook.

+ *

The unique ID for a webhook.

*/ webhookId: string | undefined; } /** * @public - *

The result structure for the get webhook request.

+ *

The result structure for the get webhook request.

*/ export interface GetWebhookResult { /** * @public - *

Describes the structure of a webhook.

+ *

Describes the structure of a webhook.

*/ webhook: Webhook | undefined; } /** * @public - *

The request structure for the list apps request.

+ *

The request structure for the list apps request.

*/ export interface ListAppsRequest { /** * @public - *

A pagination token. If non-null, the pagination token is returned in a result. Pass + *

A pagination token. If non-null, the pagination token is returned in a result. Pass * its value in another request to retrieve more entries.

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

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ maxResults?: number; } /** * @public - *

The result structure for an Amplify app list request.

+ *

The result structure for an Amplify app list request.

*/ export interface ListAppsResult { /** * @public - *

A list of Amplify apps.

+ *

A list of Amplify apps.

*/ apps: App[] | undefined; /** * @public - *

A pagination token. Set to null to start listing apps from start. If non-null, the + *

A pagination token. Set to null to start listing apps from start. If non-null, the * pagination token is returned in a result. Pass its value in here to list more projects. *

*/ @@ -2014,30 +2040,30 @@ export interface ListAppsResult { /** * @public - *

Describes the request structure for the list artifacts request.

+ *

Describes the request structure for the list artifacts request.

*/ export interface ListArtifactsRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name of a branch that is part of an Amplify app.

+ *

The name of a branch that is part of an Amplify app.

*/ branchName: string | undefined; /** * @public - *

The unique ID for a job.

+ *

The unique ID for a job.

*/ jobId: string | undefined; /** * @public - *

A pagination token. Set to null to start listing artifacts from start. If a non-null + *

A pagination token. Set to null to start listing artifacts from start. If a non-null * pagination token is returned in a result, pass its value in here to list more artifacts. *

*/ @@ -2045,43 +2071,43 @@ export interface ListArtifactsRequest { /** * @public - *

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ maxResults?: number; } /** * @public - *

Describes an artifact.

+ *

Describes an artifact.

*/ export interface Artifact { /** * @public - *

The file name for the artifact.

+ *

The file name for the artifact.

*/ artifactFileName: string | undefined; /** * @public - *

The unique ID for the artifact.

+ *

The unique ID for the artifact.

*/ artifactId: string | undefined; } /** * @public - *

The result structure for the list artifacts request.

+ *

The result structure for the list artifacts request.

*/ export interface ListArtifactsResult { /** * @public - *

A list of artifacts.

+ *

A list of artifacts.

*/ artifacts: Artifact[] | undefined; /** * @public - *

A pagination token. If a non-null pagination token is returned in a result, pass its + *

A pagination token. If a non-null pagination token is returned in a result, pass its * value in another request to retrieve more entries.

*/ nextToken?: string; @@ -2089,24 +2115,24 @@ export interface ListArtifactsResult { /** * @public - *

The request structure for the list backend environments request.

+ *

The request structure for the list backend environments request.

*/ export interface ListBackendEnvironmentsRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name of the backend environment

+ *

The name of the backend environment

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

A pagination token. Set to null to start listing backend environments from the start. + *

A pagination token. Set to null to start listing backend environments from the start. * If a non-null pagination token is returned in a result, pass its value in here to list * more backend environments.

*/ @@ -2114,25 +2140,25 @@ export interface ListBackendEnvironmentsRequest { /** * @public - *

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ maxResults?: number; } /** * @public - *

The result structure for the list backend environments result.

+ *

The result structure for the list backend environments result.

*/ export interface ListBackendEnvironmentsResult { /** * @public - *

The list of backend environments for an Amplify app.

+ *

The list of backend environments for an Amplify app.

*/ backendEnvironments: BackendEnvironment[] | undefined; /** * @public - *

A pagination token. If a non-null pagination token is returned in a result, pass its + *

A pagination token. If a non-null pagination token is returned in a result, pass its * value in another request to retrieve more entries.

*/ nextToken?: string; @@ -2140,18 +2166,18 @@ export interface ListBackendEnvironmentsResult { /** * @public - *

The request structure for the list branches request.

+ *

The request structure for the list branches request.

*/ export interface ListBranchesRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

A pagination token. Set to null to start listing branches from the start. If a + *

A pagination token. Set to null to start listing branches from the start. If a * non-null pagination token is returned in a result, pass its value in here to list more * branches.

*/ @@ -2241,13 +2267,13 @@ export interface ListJobsRequest { /** * @public - *

The name for a branch.

+ *

The name of the branch to use for the request.

*/ branchName: string | undefined; /** * @public - *

A pagination token. Set to null to start listing steps from the start. If a non-null + *

A pagination token. Set to null to start listing steps from the start. If a non-null * pagination token is returned in a result, pass its value in here to list more steps. *

*/ @@ -2255,25 +2281,25 @@ export interface ListJobsRequest { /** * @public - *

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ maxResults?: number; } /** * @public - *

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ export interface ListJobsResult { /** * @public - *

The result structure for the list job result request.

+ *

The result structure for the list job result request.

*/ jobSummaries: JobSummary[] | undefined; /** * @public - *

A pagination token. If non-null the pagination token is returned in a result. Pass + *

A pagination token. If non-null the pagination token is returned in a result. Pass * its value in another request to retrieve more entries.

*/ nextToken?: string; @@ -2281,31 +2307,31 @@ export interface ListJobsResult { /** * @public - *

The request structure to use to list tags for a resource.

+ *

The request structure to use to list tags for a resource.

*/ export interface ListTagsForResourceRequest { /** * @public - *

The Amazon Resource Name (ARN) to use to list tags.

+ *

The Amazon Resource Name (ARN) to use to list tags.

*/ resourceArn: string | undefined; } /** * @public - *

The response for the list tags for resource request.

+ *

The response for the list tags for resource request.

*/ export interface ListTagsForResourceResponse { /** * @public - *

A list of tags for the specified The Amazon Resource Name (ARN).

+ *

A list of tags for the specified The Amazon Resource Name (ARN).

*/ tags?: Record; } /** * @public - *

An operation failed due to a non-existent resource.

+ *

An operation failed due to a non-existent resource.

*/ export class ResourceNotFoundException extends __BaseException { readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; @@ -2327,18 +2353,18 @@ export class ResourceNotFoundException extends __BaseException { /** * @public - *

The request structure for the list webhooks request.

+ *

The request structure for the list webhooks request.

*/ export interface ListWebhooksRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

A pagination token. Set to null to start listing webhooks from the start. If + *

A pagination token. Set to null to start listing webhooks from the start. If * non-null,the pagination token is returned in a result. Pass its value in here to list * more webhooks.

*/ @@ -2346,25 +2372,25 @@ export interface ListWebhooksRequest { /** * @public - *

The maximum number of records to list in a single response.

+ *

The maximum number of records to list in a single response.

*/ maxResults?: number; } /** * @public - *

The result structure for the list webhooks request.

+ *

The result structure for the list webhooks request.

*/ export interface ListWebhooksResult { /** * @public - *

A list of webhooks.

+ *

A list of webhooks.

*/ webhooks: Webhook[] | undefined; /** * @public - *

A pagination token. If non-null, the pagination token is returned in a result. Pass + *

A pagination token. If non-null, the pagination token is returned in a result. Pass * its value in another request to retrieve more entries.

*/ nextToken?: string; @@ -2372,30 +2398,30 @@ export interface ListWebhooksResult { /** * @public - *

The request structure for the start a deployment request.

+ *

The request structure for the start a deployment request.

*/ export interface StartDeploymentRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name for the branch, for the job.

+ *

The name of the branch to use for the job.

*/ branchName: string | undefined; /** * @public - *

The job ID for this deployment, generated by the create deployment request.

+ *

The job ID for this deployment, generated by the create deployment request.

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

The source URL for this deployment, used when calling start deployment without create + *

The source URL for this deployment, used when calling start deployment without create * deployment. The source URL can be any HTTP GET URL that is publicly accessible and * downloads a single .zip file.

*/ @@ -2404,45 +2430,46 @@ export interface StartDeploymentRequest { /** * @public - *

The result structure for the start a deployment request.

+ *

The result structure for the start a deployment request.

*/ export interface StartDeploymentResult { /** * @public - *

The summary for the job.

+ *

The summary for the job.

*/ jobSummary: JobSummary | undefined; } /** * @public - *

The request structure for the start job request.

+ *

The request structure for the start job request.

*/ export interface StartJobRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The branch name for the job.

+ *

The name of the branch to use for the job.

*/ branchName: string | undefined; /** * @public - *

The unique ID for an existing job. This is required if the value of + *

The unique ID for an existing job. This is required if the value of * jobType is RETRY.

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

Describes the type for the job. The job type RELEASE starts a new job + *

Describes the type for the job. The job type RELEASE starts a new job * with the latest change from the specified branch. This value is available only for apps - * that are connected to a repository. The job type RETRY retries an existing + * that are connected to a repository.

+ *

The job type RETRY retries an existing * job. If the job type value is RETRY, the jobId is also * required.

*/ @@ -2450,7 +2477,7 @@ export interface StartJobRequest { /** * @public - *

A descriptive reason for starting this job.

+ *

A descriptive reason for starting the job.

*/ jobReason?: string; @@ -2498,7 +2525,7 @@ export interface StopJobRequest { /** * @public - *

The name for the branch, for the job.

+ *

The name of the branch to use for the stop job request.

*/ branchName: string | undefined; @@ -2523,7 +2550,7 @@ export interface StopJobResult { /** * @public - *

The request structure to tag a resource with a tag key and value.

+ *

The request structure to tag a resource with a tag key and value.

*/ export interface TagResourceRequest { /** @@ -2534,67 +2561,67 @@ export interface TagResourceRequest { /** * @public - *

The tags used to tag the resource.

+ *

The tags used to tag the resource.

*/ tags: Record | undefined; } /** * @public - *

The response for the tag resource request.

+ *

The response for the tag resource request.

*/ export interface TagResourceResponse {} /** * @public - *

The request structure for the untag resource request.

+ *

The request structure for the untag resource request.

*/ export interface UntagResourceRequest { /** * @public - *

The Amazon Resource Name (ARN) to use to untag a resource.

+ *

The Amazon Resource Name (ARN) to use to untag a resource.

*/ resourceArn: string | undefined; /** * @public - *

The tag keys to use to untag a resource.

+ *

The tag keys to use to untag a resource.

*/ tagKeys: string[] | undefined; } /** * @public - *

The response for the untag resource request.

+ *

The response for the untag resource request.

*/ export interface UntagResourceResponse {} /** * @public - *

The request structure for the update app request.

+ *

The request structure for the update app request.

*/ export interface UpdateAppRequest { /** * @public - *

The unique ID for an Amplify app.

+ *

The unique ID for an Amplify app.

*/ appId: string | undefined; /** * @public - *

The name for an Amplify app.

+ *

The name for an Amplify app.

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

The description for an Amplify app.

+ *

The description for an Amplify app.

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

The platform for the Amplify app. For a static app, set the platform type to WEB. + *

The platform for the Amplify app. For a static app, set the platform type to WEB. * For a dynamic server-side rendered (SSR) app, set the platform type to * WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to * WEB_DYNAMIC.

@@ -2603,38 +2630,38 @@ export interface UpdateAppRequest { /** * @public - *

The AWS Identity and Access Management (IAM) service role for an Amplify app.

+ *

The AWS Identity and Access Management (IAM) service role for an Amplify app.

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

The environment variables for an Amplify app.

+ *

The environment variables for an Amplify app.

*/ environmentVariables?: Record; /** * @public - *

Enables branch auto-building for an Amplify app.

+ *

Enables branch auto-building for an Amplify app.

*/ enableBranchAutoBuild?: boolean; /** * @public - *

Automatically disconnects a branch in the Amplify Console when you delete a branch + *

Automatically disconnects a branch in the Amplify console when you delete a branch * from your Git repository.

*/ enableBranchAutoDeletion?: boolean; /** * @public - *

Enables basic authorization for an Amplify app.

+ *

Enables basic authorization for an Amplify app.

*/ enableBasicAuth?: boolean; /** * @public - *

The basic authorization credentials for an Amplify app. You must base64-encode the + *

The basic authorization credentials for an Amplify app. You must base64-encode the * authorization credentials and provide them in the format * user:password.

*/ @@ -2642,13 +2669,13 @@ export interface UpdateAppRequest { /** * @public - *

The custom redirect and rewrite rules for an Amplify app.

+ *

The custom redirect and rewrite rules for an Amplify app.

*/ customRules?: CustomRule[]; /** * @public - *

The build specification (build spec) for an Amplify app.

+ *

The build specification (build spec) for an Amplify app.

*/ buildSpec?: string; @@ -2660,25 +2687,25 @@ export interface UpdateAppRequest { /** * @public - *

Enables automated branch creation for an Amplify app.

+ *

Enables automated branch creation for an Amplify app.

*/ enableAutoBranchCreation?: boolean; /** * @public - *

Describes the automated branch creation glob patterns for an Amplify app.

+ *

Describes the automated branch creation glob patterns for an Amplify app.

*/ autoBranchCreationPatterns?: string[]; /** * @public - *

The automated branch creation configuration for an Amplify app.

+ *

The automated branch creation configuration for an Amplify app.

*/ autoBranchCreationConfig?: AutoBranchCreationConfig; /** * @public - *

The name of the repository for an Amplify app

+ *

The name of the Git repository for an Amplify app.

*/ repository?: string; @@ -2695,7 +2722,7 @@ export interface UpdateAppRequest { * update an app.

*

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub - * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the + * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the * Amplify User Guide .

*/ oauthToken?: string; @@ -2711,7 +2738,7 @@ export interface UpdateAppRequest { * update an app.

*

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub - * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the + * App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the * Amplify User Guide .

*/ accessToken?: string; @@ -2719,19 +2746,19 @@ export interface UpdateAppRequest { /** * @public - *

The result structure for an Amplify app update request.

+ *

The result structure for an Amplify app update request.

*/ export interface UpdateAppResult { /** * @public - *

Represents the updated Amplify app.

+ *

Represents the updated Amplify app.

*/ app: App | undefined; } /** * @public - *

The request structure for the update branch request.

+ *

The request structure for the update branch request.

*/ export interface UpdateBranchRequest { /** @@ -2742,7 +2769,7 @@ export interface UpdateBranchRequest { /** * @public - *

The name for the branch.

+ *

The name of the branch.

*/ branchName: string | undefined; @@ -2837,10 +2864,16 @@ export interface UpdateBranchRequest { /** * @public - *

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 an Amplify * app.

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

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

+ */ + backend?: Backend; } /** @@ -2913,36 +2946,36 @@ export interface UpdateDomainAssociationResult { /** * @public - *

The request structure for the update webhook request.

+ *

The request structure for the update webhook request.

*/ export interface UpdateWebhookRequest { /** * @public - *

The unique ID for a webhook.

+ *

The unique ID for a webhook.

*/ webhookId: string | undefined; /** * @public - *

The name for a branch that is part of an Amplify app.

+ *

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

+ *

The description for a webhook.

*/ description?: string; } /** * @public - *

The result structure for the update webhook request.

+ *

The result structure for the update webhook request.

*/ export interface UpdateWebhookResult { /** * @public - *

Describes a webhook that connects repository events to an Amplify app.

+ *

Describes a webhook that connects repository events to an Amplify app.

*/ webhook: Webhook | undefined; } diff --git a/clients/client-amplify/src/pagination/Interfaces.ts b/clients/client-amplify/src/pagination/Interfaces.ts new file mode 100644 index 0000000000000..cccdcd73a8d3e --- /dev/null +++ b/clients/client-amplify/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { AmplifyClient } from "../AmplifyClient"; + +/** + * @public + */ +export interface AmplifyPaginationConfiguration extends PaginationConfiguration { + client: AmplifyClient; +} diff --git a/clients/client-amplify/src/pagination/ListAppsPaginator.ts b/clients/client-amplify/src/pagination/ListAppsPaginator.ts new file mode 100644 index 0000000000000..e071db02e01cb --- /dev/null +++ b/clients/client-amplify/src/pagination/ListAppsPaginator.ts @@ -0,0 +1,46 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { AmplifyClient } from "../AmplifyClient"; +import { ListAppsCommand, ListAppsCommandInput, ListAppsCommandOutput } from "../commands/ListAppsCommand"; +import { AmplifyPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: AmplifyClient, + input: ListAppsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListAppsCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListApps( + config: AmplifyPaginationConfiguration, + input: ListAppsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListAppsCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof AmplifyClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Amplify | AmplifyClient"); + } + yield page; + const prevToken = token; + token = page.nextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-amplify/src/pagination/ListBranchesPaginator.ts b/clients/client-amplify/src/pagination/ListBranchesPaginator.ts new file mode 100644 index 0000000000000..d988b3f150fbc --- /dev/null +++ b/clients/client-amplify/src/pagination/ListBranchesPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { AmplifyClient } from "../AmplifyClient"; +import { + ListBranchesCommand, + ListBranchesCommandInput, + ListBranchesCommandOutput, +} from "../commands/ListBranchesCommand"; +import { AmplifyPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: AmplifyClient, + input: ListBranchesCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListBranchesCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListBranches( + config: AmplifyPaginationConfiguration, + input: ListBranchesCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListBranchesCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof AmplifyClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Amplify | AmplifyClient"); + } + yield page; + const prevToken = token; + token = page.nextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-amplify/src/pagination/ListDomainAssociationsPaginator.ts b/clients/client-amplify/src/pagination/ListDomainAssociationsPaginator.ts new file mode 100644 index 0000000000000..9dc13a4d522bd --- /dev/null +++ b/clients/client-amplify/src/pagination/ListDomainAssociationsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { AmplifyClient } from "../AmplifyClient"; +import { + ListDomainAssociationsCommand, + ListDomainAssociationsCommandInput, + ListDomainAssociationsCommandOutput, +} from "../commands/ListDomainAssociationsCommand"; +import { AmplifyPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: AmplifyClient, + input: ListDomainAssociationsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListDomainAssociationsCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListDomainAssociations( + config: AmplifyPaginationConfiguration, + input: ListDomainAssociationsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListDomainAssociationsCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof AmplifyClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Amplify | AmplifyClient"); + } + yield page; + const prevToken = token; + token = page.nextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-amplify/src/pagination/ListJobsPaginator.ts b/clients/client-amplify/src/pagination/ListJobsPaginator.ts new file mode 100644 index 0000000000000..00fb2a9bef718 --- /dev/null +++ b/clients/client-amplify/src/pagination/ListJobsPaginator.ts @@ -0,0 +1,46 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { AmplifyClient } from "../AmplifyClient"; +import { ListJobsCommand, ListJobsCommandInput, ListJobsCommandOutput } from "../commands/ListJobsCommand"; +import { AmplifyPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: AmplifyClient, + input: ListJobsCommandInput, + ...args: any +): Promise => { + // @ts-ignore + return await client.send(new ListJobsCommand(input), ...args); +}; +/** + * @public + */ +export async function* paginateListJobs( + config: AmplifyPaginationConfiguration, + input: ListJobsCommandInput, + ...additionalArguments: any +): Paginator { + // ToDo: replace with actual type instead of typeof input.nextToken + let token: typeof input.nextToken | undefined = config.startingToken || undefined; + let hasNext = true; + let page: ListJobsCommandOutput; + while (hasNext) { + input.nextToken = token; + input["maxResults"] = config.pageSize; + if (config.client instanceof AmplifyClient) { + page = await makePagedClientRequest(config.client, input, ...additionalArguments); + } else { + throw new Error("Invalid client, expected Amplify | AmplifyClient"); + } + yield page; + const prevToken = token; + token = page.nextToken; + hasNext = !!(token && (!config.stopOnSameToken || token !== prevToken)); + } + // @ts-ignore + return undefined; +} diff --git a/clients/client-amplify/src/pagination/index.ts b/clients/client-amplify/src/pagination/index.ts new file mode 100644 index 0000000000000..edf13839c74b2 --- /dev/null +++ b/clients/client-amplify/src/pagination/index.ts @@ -0,0 +1,6 @@ +// smithy-typescript generated code +export * from "./Interfaces"; +export * from "./ListAppsPaginator"; +export * from "./ListBranchesPaginator"; +export * from "./ListDomainAssociationsPaginator"; +export * from "./ListJobsPaginator"; diff --git a/clients/client-amplify/src/protocols/Aws_restJson1.ts b/clients/client-amplify/src/protocols/Aws_restJson1.ts index b9bdef8b0f89b..9427b3c76d852 100644 --- a/clients/client-amplify/src/protocols/Aws_restJson1.ts +++ b/clients/client-amplify/src/protocols/Aws_restJson1.ts @@ -93,6 +93,7 @@ import { AmplifyServiceException as __BaseException } from "../models/AmplifySer import { App, AutoBranchCreationConfig, + Backend, BackendEnvironment, BadRequestException, Branch, @@ -207,6 +208,7 @@ export const se_CreateBranchCommand = async ( let body: any; body = JSON.stringify( take(input, { + backend: (_) => _json(_), backendEnvironmentArn: [], basicAuthCredentials: [], branchName: [], @@ -1145,6 +1147,7 @@ export const se_UpdateBranchCommand = async ( let body: any; body = JSON.stringify( take(input, { + backend: (_) => _json(_), backendEnvironmentArn: [], basicAuthCredentials: [], buildSpec: [], @@ -3497,6 +3500,8 @@ const de_UnauthorizedExceptionRes = async ( // se_AutoSubDomainCreationPatterns omitted. +// se_Backend omitted. + // se_CustomRule omitted. // se_CustomRules omitted. @@ -3567,6 +3572,8 @@ const de_Apps = (output: any, context: __SerdeContext): App[] => { // de_AutoSubDomainCreationPatterns omitted. +// de_Backend omitted. + /** * deserializeAws_restJson1BackendEnvironment */ @@ -3600,6 +3607,7 @@ const de_Branch = (output: any, context: __SerdeContext): Branch => { return take(output, { activeJobId: __expectString, associatedResources: _json, + backend: _json, backendEnvironmentArn: __expectString, basicAuthCredentials: __expectString, branchArn: __expectString, diff --git a/codegen/sdk-codegen/aws-models/amplify.json b/codegen/sdk-codegen/aws-models/amplify.json index 9dbcaa9531a96..f261fafd87a3b 100644 --- a/codegen/sdk-codegen/aws-models/amplify.json +++ b/codegen/sdk-codegen/aws-models/amplify.json @@ -177,7 +177,7 @@ "name": "amplify" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n The Amplify Console provides a continuous delivery and hosting service for web\n applications. For more information, see the Amplify Console User Guide. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework.\n

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

Amplify enables developers to develop and deploy cloud-powered mobile and web apps.\n Amplify Hosting provides a continuous delivery and hosting service for web\n applications. For more information, see the Amplify Hosting User Guide. The\n Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation\n for client app development. For more information, see the Amplify Framework.\n

", "smithy.api#title": "AWS Amplify", "smithy.api#xmlNamespace": { "uri": "http://amplify.amazonaws.com" @@ -1052,127 +1052,127 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID of the Amplify app.

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

The unique ID of the Amplify app.

", "smithy.api#required": {} } }, "appArn": { "target": "com.amazonaws.amplify#AppArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Amplify app.

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

The Amazon Resource Name (ARN) of the Amplify app.

", "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for the Amplify app.

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

The name for the Amplify app.

", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The tag for the Amplify app.

" + "smithy.api#documentation": "

The tag for the Amplify app.

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

The description for the Amplify app.

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

The description for the Amplify app.

", "smithy.api#required": {} } }, "repository": { "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "

The Git repository for the Amplify app.

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

The Git repository for the Amplify app.

", "smithy.api#required": {} } }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

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

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

Creates a date and time for the Amplify app.

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

Creates a date and time for the Amplify app.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

Updates the date and time for the Amplify app.

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

Updates the date and time for the Amplify app.

", "smithy.api#required": {} } }, "iamServiceRoleArn": { "target": "com.amazonaws.amplify#ServiceRoleArn", "traits": { - "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.

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

The environment variables for the Amplify app.

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

The environment variables for the Amplify app.

\n

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

", "smithy.api#required": {} } }, "defaultDomain": { "target": "com.amazonaws.amplify#DefaultDomain", "traits": { - "smithy.api#documentation": "

The default domain for the Amplify app.

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

The default domain for the Amplify app.

", "smithy.api#required": {} } }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { - "smithy.api#documentation": "

Enables the auto-building of branches for the Amplify app.

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

Enables the auto-building of branches for the Amplify app.

", "smithy.api#required": {} } }, "enableBranchAutoDeletion": { "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnect a branch in the Amplify console when you delete a branch\n from your Git repository.

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

Enables basic authorization for the Amplify app's branches.

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

Enables basic authorization for the Amplify app's branches.

", "smithy.api#required": {} } }, "basicAuthCredentials": { "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for branches for the Amplify app. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

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

Describes the custom redirect and rewrite rules for the Amplify app.

" + "smithy.api#documentation": "

Describes the custom redirect and rewrite rules for the Amplify app.

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

Describes the information about a production branch of the Amplify app.

" + "smithy.api#documentation": "

Describes the information about a production branch of the Amplify app.

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

Describes the content of the build specification (build spec) for the Amplify app.\n

" + "smithy.api#documentation": "

Describes the content of the build specification (build spec) for the Amplify app.\n

" } }, "customHeaders": { @@ -1184,19 +1184,19 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for the Amplify app.

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

Describes the automated branch creation glob patterns for the Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation glob patterns for the Amplify app.

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

Describes the automated branch creation configuration for the Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation configuration for the Amplify app.

" } }, "repositoryCloneMethod": { @@ -1207,7 +1207,7 @@ } }, "traits": { - "smithy.api#documentation": "

Represents the different branches of a repository for building, deploying, and\n hosting an Amplify app.

" + "smithy.api#documentation": "

Represents the different branches of a repository for building, deploying, and\n hosting an Amplify app.

" } }, "com.amazonaws.amplify#AppArn": { @@ -1241,20 +1241,20 @@ "artifactFileName": { "target": "com.amazonaws.amplify#ArtifactFileName", "traits": { - "smithy.api#documentation": "

The file name for the artifact.

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

The file name for the artifact.

", "smithy.api#required": {} } }, "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for the artifact.

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

The unique ID for the artifact.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes an artifact.

" + "smithy.api#documentation": "

Describes an artifact.

" } }, "com.amazonaws.amplify#ArtifactFileName": { @@ -1321,37 +1321,37 @@ "stage": { "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

" + "smithy.api#documentation": "

Describes the current stage for the autocreated branch.

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

The framework for the autocreated branch.

" + "smithy.api#documentation": "

The framework for the autocreated branch.

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

Enables auto building for the autocreated branch.

" + "smithy.api#documentation": "

Enables auto building for the autocreated branch.

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

The environment variables for the autocreated branch.

" + "smithy.api#documentation": "

The environment variables for the autocreated branch.

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

The basic authorization credentials for the autocreated branch. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for the autocreated branch. You must\n base64-encode the authorization credentials and provide them in the format\n user:password.

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

Enables basic authorization for the autocreated branch.

" + "smithy.api#documentation": "

Enables basic authorization for the autocreated branch.

" } }, "enablePerformanceMode": { @@ -1363,24 +1363,24 @@ "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

" + "smithy.api#documentation": "

The build specification (build spec) for the autocreated branch.

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

Enables pull request previews for the autocreated branch.

" + "smithy.api#documentation": "

Enables pull request previews for the autocreated branch.

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

The Amplify environment name for the pull request.

" + "smithy.api#documentation": "

The Amplify environment name for the pull request.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the automated branch creation configuration.

" + "smithy.api#documentation": "

Describes the automated branch creation configuration.

" } }, "com.amazonaws.amplify#AutoBranchCreationPattern": { @@ -1425,52 +1425,66 @@ "smithy.api#pattern": "^$|^arn:aws:iam::\\d{12}:role.+$" } }, + "com.amazonaws.amplify#Backend": { + "type": "structure", + "members": { + "stackArn": { + "target": "com.amazonaws.amplify#StackArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the CloudFormation stack.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the backend properties associated with an Amplify Branch.

" + } + }, "com.amazonaws.amplify#BackendEnvironment": { "type": "structure", "members": { "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\n app.

", "smithy.api#required": {} } }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for a backend environment that is part of an Amplify app.

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

The name for a backend environment that is part of an Amplify app.

", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" + "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

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

The name of deployment artifacts.

" + "smithy.api#documentation": "

The name of deployment artifacts.

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

The creation date and time for a backend environment that is part of an Amplify app.\n

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

The creation date and time for a backend environment that is part of an Amplify app.\n

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

The last updated date and time for a backend environment that is part of an Amplify\n app.

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

The last updated date and time for a backend environment that is part of an Amplify\n app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

" + "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

" } }, "com.amazonaws.amplify#BackendEnvironmentArn": { @@ -1497,7 +1511,7 @@ } }, "traits": { - "smithy.api#documentation": "

A request contains unexpected data.

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

A request contains unexpected data.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -1694,6 +1708,9 @@ "traits": { "smithy.api#documentation": "

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

" } + }, + "backend": { + "target": "com.amazonaws.amplify#Backend" } }, "traits": { @@ -1735,7 +1752,7 @@ "com.amazonaws.amplify#BuildSpec": { "type": "string", "traits": { - "smithy.api#documentation": "

The build specification (build spec) file for an Amplify app build.

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

The build specification (build spec) file for an Amplify app build.

", "smithy.api#length": { "min": 1, "max": 25000 @@ -1818,7 +1835,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new Amplify app.

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

Creates a new Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps", @@ -1832,92 +1849,92 @@ "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for an Amplify app.

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

The name of the Amplify app.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

The description for an Amplify app.

" + "smithy.api#documentation": "

The description of the Amplify app.

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

The repository for an Amplify app.

" + "smithy.api#documentation": "

The Git repository for the Amplify app.

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

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

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

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

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

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n create a new app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

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

The environment variables map for an Amplify app.

" + "smithy.api#documentation": "

The environment variables map for an Amplify app.

\n

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide.

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

Enables the auto building of branches for an Amplify app.

" + "smithy.api#documentation": "

Enables the auto building of branches for an Amplify app.

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

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.

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

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.

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

The credentials for basic authorization for an Amplify app. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The credentials for basic authorization for an Amplify app. You must base64-encode\n the authorization credentials and provide them in the format\n user:password.

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

The custom rewrite and redirect rules for an Amplify app.

" + "smithy.api#documentation": "

The custom rewrite and redirect rules for an Amplify app.

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

The tag for an Amplify app.

" + "smithy.api#documentation": "

The tag for an Amplify app.

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

The build specification (build spec) for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "customHeaders": { @@ -1929,24 +1946,24 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

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

The automated branch creation glob patterns for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation glob patterns for an Amplify app.

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

The automated branch creation configuration for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

" } } }, "traits": { - "smithy.api#documentation": "

The request structure used to create apps in Amplify.

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

The request structure used to create apps in Amplify.

", "smithy.api#input": {} } }, @@ -1990,7 +2007,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.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/backendenvironments", @@ -2004,7 +2021,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2012,25 +2029,25 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The name for the backend environment.

", "smithy.api#required": {} } }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { - "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

" + "smithy.api#documentation": "

The AWS CloudFormation stack name of a backend environment.

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

The name of deployment artifacts.

" + "smithy.api#documentation": "

The name of deployment artifacts.

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the backend environment create request.

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

The request structure for the backend environment create request.

", "smithy.api#input": {} } }, @@ -2040,13 +2057,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the create backend environment request.

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

The result structure for the create backend environment request.

", "smithy.api#output": {} } }, @@ -2101,20 +2118,20 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name for the branch.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

The description for the branch.

" + "smithy.api#documentation": "

The description for the branch.

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

Describes the current stage for the branch.

" + "smithy.api#documentation": "

Describes the current stage for the branch.

" } }, "framework": { @@ -2198,7 +2215,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 an Amplify\n app.

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

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

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

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository.

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

Creates a deployment for a manually deployed Amplify app. Manually deployed apps are\n not connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the\n StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments", @@ -2268,7 +2291,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2448,7 +2471,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a new webhook on an Amplify app.

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

Creates a new webhook on an Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/webhooks", @@ -2462,7 +2485,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2470,19 +2493,19 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The name for a branch that is part of an Amplify app.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

The description for a webhook.

" + "smithy.api#documentation": "

The description for a webhook.

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the create webhook request.

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

The request structure for the create webhook request.

", "smithy.api#input": {} } }, @@ -2492,13 +2515,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the create webhook request.

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

The result structure for the create webhook request.

", "smithy.api#output": {} } }, @@ -2539,32 +2562,32 @@ "source": { "target": "com.amazonaws.amplify#Source", "traits": { - "smithy.api#documentation": "

The source pattern for a URL rewrite or redirect rule.

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

The source pattern for a URL rewrite or redirect rule.

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

The target pattern for a URL rewrite or redirect rule.

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

The target pattern for a URL rewrite or redirect rule.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.amplify#Status", "traits": { - "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

\n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future\n requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

\n
\n
" + "smithy.api#documentation": "

The status code for a URL rewrite or redirect rule.

\n
\n
200
\n
\n

Represents a 200 rewrite rule.

\n
\n
301
\n
\n

Represents a 301 (moved pemanently) redirect rule. This and all future\n requests should be directed to the target URL.

\n
\n
302
\n
\n

Represents a 302 temporary redirect rule.

\n
\n
404
\n
\n

Represents a 404 redirect rule.

\n
\n
404-200
\n
\n

Represents a 404 rewrite rule.

\n
\n
" } }, "condition": { "target": "com.amazonaws.amplify#Condition", "traits": { - "smithy.api#documentation": "

The condition for a URL rewrite or redirect rule, such as a country code.

" + "smithy.api#documentation": "

The condition for a URL rewrite or redirect rule, such as a country code.

" } } }, "traits": { - "smithy.api#documentation": "

Describes a custom rewrite or redirect rule.

" + "smithy.api#documentation": "

Describes a custom rewrite or redirect rule.

" } }, "com.amazonaws.amplify#CustomRules": { @@ -2617,7 +2640,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes an existing Amplify app specified by an app ID.

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

Deletes an existing Amplify app specified by an app ID.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}", @@ -2631,14 +2654,14 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes the request structure for the delete app request.

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

Describes the request structure for the delete app request.

", "smithy.api#input": {} } }, @@ -2653,7 +2676,7 @@ } }, "traits": { - "smithy.api#documentation": "

The result structure for the delete app request.

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

The result structure for the delete app request.

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

Deletes a backend environment for an Amplify app.

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

Deletes a backend environment for an Amplify app.

", "smithy.api#http": { "method": "DELETE", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -2697,7 +2720,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID of an Amplify app.

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

The unique ID of an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2705,14 +2728,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name of a backend environment of an Amplify app.

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

The name of a backend environment of an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the delete backend environment request.

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

The request structure for the delete backend environment request.

", "smithy.api#input": {} } }, @@ -2722,13 +2745,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure of the delete backend environment result.

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

The result structure of the delete backend environment result.

", "smithy.api#output": {} } }, @@ -2780,7 +2803,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2797,13 +2820,13 @@ "branch": { "target": "com.amazonaws.amplify#Branch", "traits": { - "smithy.api#documentation": "

The branch for an Amplify app, which maps to a third-party repository branch.

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

The branch for an Amplify app, which maps to a third-party repository branch.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the delete branch request.

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

The result structure for the delete branch request.

", "smithy.api#output": {} } }, @@ -2928,7 +2951,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2988,7 +3011,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes a webhook.

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

Deletes a webhook.

", "smithy.api#http": { "method": "DELETE", "uri": "/webhooks/{webhookId}", @@ -3002,14 +3025,14 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the delete webhook request.

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

The request structure for the delete webhook request.

", "smithy.api#input": {} } }, @@ -3019,13 +3042,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the delete webhook request.

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

The result structure for the delete webhook request.

", "smithy.api#output": {} } }, @@ -3037,7 +3060,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed because a dependent service threw an exception.

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

An operation failed because a dependent service threw an exception.

", "smithy.api#error": "server", "smithy.api#httpError": 503 } @@ -3373,7 +3396,7 @@ } ], "traits": { - "smithy.api#documentation": "

Returns the website access logs for a specific time range using a presigned URL.\n

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

Returns the website access logs for a specific time range using a presigned URL.\n

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/accesslogs", @@ -3387,33 +3410,33 @@ "startTime": { "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

" + "smithy.api#documentation": "

The time at which the logs should start. The time range specified is inclusive of the\n start time.

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

The time at which the logs should end. The time range specified is inclusive of the\n end time.

" + "smithy.api#documentation": "

The time at which the logs should end. The time range specified is inclusive of the\n end time.

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

The name of the domain.

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

The name of the domain.

", "smithy.api#required": {} } }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the generate access logs request.

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

The request structure for the generate access logs request.

", "smithy.api#input": {} } }, @@ -3423,12 +3446,12 @@ "logUrl": { "target": "com.amazonaws.amplify#LogUrl", "traits": { - "smithy.api#documentation": "

The pre-signed URL for the requested access logs.

" + "smithy.api#documentation": "

The pre-signed URL for the requested access logs.

" } } }, "traits": { - "smithy.api#documentation": "

The result structure for the generate access logs request.

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

The result structure for the generate access logs request.

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

Returns an existing Amplify app by appID.

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

Returns an existing Amplify app specified by an app ID.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}", @@ -3469,14 +3492,14 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the get app request.

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

The request structure for the get app request.

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

Returns the artifact info that corresponds to an artifact id.

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

Returns the artifact info that corresponds to an artifact id.

", "smithy.api#http": { "method": "GET", "uri": "/artifacts/{artifactId}", @@ -3534,14 +3557,14 @@ "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for an artifact.

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

The unique ID for an artifact.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Returns the request structure for the get artifact request.

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

Returns the request structure for the get artifact request.

", "smithy.api#input": {} } }, @@ -3551,20 +3574,20 @@ "artifactId": { "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "

The unique ID for an artifact.

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

The unique ID for an artifact.

", "smithy.api#required": {} } }, "artifactUrl": { "target": "com.amazonaws.amplify#ArtifactUrl", "traits": { - "smithy.api#documentation": "

The presigned URL for the artifact.

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

The presigned URL for the artifact.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Returns the result structure for the get artifact request.

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

Returns the result structure for the get artifact request.

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

Returns a backend environment for an Amplify app.

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

Returns a backend environment for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments/{environmentName}", @@ -3605,7 +3628,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique id for an Amplify app.

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

The unique id for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3613,14 +3636,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name for the backend environment.

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

The name for the backend environment.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the get backend environment request.

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

The request structure for the get backend environment request.

", "smithy.api#input": {} } }, @@ -3630,13 +3653,13 @@ "backendEnvironment": { "target": "com.amazonaws.amplify#BackendEnvironment", "traits": { - "smithy.api#documentation": "

Describes the backend environment for an Amplify app.

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

Describes the backend environment for an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the get backend environment result.

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

The result structure for the get backend environment result.

", "smithy.api#output": {} } }, @@ -3685,7 +3708,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3822,7 +3845,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3830,7 +3853,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The branch name for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3838,14 +3861,14 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for the job.

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

The unique ID for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the get job request.

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

The request structure for the get job request.

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

Returns the webhook information that corresponds to a specified webhook ID.

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

Returns the webhook information that corresponds to a specified webhook ID.

", "smithy.api#http": { "method": "GET", "uri": "/webhooks/{webhookId}", @@ -3903,14 +3926,14 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the get webhook request.

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

The request structure for the get webhook request.

", "smithy.api#input": {} } }, @@ -3920,13 +3943,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes the structure of a webhook.

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

Describes the structure of a webhook.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the get webhook request.

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

The result structure for the get webhook request.

", "smithy.api#output": {} } }, @@ -3938,7 +3961,7 @@ } }, "traits": { - "smithy.api#documentation": "

The service failed to perform an operation due to an internal issue.

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

The service failed to perform an operation due to an internal issue.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } @@ -4163,7 +4186,7 @@ } }, "traits": { - "smithy.api#documentation": "

A resource could not be created because service quotas were exceeded.

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

A resource could not be created because service quotas were exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -4188,11 +4211,17 @@ } ], "traits": { - "smithy.api#documentation": "

Returns a list of the existing Amplify apps.

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

Returns a list of the existing Amplify apps.

", "smithy.api#http": { "method": "GET", "uri": "/apps", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "apps", + "pageSize": "maxResults" } } }, @@ -4202,7 +4231,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

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

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4210,13 +4239,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the list apps request.

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

The request structure for the list apps request.

", "smithy.api#input": {} } }, @@ -4226,19 +4255,19 @@ "apps": { "target": "com.amazonaws.amplify#Apps", "traits": { - "smithy.api#documentation": "

A list of Amplify apps.

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

A list of Amplify apps.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

" + "smithy.api#documentation": "

A pagination token. Set to null to start listing apps from start. If non-null, the\n pagination token is returned in a result. Pass its value in here to list more projects.\n

" } } }, "traits": { - "smithy.api#documentation": "

The result structure for an Amplify app list request.

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

The result structure for an Amplify app list request.

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

Returns a list of artifacts for a specified app, branch, and job.

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

Returns a list of artifacts for a specified app, branch, and job.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts", @@ -4279,7 +4308,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4287,7 +4316,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name of a branch that is part of an Amplify app.

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

The name of a branch that is part of an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4295,7 +4324,7 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for a job.

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

The unique ID for a job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4303,7 +4332,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

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

A pagination token. Set to null to start listing artifacts from start. If a non-null\n pagination token is returned in a result, pass its value in here to list more artifacts.\n

", "smithy.api#httpQuery": "nextToken" } }, @@ -4311,13 +4340,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "

Describes the request structure for the list artifacts request.

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

Describes the request structure for the list artifacts request.

", "smithy.api#input": {} } }, @@ -4327,19 +4356,19 @@ "artifacts": { "target": "com.amazonaws.amplify#Artifacts", "traits": { - "smithy.api#documentation": "

A list of artifacts.

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

A list of artifacts.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" } } }, "traits": { - "smithy.api#documentation": "

The result structure for the list artifacts request.

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

The result structure for the list artifacts request.

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

Lists the backend environments for an Amplify app.

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

Lists the backend environments for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/backendenvironments", @@ -4377,7 +4406,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4385,14 +4414,14 @@ "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "

The name of the backend environment

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

The name of the backend environment

", "smithy.api#httpQuery": "environmentName" } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

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

A pagination token. Set to null to start listing backend environments from the start.\n If a non-null pagination token is returned in a result, pass its value in here to list\n more backend environments.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4400,13 +4429,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the list backend environments request.

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

The request structure for the list backend environments request.

", "smithy.api#input": {} } }, @@ -4416,19 +4445,19 @@ "backendEnvironments": { "target": "com.amazonaws.amplify#BackendEnvironments", "traits": { - "smithy.api#documentation": "

The list of backend environments for an Amplify app.

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

The list of backend environments for an Amplify app.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If a non-null pagination token is returned in a result, pass its\n value in another request to retrieve more entries.

" } } }, "traits": { - "smithy.api#documentation": "

The result structure for the list backend environments result.

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

The result structure for the list backend environments result.

", "smithy.api#output": {} } }, @@ -4457,6 +4486,12 @@ "method": "GET", "uri": "/apps/{appId}/branches", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "branches", + "pageSize": "maxResults" } } }, @@ -4466,7 +4501,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4474,7 +4509,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches.

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

A pagination token. Set to null to start listing branches from the start. If a\n non-null pagination token is returned in a result, pass its value in here to list more\n branches.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4488,7 +4523,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request structure for the list branches request.

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

The request structure for the list branches request.

", "smithy.api#input": {} } }, @@ -4539,6 +4574,12 @@ "method": "GET", "uri": "/apps/{appId}/domains", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "domainAssociations", + "pageSize": "maxResults" } } }, @@ -4624,6 +4665,12 @@ "method": "GET", "uri": "/apps/{appId}/branches/{branchName}/jobs", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "jobSummaries", + "pageSize": "maxResults" } } }, @@ -4641,7 +4688,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch.

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

The name of the branch to use for the request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4649,7 +4696,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

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

A pagination token. Set to null to start listing steps from the start. If a non-null\n pagination token is returned in a result, pass its value in here to list more steps.\n

", "smithy.api#httpQuery": "nextToken" } }, @@ -4657,7 +4704,7 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } @@ -4673,19 +4720,19 @@ "jobSummaries": { "target": "com.amazonaws.amplify#JobSummaries", "traits": { - "smithy.api#documentation": "

The result structure for the list job result request.

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

The result structure for the list job result request.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If non-null the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" } } }, "traits": { - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

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

Returns a list of tags for a specified Amazon Resource Name (ARN).

", "smithy.api#http": { "method": "GET", "uri": "/tags/{resourceArn}", @@ -4723,14 +4770,14 @@ "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use to list tags.

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

The Amazon Resource Name (ARN) to use to list tags.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure to use to list tags for a resource.

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

The request structure to use to list tags for a resource.

", "smithy.api#input": {} } }, @@ -4740,12 +4787,12 @@ "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

A list of tags for the specified The Amazon Resource Name (ARN).

" + "smithy.api#documentation": "

A list of tags for the specified The Amazon Resource Name (ARN).

" } } }, "traits": { - "smithy.api#documentation": "

The response for the list tags for resource request.

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

The response for the list tags for resource request.

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

Returns a list of webhooks for an Amplify app.

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

Returns a list of webhooks for an Amplify app.

", "smithy.api#http": { "method": "GET", "uri": "/apps/{appId}/webhooks", @@ -4786,7 +4833,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4794,7 +4841,7 @@ "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks.

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

A pagination token. Set to null to start listing webhooks from the start. If\n non-null,the pagination token is returned in a result. Pass its value in here to list\n more webhooks.

", "smithy.api#httpQuery": "nextToken" } }, @@ -4802,13 +4849,13 @@ "target": "com.amazonaws.amplify#MaxResults", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "

The maximum number of records to list in a single response.

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

The maximum number of records to list in a single response.

", "smithy.api#httpQuery": "maxResults" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the list webhooks request.

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

The request structure for the list webhooks request.

", "smithy.api#input": {} } }, @@ -4818,19 +4865,19 @@ "webhooks": { "target": "com.amazonaws.amplify#Webhooks", "traits": { - "smithy.api#documentation": "

A list of webhooks.

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

A list of webhooks.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" + "smithy.api#documentation": "

A pagination token. If non-null, the pagination token is returned in a result. Pass\n its value in another request to retrieve more entries.

" } } }, "traits": { - "smithy.api#documentation": "

The result structure for the list webhooks request.

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

The result structure for the list webhooks request.

", "smithy.api#output": {} } }, @@ -4891,7 +4938,7 @@ } }, "traits": { - "smithy.api#documentation": "

An entity was not found during an operation.

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

An entity was not found during an operation.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -4936,30 +4983,30 @@ "lastDeployTime": { "target": "com.amazonaws.amplify#LastDeployTime", "traits": { - "smithy.api#documentation": "

The last deploy time of the production branch.

" + "smithy.api#documentation": "

The last deploy time of the production branch.

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

The status of the production branch.

" + "smithy.api#documentation": "

The status of the production branch.

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

The thumbnail URL for the production branch.

" + "smithy.api#documentation": "

The thumbnail URL for the production branch.

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

The branch name for the production branch.

" + "smithy.api#documentation": "

The branch name for the production branch.

" } } }, "traits": { - "smithy.api#documentation": "

Describes the information about a production branch for an Amplify app.

" + "smithy.api#documentation": "

Describes the information about a production branch for an Amplify app.

" } }, "com.amazonaws.amplify#PullRequestEnvironmentName": { @@ -5032,7 +5079,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed due to a non-existent resource.

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

An operation failed due to a non-existent resource.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -5076,6 +5123,16 @@ "smithy.api#pattern": "^(?s)" } }, + "com.amazonaws.amplify#StackArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws:cloudformation:[a-z0-9-]+:\\d{12}:stack/.+/.+$" + } + }, "com.amazonaws.amplify#StackName": { "type": "string", "traits": { @@ -5147,7 +5204,7 @@ } ], "traits": { - "smithy.api#documentation": "

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository.

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

Starts a deployment for a manually deployed app. Manually deployed apps are not\n connected to a repository.

\n

The maximum duration between the CreateDeployment call and the\n StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the\n StartDeployment call and the associated Job will\n fail.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}/branches/{branchName}/deployments/start", @@ -5161,7 +5218,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5169,7 +5226,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5177,18 +5234,18 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

" + "smithy.api#documentation": "

The job ID for this deployment, generated by the create deployment request.

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

The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file.

" + "smithy.api#documentation": "

The source URL for this deployment, used when calling start deployment without create\n deployment. The source URL can be any HTTP GET URL that is publicly accessible and\n downloads a single .zip file.

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the start a deployment request.

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

The request structure for the start a deployment request.

", "smithy.api#input": {} } }, @@ -5198,13 +5255,13 @@ "jobSummary": { "target": "com.amazonaws.amplify#JobSummary", "traits": { - "smithy.api#documentation": "

The summary for the job.

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

The summary for the job.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the start a deployment request.

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

The result structure for the start a deployment request.

", "smithy.api#output": {} } }, @@ -5248,7 +5305,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5256,7 +5313,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The branch name for the job.

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

The name of the branch to use for the job.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5264,20 +5321,20 @@ "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

" + "smithy.api#documentation": "

The unique ID for an existing job. This is required if the value of\n jobType is RETRY.

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

Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository. The job type RETRY retries an existing\n job. If the job type value is RETRY, the jobId is also\n required.

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

Describes the type for the job. The job type RELEASE starts a new job\n with the latest change from the specified branch. This value is available only for apps\n that are connected to a repository.

\n

The job type RETRY retries an existing\n job. If the job type value is RETRY, the jobId is also\n required.

", "smithy.api#required": {} } }, "jobReason": { "target": "com.amazonaws.amplify#JobReason", "traits": { - "smithy.api#documentation": "

A descriptive reason for starting this job.

" + "smithy.api#documentation": "

A descriptive reason for starting the job.

" } }, "commitId": { @@ -5300,7 +5357,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request structure for the start job request.

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

The request structure for the start job request.

", "smithy.api#input": {} } }, @@ -5483,7 +5540,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch, for the job.

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

The name of the branch to use for the stop job request.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5596,7 +5653,7 @@ "com.amazonaws.amplify#TTL": { "type": "string", "traits": { - "smithy.api#documentation": "

The content Time to Live (TTL) for the website in seconds.

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

The content Time to Live (TTL) for the website in seconds.

", "smithy.api#length": { "min": 0, "max": 32 @@ -5661,7 +5718,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags the resource with a tag key and value.

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

Tags the resource with a tag key and value.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -5683,13 +5740,13 @@ "tags": { "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "

The tags used to tag the resource.

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

The tags used to tag the resource.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure to tag a resource with a tag key and value.

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

The request structure to tag a resource with a tag key and value.

", "smithy.api#input": {} } }, @@ -5697,7 +5754,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The response for the tag resource request.

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

The response for the tag resource request.

", "smithy.api#output": {} } }, @@ -5774,7 +5831,7 @@ } }, "traits": { - "smithy.api#documentation": "

An operation failed due to a lack of access.

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

An operation failed due to a lack of access.

", "smithy.api#error": "client", "smithy.api#httpError": 401 } @@ -5799,7 +5856,7 @@ } ], "traits": { - "smithy.api#documentation": "

Untags a resource with a specified Amazon Resource Name (ARN).

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

Untags a resource with a specified Amazon Resource Name (ARN).

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{resourceArn}", @@ -5813,7 +5870,7 @@ "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use to untag a resource.

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

The Amazon Resource Name (ARN) to use to untag a resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5821,14 +5878,14 @@ "tagKeys": { "target": "com.amazonaws.amplify#TagKeyList", "traits": { - "smithy.api#documentation": "

The tag keys to use to untag a resource.

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

The tag keys to use to untag a resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The request structure for the untag resource request.

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

The request structure for the untag resource request.

", "smithy.api#input": {} } }, @@ -5836,7 +5893,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "

The response for the untag resource request.

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

The response for the untag resource request.

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

Updates an existing Amplify app.

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

Updates an existing Amplify app.

", "smithy.api#http": { "method": "POST", "uri": "/apps/{appId}", @@ -5877,7 +5934,7 @@ "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "

The unique ID for an Amplify app.

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

The unique ID for an Amplify app.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5885,67 +5942,67 @@ "name": { "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "

The name for an Amplify app.

" + "smithy.api#documentation": "

The name for an Amplify app.

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

The description for an Amplify app.

" + "smithy.api#documentation": "

The description for an Amplify app.

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

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

" + "smithy.api#documentation": "

The platform for the Amplify app. For a static app, set the platform type to WEB.\n For a dynamic server-side rendered (SSR) app, set the platform type to\n WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to\n WEB_DYNAMIC.

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

The AWS Identity and Access Management (IAM) service role for an Amplify app.

" + "smithy.api#documentation": "

The AWS Identity and Access Management (IAM) service role for an Amplify app.

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

The environment variables for an Amplify app.

" + "smithy.api#documentation": "

The environment variables for an Amplify app.

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

Enables branch auto-building for an Amplify app.

" + "smithy.api#documentation": "

Enables branch auto-building for an Amplify app.

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

Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.

" + "smithy.api#documentation": "

Automatically disconnects a branch in the Amplify console when you delete a branch\n from your Git repository.

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

Enables basic authorization for an Amplify app.

" + "smithy.api#documentation": "

Enables basic authorization for an Amplify app.

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

The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

" + "smithy.api#documentation": "

The basic authorization credentials for an Amplify app. You must base64-encode the\n authorization credentials and provide them in the format\n user:password.

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

The custom redirect and rewrite rules for an Amplify app.

" + "smithy.api#documentation": "

The custom redirect and rewrite rules for an Amplify app.

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

The build specification (build spec) for an Amplify app.

" + "smithy.api#documentation": "

The build specification (build spec) for an Amplify app.

" } }, "customHeaders": { @@ -5957,42 +6014,42 @@ "enableAutoBranchCreation": { "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

" + "smithy.api#documentation": "

Enables automated branch creation for an Amplify app.

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

Describes the automated branch creation glob patterns for an Amplify app.

" + "smithy.api#documentation": "

Describes the automated branch creation glob patterns for an Amplify app.

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

The automated branch creation configuration for an Amplify app.

" + "smithy.api#documentation": "

The automated branch creation configuration for an Amplify app.

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

The name of the repository for an Amplify app

" + "smithy.api#documentation": "

The name of the Git repository for an Amplify app.

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

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.

\n

To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The OAuth token for a third-party source control system for an Amplify app. The OAuth\n token is used to create a webhook and a read-only deploy key using SSH cloning. The\n OAuth token is not stored.

\n

Use oauthToken for repository providers other than GitHub, such as\n Bitbucket or CodeCommit.

\n

To authorize access to GitHub as your repository provider, use\n accessToken.

\n

You must specify either oauthToken or accessToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

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

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" + "smithy.api#documentation": "

The personal access token for a GitHub repository for an Amplify app. The personal\n access token is used to authorize access to a GitHub repository using the Amplify GitHub\n App. The token is not stored.

\n

Use accessToken for GitHub repositories only. To authorize access to a\n repository provider such as Bitbucket or CodeCommit, use oauthToken.

\n

You must specify either accessToken or oauthToken when you\n update an app.

\n

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work\n with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub\n App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the\n Amplify User Guide .

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the update app request.

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

The request structure for the update app request.

", "smithy.api#input": {} } }, @@ -6002,13 +6059,13 @@ "app": { "target": "com.amazonaws.amplify#App", "traits": { - "smithy.api#documentation": "

Represents the updated Amplify app.

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

Represents the updated Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for an Amplify app update request.

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

The result structure for an Amplify app update request.

", "smithy.api#output": {} } }, @@ -6060,7 +6117,7 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for the branch.

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

The name of the branch.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6152,12 +6209,18 @@ "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\n app.

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

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

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the update branch request.

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

The request structure for the update branch request.

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

Updates a webhook.

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

Updates a webhook.

", "smithy.api#http": { "method": "POST", "uri": "/webhooks/{webhookId}", @@ -6319,7 +6382,7 @@ "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The unique ID for a webhook.

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

The unique ID for a webhook.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6327,18 +6390,18 @@ "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

" + "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The description for a webhook.

" + "smithy.api#documentation": "

The description for a webhook.

" } } }, "traits": { - "smithy.api#documentation": "

The request structure for the update webhook request.

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

The request structure for the update webhook request.

", "smithy.api#input": {} } }, @@ -6348,13 +6411,13 @@ "webhook": { "target": "com.amazonaws.amplify#Webhook", "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

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

Describes a webhook that connects repository events to an Amplify app.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The result structure for the update webhook request.

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

The result structure for the update webhook request.

", "smithy.api#output": {} } }, @@ -6376,55 +6439,55 @@ "webhookArn": { "target": "com.amazonaws.amplify#WebhookArn", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the webhook.

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

The Amazon Resource Name (ARN) for the webhook.

", "smithy.api#required": {} } }, "webhookId": { "target": "com.amazonaws.amplify#WebhookId", "traits": { - "smithy.api#documentation": "

The ID of the webhook.

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

The ID of the webhook.

", "smithy.api#required": {} } }, "webhookUrl": { "target": "com.amazonaws.amplify#WebhookUrl", "traits": { - "smithy.api#documentation": "

The URL of the webhook.

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

The URL of the webhook.

", "smithy.api#required": {} } }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "

The name for a branch that is part of an Amplify app.

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

The name for a branch that is part of an Amplify app.

", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "

The description for a webhook.

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

The description for a webhook.

", "smithy.api#required": {} } }, "createTime": { "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "

The create date and time for a webhook.

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

The create date and time for a webhook.

", "smithy.api#required": {} } }, "updateTime": { "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "

Updates the date and time for a webhook.

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

Updates the date and time for a webhook.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

" + "smithy.api#documentation": "

Describes a webhook that connects repository events to an Amplify app.

" } }, "com.amazonaws.amplify#WebhookArn": {