feat(client-amplify): Add backend field to CreateBranch and UpdateBra…

…nch requests. Add pagination support for ListApps, ListDomainAssociations, ListBranches, and ListJobs
aws · Oct 31, 2023 · df2f16b · df2f16b
1 parent 1c2b78d
commit df2f16b
Show file tree

Hide file tree

Showing 50 changed files with 1,053 additions and 710 deletions.
diff --git 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.
 
 <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
+Amplify Hosting provides a continuous delivery and hosting service for web
+applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
 Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
 for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
 </p>

diff --git a/clients/client-amplify/src/Amplify.ts b/clients/client-amplify/src/Amplify.ts
@@ -667,8 +667,8 @@ export interface Amplify {
 /**
  * @public
  * <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
+ *             Amplify Hosting provides a continuous delivery and hosting service for web
+ *             applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
  *             Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
  *             for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
  *          </p>

diff --git a/clients/client-amplify/src/AmplifyClient.ts b/clients/client-amplify/src/AmplifyClient.ts
@@ -385,8 +385,8 @@ export interface AmplifyClientResolvedConfig extends AmplifyClientResolvedConfig
 /**
  * @public
  * <p>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 <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Console User Guide</a>. The
+ *             Amplify Hosting provides a continuous delivery and hosting service for web
+ *             applications. For more information, see the <a href="https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html">Amplify Hosting User Guide</a>. The
  *             Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation
  *             for client app development. For more information, see the <a href="https://docs.amplify.aws/">Amplify Framework.</a>
  *          </p>

diff --git 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
- * <p> Creates a new Amplify app. </p>
+ * <p>Creates a new Amplify app. </p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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
- * <p> Creates a new backend environment for an Amplify app. </p>
+ * <p>Creates a new backend environment for an Amplify app. </p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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
- * <p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
+ * <p>Creates a deployment for a manually deployed Amplify app. Manually deployed apps are
  *             not connected to a repository. </p>
+ *          <p>The maximum duration between the <code>CreateDeployment</code> call and the
+ *             <code>StartDeployment</code> call cannot exceed 8 hours. If the duration exceeds 8 hours, the
+ *             <code>StartDeployment</code> call and the associated <code>Job</code> will
+ *             fail.</p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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
- * <p> Creates a new webhook on an Amplify app. </p>
+ * <p>Creates a new webhook on an Amplify app. </p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link LimitExceededException} (client fault)
- *  <p> A resource could not be created because service quotas were exceeded. </p>
+ *  <p>A resource could not be created because service quotas were exceeded. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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
- * <p> Deletes an existing Amplify app specified by an app ID. </p>
+ * <p>Deletes an existing Amplify app specified by an app ID. </p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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
- * <p> Deletes a backend environment for an Amplify app. </p>
+ * <p>Deletes a backend environment for an Amplify app. </p>
  * @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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>

diff --git 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)
- *  <p> A request contains unexpected data. </p>
+ *  <p>A request contains unexpected data. </p>
  *
  * @throws {@link DependentServiceFailureException} (server fault)
- *  <p> An operation failed because a dependent service threw an exception. </p>
+ *  <p>An operation failed because a dependent service threw an exception. </p>
  *
  * @throws {@link InternalFailureException} (server fault)
- *  <p> The service failed to perform an operation due to an internal issue. </p>
+ *  <p>The service failed to perform an operation due to an internal issue. </p>
  *
  * @throws {@link NotFoundException} (client fault)
- *  <p> An entity was not found during an operation. </p>
+ *  <p>An entity was not found during an operation. </p>
  *
  * @throws {@link UnauthorizedException} (client fault)
- *  <p> An operation failed due to a lack of access. </p>
+ *  <p>An operation failed due to a lack of access. </p>
  *
  * @throws {@link AmplifyServiceException}
  * <p>Base exception class for all service exceptions from Amplify service.</p>