@aws-sdk/client-amplify 3.438.0 → 3.441.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/README.md +2 -2
  2. package/dist-cjs/index.js +1 -0
  3. package/dist-cjs/pagination/Interfaces.js +2 -0
  4. package/dist-cjs/pagination/ListAppsPaginator.js +29 -0
  5. package/dist-cjs/pagination/ListBranchesPaginator.js +29 -0
  6. package/dist-cjs/pagination/ListDomainAssociationsPaginator.js +29 -0
  7. package/dist-cjs/pagination/ListJobsPaginator.js +29 -0
  8. package/dist-cjs/pagination/index.js +8 -0
  9. package/dist-cjs/protocols/Aws_restJson1.js +3 -0
  10. package/dist-es/index.js +1 -0
  11. package/dist-es/pagination/Interfaces.js +1 -0
  12. package/dist-es/pagination/ListAppsPaginator.js +25 -0
  13. package/dist-es/pagination/ListBranchesPaginator.js +25 -0
  14. package/dist-es/pagination/ListDomainAssociationsPaginator.js +25 -0
  15. package/dist-es/pagination/ListJobsPaginator.js +25 -0
  16. package/dist-es/pagination/index.js +5 -0
  17. package/dist-es/protocols/Aws_restJson1.js +3 -0
  18. package/dist-types/Amplify.d.ts +2 -2
  19. package/dist-types/AmplifyClient.d.ts +2 -2
  20. package/dist-types/commands/CreateAppCommand.d.ts +6 -6
  21. package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +6 -6
  22. package/dist-types/commands/CreateBranchCommand.d.ts +12 -6
  23. package/dist-types/commands/CreateDeploymentCommand.d.ts +9 -5
  24. package/dist-types/commands/CreateDomainAssociationCommand.d.ts +6 -6
  25. package/dist-types/commands/CreateWebhookCommand.d.ts +7 -7
  26. package/dist-types/commands/DeleteAppCommand.d.ts +6 -6
  27. package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +6 -6
  28. package/dist-types/commands/DeleteBranchCommand.d.ts +8 -5
  29. package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +5 -5
  30. package/dist-types/commands/DeleteJobCommand.d.ts +5 -5
  31. package/dist-types/commands/DeleteWebhookCommand.d.ts +6 -6
  32. package/dist-types/commands/GenerateAccessLogsCommand.d.ts +5 -5
  33. package/dist-types/commands/GetAppCommand.d.ts +5 -5
  34. package/dist-types/commands/GetArtifactUrlCommand.d.ts +6 -6
  35. package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +5 -5
  36. package/dist-types/commands/GetBranchCommand.d.ts +7 -4
  37. package/dist-types/commands/GetDomainAssociationCommand.d.ts +4 -4
  38. package/dist-types/commands/GetJobCommand.d.ts +5 -5
  39. package/dist-types/commands/GetWebhookCommand.d.ts +6 -6
  40. package/dist-types/commands/ListAppsCommand.d.ts +4 -4
  41. package/dist-types/commands/ListArtifactsCommand.d.ts +5 -5
  42. package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +4 -4
  43. package/dist-types/commands/ListBranchesCommand.d.ts +6 -3
  44. package/dist-types/commands/ListDomainAssociationsCommand.d.ts +3 -3
  45. package/dist-types/commands/ListJobsCommand.d.ts +4 -4
  46. package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
  47. package/dist-types/commands/ListWebhooksCommand.d.ts +5 -5
  48. package/dist-types/commands/StartDeploymentCommand.d.ts +10 -6
  49. package/dist-types/commands/StartJobCommand.d.ts +5 -5
  50. package/dist-types/commands/StopJobCommand.d.ts +5 -5
  51. package/dist-types/commands/TagResourceCommand.d.ts +4 -4
  52. package/dist-types/commands/UntagResourceCommand.d.ts +4 -4
  53. package/dist-types/commands/UpdateAppCommand.d.ts +5 -5
  54. package/dist-types/commands/UpdateBranchCommand.d.ts +11 -5
  55. package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +5 -5
  56. package/dist-types/commands/UpdateWebhookCommand.d.ts +6 -6
  57. package/dist-types/index.d.ts +3 -2
  58. package/dist-types/models/models_0.d.ts +277 -248
  59. package/dist-types/pagination/Interfaces.d.ts +8 -0
  60. package/dist-types/pagination/ListAppsPaginator.d.ts +7 -0
  61. package/dist-types/pagination/ListBranchesPaginator.d.ts +7 -0
  62. package/dist-types/pagination/ListDomainAssociationsPaginator.d.ts +7 -0
  63. package/dist-types/pagination/ListJobsPaginator.d.ts +7 -0
  64. package/dist-types/pagination/index.d.ts +5 -0
  65. package/dist-types/ts3.4/index.d.ts +1 -0
  66. package/dist-types/ts3.4/models/models_0.d.ts +6 -0
  67. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  68. package/dist-types/ts3.4/pagination/ListAppsPaginator.d.ts +11 -0
  69. package/dist-types/ts3.4/pagination/ListBranchesPaginator.d.ts +11 -0
  70. package/dist-types/ts3.4/pagination/ListDomainAssociationsPaginator.d.ts +11 -0
  71. package/dist-types/ts3.4/pagination/ListJobsPaginator.d.ts +11 -0
  72. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  73. package/package.json +4 -4
@@ -2,7 +2,7 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
2
2
  import { AmplifyServiceException as __BaseException } from "./AmplifyServiceException";
3
3
  /**
4
4
  * @public
5
- * <p> A request contains unexpected data. </p>
5
+ * <p>A request contains unexpected data. </p>
6
6
  */
7
7
  export declare class BadRequestException extends __BaseException {
8
8
  readonly name: "BadRequestException";
@@ -29,39 +29,39 @@ export declare const Stage: {
29
29
  export type Stage = (typeof Stage)[keyof typeof Stage];
30
30
  /**
31
31
  * @public
32
- * <p> Describes the automated branch creation configuration. </p>
32
+ * <p>Describes the automated branch creation configuration. </p>
33
33
  */
34
34
  export interface AutoBranchCreationConfig {
35
35
  /**
36
36
  * @public
37
- * <p> Describes the current stage for the autocreated branch. </p>
37
+ * <p>Describes the current stage for the autocreated branch. </p>
38
38
  */
39
39
  stage?: Stage;
40
40
  /**
41
41
  * @public
42
- * <p> The framework for the autocreated branch. </p>
42
+ * <p>The framework for the autocreated branch. </p>
43
43
  */
44
44
  framework?: string;
45
45
  /**
46
46
  * @public
47
- * <p> Enables auto building for the autocreated branch. </p>
47
+ * <p>Enables auto building for the autocreated branch. </p>
48
48
  */
49
49
  enableAutoBuild?: boolean;
50
50
  /**
51
51
  * @public
52
- * <p> The environment variables for the autocreated branch. </p>
52
+ * <p>The environment variables for the autocreated branch. </p>
53
53
  */
54
54
  environmentVariables?: Record<string, string>;
55
55
  /**
56
56
  * @public
57
- * <p> The basic authorization credentials for the autocreated branch. You must
57
+ * <p>The basic authorization credentials for the autocreated branch. You must
58
58
  * base64-encode the authorization credentials and provide them in the format
59
59
  * <code>user:password</code>.</p>
60
60
  */
61
61
  basicAuthCredentials?: string;
62
62
  /**
63
63
  * @public
64
- * <p> Enables basic authorization for the autocreated branch. </p>
64
+ * <p>Enables basic authorization for the autocreated branch. </p>
65
65
  */
66
66
  enableBasicAuth?: boolean;
67
67
  /**
@@ -74,38 +74,38 @@ export interface AutoBranchCreationConfig {
74
74
  enablePerformanceMode?: boolean;
75
75
  /**
76
76
  * @public
77
- * <p> The build specification (build spec) for the autocreated branch. </p>
77
+ * <p>The build specification (build spec) for the autocreated branch. </p>
78
78
  */
79
79
  buildSpec?: string;
80
80
  /**
81
81
  * @public
82
- * <p> Enables pull request previews for the autocreated branch. </p>
82
+ * <p>Enables pull request previews for the autocreated branch. </p>
83
83
  */
84
84
  enablePullRequestPreview?: boolean;
85
85
  /**
86
86
  * @public
87
- * <p> The Amplify environment name for the pull request. </p>
87
+ * <p>The Amplify environment name for the pull request. </p>
88
88
  */
89
89
  pullRequestEnvironmentName?: string;
90
90
  }
91
91
  /**
92
92
  * @public
93
- * <p> Describes a custom rewrite or redirect rule. </p>
93
+ * <p>Describes a custom rewrite or redirect rule. </p>
94
94
  */
95
95
  export interface CustomRule {
96
96
  /**
97
97
  * @public
98
- * <p> The source pattern for a URL rewrite or redirect rule. </p>
98
+ * <p>The source pattern for a URL rewrite or redirect rule. </p>
99
99
  */
100
100
  source: string | undefined;
101
101
  /**
102
102
  * @public
103
- * <p> The target pattern for a URL rewrite or redirect rule. </p>
103
+ * <p>The target pattern for a URL rewrite or redirect rule. </p>
104
104
  */
105
105
  target: string | undefined;
106
106
  /**
107
107
  * @public
108
- * <p> The status code for a URL rewrite or redirect rule. </p>
108
+ * <p>The status code for a URL rewrite or redirect rule. </p>
109
109
  * <dl>
110
110
  * <dt>200</dt>
111
111
  * <dd>
@@ -133,7 +133,7 @@ export interface CustomRule {
133
133
  status?: string;
134
134
  /**
135
135
  * @public
136
- * <p> The condition for a URL rewrite or redirect rule, such as a country code. </p>
136
+ * <p>The condition for a URL rewrite or redirect rule, such as a country code. </p>
137
137
  */
138
138
  condition?: string;
139
139
  }
@@ -152,27 +152,27 @@ export declare const Platform: {
152
152
  export type Platform = (typeof Platform)[keyof typeof Platform];
153
153
  /**
154
154
  * @public
155
- * <p> The request structure used to create apps in Amplify. </p>
155
+ * <p>The request structure used to create apps in Amplify. </p>
156
156
  */
157
157
  export interface CreateAppRequest {
158
158
  /**
159
159
  * @public
160
- * <p> The name for an Amplify app. </p>
160
+ * <p>The name of the Amplify app. </p>
161
161
  */
162
162
  name: string | undefined;
163
163
  /**
164
164
  * @public
165
- * <p> The description for an Amplify app. </p>
165
+ * <p>The description of the Amplify app. </p>
166
166
  */
167
167
  description?: string;
168
168
  /**
169
169
  * @public
170
- * <p> The repository for an Amplify app. </p>
170
+ * <p>The Git repository for the Amplify app. </p>
171
171
  */
172
172
  repository?: string;
173
173
  /**
174
174
  * @public
175
- * <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
175
+ * <p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
176
176
  * For a dynamic server-side rendered (SSR) app, set the platform type to
177
177
  * <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
178
178
  * <code>WEB_DYNAMIC</code>.</p>
@@ -180,7 +180,7 @@ export interface CreateAppRequest {
180
180
  platform?: Platform;
181
181
  /**
182
182
  * @public
183
- * <p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
183
+ * <p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
184
184
  */
185
185
  iamServiceRoleArn?: string;
186
186
  /**
@@ -195,7 +195,7 @@ export interface CreateAppRequest {
195
195
  * create a new app.</p>
196
196
  * <p>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work
197
197
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
198
- * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
198
+ * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
199
199
  * <i>Amplify User Guide</i> .</p>
200
200
  */
201
201
  oauthToken?: string;
@@ -210,52 +210,53 @@ export interface CreateAppRequest {
210
210
  * create a new app.</p>
211
211
  * <p>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work
212
212
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
213
- * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
213
+ * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
214
214
  * <i>Amplify User Guide</i> .</p>
215
215
  */
216
216
  accessToken?: string;
217
217
  /**
218
218
  * @public
219
- * <p> The environment variables map for an Amplify app. </p>
219
+ * <p>The environment variables map for an Amplify app. </p>
220
+ * <p>For a list of the environment variables that are accessible to Amplify by default, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify Environment variables</a> in the <i>Amplify Hosting User Guide</i>.</p>
220
221
  */
221
222
  environmentVariables?: Record<string, string>;
222
223
  /**
223
224
  * @public
224
- * <p> Enables the auto building of branches for an Amplify app. </p>
225
+ * <p>Enables the auto building of branches for an Amplify app. </p>
225
226
  */
226
227
  enableBranchAutoBuild?: boolean;
227
228
  /**
228
229
  * @public
229
- * <p> Automatically disconnects a branch in the Amplify Console when you delete a branch
230
+ * <p>Automatically disconnects a branch in the Amplify console when you delete a branch
230
231
  * from your Git repository. </p>
231
232
  */
232
233
  enableBranchAutoDeletion?: boolean;
233
234
  /**
234
235
  * @public
235
- * <p> Enables basic authorization for an Amplify app. This will apply to all branches that
236
+ * <p>Enables basic authorization for an Amplify app. This will apply to all branches that
236
237
  * are part of this app. </p>
237
238
  */
238
239
  enableBasicAuth?: boolean;
239
240
  /**
240
241
  * @public
241
- * <p> The credentials for basic authorization for an Amplify app. You must base64-encode
242
+ * <p>The credentials for basic authorization for an Amplify app. You must base64-encode
242
243
  * the authorization credentials and provide them in the format
243
244
  * <code>user:password</code>.</p>
244
245
  */
245
246
  basicAuthCredentials?: string;
246
247
  /**
247
248
  * @public
248
- * <p> The custom rewrite and redirect rules for an Amplify app. </p>
249
+ * <p>The custom rewrite and redirect rules for an Amplify app. </p>
249
250
  */
250
251
  customRules?: CustomRule[];
251
252
  /**
252
253
  * @public
253
- * <p> The tag for an Amplify app. </p>
254
+ * <p>The tag for an Amplify app. </p>
254
255
  */
255
256
  tags?: Record<string, string>;
256
257
  /**
257
258
  * @public
258
- * <p> The build specification (build spec) for an Amplify app. </p>
259
+ * <p>The build specification (build spec) for an Amplify app. </p>
259
260
  */
260
261
  buildSpec?: string;
261
262
  /**
@@ -265,43 +266,43 @@ export interface CreateAppRequest {
265
266
  customHeaders?: string;
266
267
  /**
267
268
  * @public
268
- * <p> Enables automated branch creation for an Amplify app. </p>
269
+ * <p>Enables automated branch creation for an Amplify app. </p>
269
270
  */
270
271
  enableAutoBranchCreation?: boolean;
271
272
  /**
272
273
  * @public
273
- * <p> The automated branch creation glob patterns for an Amplify app. </p>
274
+ * <p>The automated branch creation glob patterns for an Amplify app. </p>
274
275
  */
275
276
  autoBranchCreationPatterns?: string[];
276
277
  /**
277
278
  * @public
278
- * <p> The automated branch creation configuration for an Amplify app. </p>
279
+ * <p>The automated branch creation configuration for an Amplify app. </p>
279
280
  */
280
281
  autoBranchCreationConfig?: AutoBranchCreationConfig;
281
282
  }
282
283
  /**
283
284
  * @public
284
- * <p> Describes the information about a production branch for an Amplify app. </p>
285
+ * <p>Describes the information about a production branch for an Amplify app. </p>
285
286
  */
286
287
  export interface ProductionBranch {
287
288
  /**
288
289
  * @public
289
- * <p> The last deploy time of the production branch. </p>
290
+ * <p>The last deploy time of the production branch. </p>
290
291
  */
291
292
  lastDeployTime?: Date;
292
293
  /**
293
294
  * @public
294
- * <p> The status of the production branch. </p>
295
+ * <p>The status of the production branch. </p>
295
296
  */
296
297
  status?: string;
297
298
  /**
298
299
  * @public
299
- * <p> The thumbnail URL for the production branch. </p>
300
+ * <p>The thumbnail URL for the production branch. </p>
300
301
  */
301
302
  thumbnailUrl?: string;
302
303
  /**
303
304
  * @public
304
- * <p> The branch name for the production branch. </p>
305
+ * <p>The branch name for the production branch. </p>
305
306
  */
306
307
  branchName?: string;
307
308
  }
@@ -320,43 +321,43 @@ export declare const RepositoryCloneMethod: {
320
321
  export type RepositoryCloneMethod = (typeof RepositoryCloneMethod)[keyof typeof RepositoryCloneMethod];
321
322
  /**
322
323
  * @public
323
- * <p> Represents the different branches of a repository for building, deploying, and
324
+ * <p>Represents the different branches of a repository for building, deploying, and
324
325
  * hosting an Amplify app. </p>
325
326
  */
326
327
  export interface App {
327
328
  /**
328
329
  * @public
329
- * <p> The unique ID of the Amplify app. </p>
330
+ * <p>The unique ID of the Amplify app. </p>
330
331
  */
331
332
  appId: string | undefined;
332
333
  /**
333
334
  * @public
334
- * <p> The Amazon Resource Name (ARN) of the Amplify app. </p>
335
+ * <p>The Amazon Resource Name (ARN) of the Amplify app. </p>
335
336
  */
336
337
  appArn: string | undefined;
337
338
  /**
338
339
  * @public
339
- * <p> The name for the Amplify app. </p>
340
+ * <p>The name for the Amplify app. </p>
340
341
  */
341
342
  name: string | undefined;
342
343
  /**
343
344
  * @public
344
- * <p> The tag for the Amplify app. </p>
345
+ * <p>The tag for the Amplify app. </p>
345
346
  */
346
347
  tags?: Record<string, string>;
347
348
  /**
348
349
  * @public
349
- * <p> The description for the Amplify app. </p>
350
+ * <p>The description for the Amplify app. </p>
350
351
  */
351
352
  description: string | undefined;
352
353
  /**
353
354
  * @public
354
- * <p> The Git repository for the Amplify app. </p>
355
+ * <p>The Git repository for the Amplify app. </p>
355
356
  */
356
357
  repository: string | undefined;
357
358
  /**
358
359
  * @public
359
- * <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
360
+ * <p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
360
361
  * For a dynamic server-side rendered (SSR) app, set the platform type to
361
362
  * <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
362
363
  * <code>WEB_DYNAMIC</code>.</p>
@@ -364,66 +365,67 @@ export interface App {
364
365
  platform: Platform | undefined;
365
366
  /**
366
367
  * @public
367
- * <p> Creates a date and time for the Amplify app. </p>
368
+ * <p>Creates a date and time for the Amplify app. </p>
368
369
  */
369
370
  createTime: Date | undefined;
370
371
  /**
371
372
  * @public
372
- * <p> Updates the date and time for the Amplify app. </p>
373
+ * <p>Updates the date and time for the Amplify app. </p>
373
374
  */
374
375
  updateTime: Date | undefined;
375
376
  /**
376
377
  * @public
377
- * <p> The AWS Identity and Access Management (IAM) service role for the Amazon Resource
378
+ * <p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource
378
379
  * Name (ARN) of the Amplify app. </p>
379
380
  */
380
381
  iamServiceRoleArn?: string;
381
382
  /**
382
383
  * @public
383
- * <p> The environment variables for the Amplify app. </p>
384
+ * <p>The environment variables for the Amplify app. </p>
385
+ * <p>For a list of the environment variables that are accessible to Amplify by default, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify Environment variables</a> in the <i>Amplify Hosting User Guide</i>.</p>
384
386
  */
385
387
  environmentVariables: Record<string, string> | undefined;
386
388
  /**
387
389
  * @public
388
- * <p> The default domain for the Amplify app. </p>
390
+ * <p>The default domain for the Amplify app. </p>
389
391
  */
390
392
  defaultDomain: string | undefined;
391
393
  /**
392
394
  * @public
393
- * <p> Enables the auto-building of branches for the Amplify app. </p>
395
+ * <p>Enables the auto-building of branches for the Amplify app. </p>
394
396
  */
395
397
  enableBranchAutoBuild: boolean | undefined;
396
398
  /**
397
399
  * @public
398
- * <p> Automatically disconnect a branch in the Amplify Console when you delete a branch
399
- * from your Git repository. </p>
400
+ * <p>Automatically disconnect a branch in the Amplify console when you delete a branch
401
+ * from your Git repository.</p>
400
402
  */
401
403
  enableBranchAutoDeletion?: boolean;
402
404
  /**
403
405
  * @public
404
- * <p> Enables basic authorization for the Amplify app's branches. </p>
406
+ * <p>Enables basic authorization for the Amplify app's branches. </p>
405
407
  */
406
408
  enableBasicAuth: boolean | undefined;
407
409
  /**
408
410
  * @public
409
- * <p> The basic authorization credentials for branches for the Amplify app. You must
411
+ * <p>The basic authorization credentials for branches for the Amplify app. You must
410
412
  * base64-encode the authorization credentials and provide them in the format
411
413
  * <code>user:password</code>.</p>
412
414
  */
413
415
  basicAuthCredentials?: string;
414
416
  /**
415
417
  * @public
416
- * <p> Describes the custom redirect and rewrite rules for the Amplify app. </p>
418
+ * <p>Describes the custom redirect and rewrite rules for the Amplify app. </p>
417
419
  */
418
420
  customRules?: CustomRule[];
419
421
  /**
420
422
  * @public
421
- * <p> Describes the information about a production branch of the Amplify app. </p>
423
+ * <p>Describes the information about a production branch of the Amplify app. </p>
422
424
  */
423
425
  productionBranch?: ProductionBranch;
424
426
  /**
425
427
  * @public
426
- * <p> Describes the content of the build specification (build spec) for the Amplify app.
428
+ * <p>Describes the content of the build specification (build spec) for the Amplify app.
427
429
  * </p>
428
430
  */
429
431
  buildSpec?: string;
@@ -434,17 +436,17 @@ export interface App {
434
436
  customHeaders?: string;
435
437
  /**
436
438
  * @public
437
- * <p> Enables automated branch creation for the Amplify app. </p>
439
+ * <p>Enables automated branch creation for the Amplify app. </p>
438
440
  */
439
441
  enableAutoBranchCreation?: boolean;
440
442
  /**
441
443
  * @public
442
- * <p> Describes the automated branch creation glob patterns for the Amplify app. </p>
444
+ * <p>Describes the automated branch creation glob patterns for the Amplify app. </p>
443
445
  */
444
446
  autoBranchCreationPatterns?: string[];
445
447
  /**
446
448
  * @public
447
- * <p> Describes the automated branch creation configuration for the Amplify app. </p>
449
+ * <p>Describes the automated branch creation configuration for the Amplify app. </p>
448
450
  */
449
451
  autoBranchCreationConfig?: AutoBranchCreationConfig;
450
452
  /**
@@ -465,14 +467,14 @@ export interface App {
465
467
  export interface CreateAppResult {
466
468
  /**
467
469
  * @public
468
- * <p> Represents the different branches of a repository for building, deploying, and
470
+ * <p>Represents the different branches of a repository for building, deploying, and
469
471
  * hosting an Amplify app. </p>
470
472
  */
471
473
  app: App | undefined;
472
474
  }
473
475
  /**
474
476
  * @public
475
- * <p> An operation failed because a dependent service threw an exception. </p>
477
+ * <p>An operation failed because a dependent service threw an exception. </p>
476
478
  */
477
479
  export declare class DependentServiceFailureException extends __BaseException {
478
480
  readonly name: "DependentServiceFailureException";
@@ -484,7 +486,7 @@ export declare class DependentServiceFailureException extends __BaseException {
484
486
  }
485
487
  /**
486
488
  * @public
487
- * <p> The service failed to perform an operation due to an internal issue. </p>
489
+ * <p>The service failed to perform an operation due to an internal issue. </p>
488
490
  */
489
491
  export declare class InternalFailureException extends __BaseException {
490
492
  readonly name: "InternalFailureException";
@@ -496,7 +498,7 @@ export declare class InternalFailureException extends __BaseException {
496
498
  }
497
499
  /**
498
500
  * @public
499
- * <p> A resource could not be created because service quotas were exceeded. </p>
501
+ * <p>A resource could not be created because service quotas were exceeded. </p>
500
502
  */
501
503
  export declare class LimitExceededException extends __BaseException {
502
504
  readonly name: "LimitExceededException";
@@ -508,7 +510,7 @@ export declare class LimitExceededException extends __BaseException {
508
510
  }
509
511
  /**
510
512
  * @public
511
- * <p> An operation failed due to a lack of access. </p>
513
+ * <p>An operation failed due to a lack of access. </p>
512
514
  */
513
515
  export declare class UnauthorizedException extends __BaseException {
514
516
  readonly name: "UnauthorizedException";
@@ -520,83 +522,83 @@ export declare class UnauthorizedException extends __BaseException {
520
522
  }
521
523
  /**
522
524
  * @public
523
- * <p> The request structure for the backend environment create request. </p>
525
+ * <p>The request structure for the backend environment create request. </p>
524
526
  */
525
527
  export interface CreateBackendEnvironmentRequest {
526
528
  /**
527
529
  * @public
528
- * <p> The unique ID for an Amplify app. </p>
530
+ * <p>The unique ID for an Amplify app. </p>
529
531
  */
530
532
  appId: string | undefined;
531
533
  /**
532
534
  * @public
533
- * <p> The name for the backend environment. </p>
535
+ * <p>The name for the backend environment. </p>
534
536
  */
535
537
  environmentName: string | undefined;
536
538
  /**
537
539
  * @public
538
- * <p> The AWS CloudFormation stack name of a backend environment. </p>
540
+ * <p>The AWS CloudFormation stack name of a backend environment. </p>
539
541
  */
540
542
  stackName?: string;
541
543
  /**
542
544
  * @public
543
- * <p> The name of deployment artifacts. </p>
545
+ * <p>The name of deployment artifacts. </p>
544
546
  */
545
547
  deploymentArtifacts?: string;
546
548
  }
547
549
  /**
548
550
  * @public
549
- * <p> Describes the backend environment for an Amplify app. </p>
551
+ * <p>Describes the backend environment for an Amplify app. </p>
550
552
  */
551
553
  export interface BackendEnvironment {
552
554
  /**
553
555
  * @public
554
- * <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
556
+ * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
555
557
  * app. </p>
556
558
  */
557
559
  backendEnvironmentArn: string | undefined;
558
560
  /**
559
561
  * @public
560
- * <p> The name for a backend environment that is part of an Amplify app. </p>
562
+ * <p>The name for a backend environment that is part of an Amplify app. </p>
561
563
  */
562
564
  environmentName: string | undefined;
563
565
  /**
564
566
  * @public
565
- * <p> The AWS CloudFormation stack name of a backend environment. </p>
567
+ * <p>The AWS CloudFormation stack name of a backend environment. </p>
566
568
  */
567
569
  stackName?: string;
568
570
  /**
569
571
  * @public
570
- * <p> The name of deployment artifacts. </p>
572
+ * <p>The name of deployment artifacts. </p>
571
573
  */
572
574
  deploymentArtifacts?: string;
573
575
  /**
574
576
  * @public
575
- * <p> The creation date and time for a backend environment that is part of an Amplify app.
577
+ * <p>The creation date and time for a backend environment that is part of an Amplify app.
576
578
  * </p>
577
579
  */
578
580
  createTime: Date | undefined;
579
581
  /**
580
582
  * @public
581
- * <p> The last updated date and time for a backend environment that is part of an Amplify
583
+ * <p>The last updated date and time for a backend environment that is part of an Amplify
582
584
  * app. </p>
583
585
  */
584
586
  updateTime: Date | undefined;
585
587
  }
586
588
  /**
587
589
  * @public
588
- * <p> The result structure for the create backend environment request. </p>
590
+ * <p>The result structure for the create backend environment request. </p>
589
591
  */
590
592
  export interface CreateBackendEnvironmentResult {
591
593
  /**
592
594
  * @public
593
- * <p> Describes the backend environment for an Amplify app. </p>
595
+ * <p>Describes the backend environment for an Amplify app. </p>
594
596
  */
595
597
  backendEnvironment: BackendEnvironment | undefined;
596
598
  }
597
599
  /**
598
600
  * @public
599
- * <p> An entity was not found during an operation. </p>
601
+ * <p>An entity was not found during an operation. </p>
600
602
  */
601
603
  export declare class NotFoundException extends __BaseException {
602
604
  readonly name: "NotFoundException";
@@ -606,6 +608,17 @@ export declare class NotFoundException extends __BaseException {
606
608
  */
607
609
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
608
610
  }
611
+ /**
612
+ * @public
613
+ * <p>Describes the backend properties associated with an Amplify <code>Branch</code>.</p>
614
+ */
615
+ export interface Backend {
616
+ /**
617
+ * @public
618
+ * <p>The Amazon Resource Name (ARN) for the CloudFormation stack.</p>
619
+ */
620
+ stackArn?: string;
621
+ }
609
622
  /**
610
623
  * @public
611
624
  * <p> The request structure for the create branch request. </p>
@@ -618,17 +631,17 @@ export interface CreateBranchRequest {
618
631
  appId: string | undefined;
619
632
  /**
620
633
  * @public
621
- * <p> The name for the branch. </p>
634
+ * <p>The name for the branch. </p>
622
635
  */
623
636
  branchName: string | undefined;
624
637
  /**
625
638
  * @public
626
- * <p> The description for the branch. </p>
639
+ * <p>The description for the branch. </p>
627
640
  */
628
641
  description?: string;
629
642
  /**
630
643
  * @public
631
- * <p> Describes the current stage for the branch. </p>
644
+ * <p>Describes the current stage for the branch. </p>
632
645
  */
633
646
  stage?: Stage;
634
647
  /**
@@ -703,10 +716,15 @@ export interface CreateBranchRequest {
703
716
  pullRequestEnvironmentName?: string;
704
717
  /**
705
718
  * @public
706
- * <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
719
+ * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
707
720
  * app. </p>
708
721
  */
709
722
  backendEnvironmentArn?: string;
723
+ /**
724
+ * @public
725
+ * <p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p>
726
+ */
727
+ backend?: Backend;
710
728
  }
711
729
  /**
712
730
  * @public
@@ -855,6 +873,11 @@ export interface Branch {
855
873
  * app. </p>
856
874
  */
857
875
  backendEnvironmentArn?: string;
876
+ /**
877
+ * @public
878
+ * <p>Describes the backend properties associated with an Amplify <code>Branch</code>.</p>
879
+ */
880
+ backend?: Backend;
858
881
  }
859
882
  /**
860
883
  * @public
@@ -880,7 +903,7 @@ export interface CreateDeploymentRequest {
880
903
  appId: string | undefined;
881
904
  /**
882
905
  * @public
883
- * <p> The name for the branch, for the job. </p>
906
+ * <p> The name of the branch to use for the job. </p>
884
907
  */
885
908
  branchName: string | undefined;
886
909
  /**
@@ -1074,124 +1097,124 @@ export interface CreateDomainAssociationResult {
1074
1097
  }
1075
1098
  /**
1076
1099
  * @public
1077
- * <p> The request structure for the create webhook request. </p>
1100
+ * <p>The request structure for the create webhook request. </p>
1078
1101
  */
1079
1102
  export interface CreateWebhookRequest {
1080
1103
  /**
1081
1104
  * @public
1082
- * <p> The unique ID for an Amplify app. </p>
1105
+ * <p>The unique ID for an Amplify app. </p>
1083
1106
  */
1084
1107
  appId: string | undefined;
1085
1108
  /**
1086
1109
  * @public
1087
- * <p> The name for a branch that is part of an Amplify app. </p>
1110
+ * <p>The name for a branch that is part of an Amplify app. </p>
1088
1111
  */
1089
1112
  branchName: string | undefined;
1090
1113
  /**
1091
1114
  * @public
1092
- * <p> The description for a webhook. </p>
1115
+ * <p>The description for a webhook. </p>
1093
1116
  */
1094
1117
  description?: string;
1095
1118
  }
1096
1119
  /**
1097
1120
  * @public
1098
- * <p> Describes a webhook that connects repository events to an Amplify app. </p>
1121
+ * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1099
1122
  */
1100
1123
  export interface Webhook {
1101
1124
  /**
1102
1125
  * @public
1103
- * <p> The Amazon Resource Name (ARN) for the webhook. </p>
1126
+ * <p>The Amazon Resource Name (ARN) for the webhook. </p>
1104
1127
  */
1105
1128
  webhookArn: string | undefined;
1106
1129
  /**
1107
1130
  * @public
1108
- * <p> The ID of the webhook. </p>
1131
+ * <p>The ID of the webhook. </p>
1109
1132
  */
1110
1133
  webhookId: string | undefined;
1111
1134
  /**
1112
1135
  * @public
1113
- * <p> The URL of the webhook. </p>
1136
+ * <p>The URL of the webhook. </p>
1114
1137
  */
1115
1138
  webhookUrl: string | undefined;
1116
1139
  /**
1117
1140
  * @public
1118
- * <p> The name for a branch that is part of an Amplify app. </p>
1141
+ * <p>The name for a branch that is part of an Amplify app. </p>
1119
1142
  */
1120
1143
  branchName: string | undefined;
1121
1144
  /**
1122
1145
  * @public
1123
- * <p> The description for a webhook. </p>
1146
+ * <p>The description for a webhook. </p>
1124
1147
  */
1125
1148
  description: string | undefined;
1126
1149
  /**
1127
1150
  * @public
1128
- * <p> The create date and time for a webhook. </p>
1151
+ * <p>The create date and time for a webhook. </p>
1129
1152
  */
1130
1153
  createTime: Date | undefined;
1131
1154
  /**
1132
1155
  * @public
1133
- * <p> Updates the date and time for a webhook. </p>
1156
+ * <p>Updates the date and time for a webhook. </p>
1134
1157
  */
1135
1158
  updateTime: Date | undefined;
1136
1159
  }
1137
1160
  /**
1138
1161
  * @public
1139
- * <p> The result structure for the create webhook request. </p>
1162
+ * <p>The result structure for the create webhook request. </p>
1140
1163
  */
1141
1164
  export interface CreateWebhookResult {
1142
1165
  /**
1143
1166
  * @public
1144
- * <p> Describes a webhook that connects repository events to an Amplify app. </p>
1167
+ * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1145
1168
  */
1146
1169
  webhook: Webhook | undefined;
1147
1170
  }
1148
1171
  /**
1149
1172
  * @public
1150
- * <p> Describes the request structure for the delete app request. </p>
1173
+ * <p>Describes the request structure for the delete app request. </p>
1151
1174
  */
1152
1175
  export interface DeleteAppRequest {
1153
1176
  /**
1154
1177
  * @public
1155
- * <p> The unique ID for an Amplify app. </p>
1178
+ * <p>The unique ID for an Amplify app. </p>
1156
1179
  */
1157
1180
  appId: string | undefined;
1158
1181
  }
1159
1182
  /**
1160
1183
  * @public
1161
- * <p> The result structure for the delete app request. </p>
1184
+ * <p>The result structure for the delete app request. </p>
1162
1185
  */
1163
1186
  export interface DeleteAppResult {
1164
1187
  /**
1165
1188
  * @public
1166
- * <p> Represents the different branches of a repository for building, deploying, and
1189
+ * <p>Represents the different branches of a repository for building, deploying, and
1167
1190
  * hosting an Amplify app. </p>
1168
1191
  */
1169
1192
  app: App | undefined;
1170
1193
  }
1171
1194
  /**
1172
1195
  * @public
1173
- * <p> The request structure for the delete backend environment request. </p>
1196
+ * <p>The request structure for the delete backend environment request. </p>
1174
1197
  */
1175
1198
  export interface DeleteBackendEnvironmentRequest {
1176
1199
  /**
1177
1200
  * @public
1178
- * <p> The unique ID of an Amplify app. </p>
1201
+ * <p>The unique ID of an Amplify app. </p>
1179
1202
  */
1180
1203
  appId: string | undefined;
1181
1204
  /**
1182
1205
  * @public
1183
- * <p> The name of a backend environment of an Amplify app. </p>
1206
+ * <p>The name of a backend environment of an Amplify app. </p>
1184
1207
  */
1185
1208
  environmentName: string | undefined;
1186
1209
  }
1187
1210
  /**
1188
1211
  * @public
1189
- * <p> The result structure of the delete backend environment result. </p>
1212
+ * <p>The result structure of the delete backend environment result. </p>
1190
1213
  */
1191
1214
  export interface DeleteBackendEnvironmentResult {
1192
1215
  /**
1193
1216
  * @public
1194
- * <p> Describes the backend environment for an Amplify app. </p>
1217
+ * <p>Describes the backend environment for an Amplify app. </p>
1195
1218
  */
1196
1219
  backendEnvironment: BackendEnvironment | undefined;
1197
1220
  }
@@ -1207,18 +1230,18 @@ export interface DeleteBranchRequest {
1207
1230
  appId: string | undefined;
1208
1231
  /**
1209
1232
  * @public
1210
- * <p> The name for the branch. </p>
1233
+ * <p>The name of the branch. </p>
1211
1234
  */
1212
1235
  branchName: string | undefined;
1213
1236
  }
1214
1237
  /**
1215
1238
  * @public
1216
- * <p> The result structure for the delete branch request. </p>
1239
+ * <p>The result structure for the delete branch request. </p>
1217
1240
  */
1218
1241
  export interface DeleteBranchResult {
1219
1242
  /**
1220
1243
  * @public
1221
- * <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
1244
+ * <p>The branch for an Amplify app, which maps to a third-party repository branch. </p>
1222
1245
  */
1223
1246
  branch: Branch | undefined;
1224
1247
  }
@@ -1261,7 +1284,7 @@ export interface DeleteJobRequest {
1261
1284
  appId: string | undefined;
1262
1285
  /**
1263
1286
  * @public
1264
- * <p> The name for the branch, for the job. </p>
1287
+ * <p>The name of the branch to use for the job. </p>
1265
1288
  */
1266
1289
  branchName: string | undefined;
1267
1290
  /**
@@ -1369,73 +1392,73 @@ export interface DeleteJobResult {
1369
1392
  }
1370
1393
  /**
1371
1394
  * @public
1372
- * <p> The request structure for the delete webhook request. </p>
1395
+ * <p>The request structure for the delete webhook request. </p>
1373
1396
  */
1374
1397
  export interface DeleteWebhookRequest {
1375
1398
  /**
1376
1399
  * @public
1377
- * <p> The unique ID for a webhook. </p>
1400
+ * <p>The unique ID for a webhook. </p>
1378
1401
  */
1379
1402
  webhookId: string | undefined;
1380
1403
  }
1381
1404
  /**
1382
1405
  * @public
1383
- * <p> The result structure for the delete webhook request. </p>
1406
+ * <p>The result structure for the delete webhook request. </p>
1384
1407
  */
1385
1408
  export interface DeleteWebhookResult {
1386
1409
  /**
1387
1410
  * @public
1388
- * <p> Describes a webhook that connects repository events to an Amplify app. </p>
1411
+ * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1389
1412
  */
1390
1413
  webhook: Webhook | undefined;
1391
1414
  }
1392
1415
  /**
1393
1416
  * @public
1394
- * <p> The request structure for the generate access logs request. </p>
1417
+ * <p>The request structure for the generate access logs request. </p>
1395
1418
  */
1396
1419
  export interface GenerateAccessLogsRequest {
1397
1420
  /**
1398
1421
  * @public
1399
- * <p> The time at which the logs should start. The time range specified is inclusive of the
1422
+ * <p>The time at which the logs should start. The time range specified is inclusive of the
1400
1423
  * start time. </p>
1401
1424
  */
1402
1425
  startTime?: Date;
1403
1426
  /**
1404
1427
  * @public
1405
- * <p> The time at which the logs should end. The time range specified is inclusive of the
1428
+ * <p>The time at which the logs should end. The time range specified is inclusive of the
1406
1429
  * end time. </p>
1407
1430
  */
1408
1431
  endTime?: Date;
1409
1432
  /**
1410
1433
  * @public
1411
- * <p> The name of the domain. </p>
1434
+ * <p>The name of the domain. </p>
1412
1435
  */
1413
1436
  domainName: string | undefined;
1414
1437
  /**
1415
1438
  * @public
1416
- * <p> The unique ID for an Amplify app. </p>
1439
+ * <p>The unique ID for an Amplify app. </p>
1417
1440
  */
1418
1441
  appId: string | undefined;
1419
1442
  }
1420
1443
  /**
1421
1444
  * @public
1422
- * <p> The result structure for the generate access logs request. </p>
1445
+ * <p>The result structure for the generate access logs request. </p>
1423
1446
  */
1424
1447
  export interface GenerateAccessLogsResult {
1425
1448
  /**
1426
1449
  * @public
1427
- * <p> The pre-signed URL for the requested access logs. </p>
1450
+ * <p>The pre-signed URL for the requested access logs. </p>
1428
1451
  */
1429
1452
  logUrl?: string;
1430
1453
  }
1431
1454
  /**
1432
1455
  * @public
1433
- * <p> The request structure for the get app request. </p>
1456
+ * <p>The request structure for the get app request. </p>
1434
1457
  */
1435
1458
  export interface GetAppRequest {
1436
1459
  /**
1437
1460
  * @public
1438
- * <p> The unique ID for an Amplify app. </p>
1461
+ * <p>The unique ID for an Amplify app. </p>
1439
1462
  */
1440
1463
  appId: string | undefined;
1441
1464
  }
@@ -1445,62 +1468,62 @@ export interface GetAppRequest {
1445
1468
  export interface GetAppResult {
1446
1469
  /**
1447
1470
  * @public
1448
- * <p> Represents the different branches of a repository for building, deploying, and
1471
+ * <p>Represents the different branches of a repository for building, deploying, and
1449
1472
  * hosting an Amplify app. </p>
1450
1473
  */
1451
1474
  app: App | undefined;
1452
1475
  }
1453
1476
  /**
1454
1477
  * @public
1455
- * <p> Returns the request structure for the get artifact request. </p>
1478
+ * <p>Returns the request structure for the get artifact request. </p>
1456
1479
  */
1457
1480
  export interface GetArtifactUrlRequest {
1458
1481
  /**
1459
1482
  * @public
1460
- * <p> The unique ID for an artifact. </p>
1483
+ * <p>The unique ID for an artifact. </p>
1461
1484
  */
1462
1485
  artifactId: string | undefined;
1463
1486
  }
1464
1487
  /**
1465
1488
  * @public
1466
- * <p> Returns the result structure for the get artifact request. </p>
1489
+ * <p>Returns the result structure for the get artifact request. </p>
1467
1490
  */
1468
1491
  export interface GetArtifactUrlResult {
1469
1492
  /**
1470
1493
  * @public
1471
- * <p> The unique ID for an artifact. </p>
1494
+ * <p>The unique ID for an artifact. </p>
1472
1495
  */
1473
1496
  artifactId: string | undefined;
1474
1497
  /**
1475
1498
  * @public
1476
- * <p> The presigned URL for the artifact. </p>
1499
+ * <p>The presigned URL for the artifact. </p>
1477
1500
  */
1478
1501
  artifactUrl: string | undefined;
1479
1502
  }
1480
1503
  /**
1481
1504
  * @public
1482
- * <p> The request structure for the get backend environment request. </p>
1505
+ * <p>The request structure for the get backend environment request. </p>
1483
1506
  */
1484
1507
  export interface GetBackendEnvironmentRequest {
1485
1508
  /**
1486
1509
  * @public
1487
- * <p> The unique id for an Amplify app. </p>
1510
+ * <p>The unique id for an Amplify app. </p>
1488
1511
  */
1489
1512
  appId: string | undefined;
1490
1513
  /**
1491
1514
  * @public
1492
- * <p> The name for the backend environment. </p>
1515
+ * <p>The name for the backend environment. </p>
1493
1516
  */
1494
1517
  environmentName: string | undefined;
1495
1518
  }
1496
1519
  /**
1497
1520
  * @public
1498
- * <p> The result structure for the get backend environment result. </p>
1521
+ * <p>The result structure for the get backend environment result. </p>
1499
1522
  */
1500
1523
  export interface GetBackendEnvironmentResult {
1501
1524
  /**
1502
1525
  * @public
1503
- * <p> Describes the backend environment for an Amplify app. </p>
1526
+ * <p>Describes the backend environment for an Amplify app. </p>
1504
1527
  */
1505
1528
  backendEnvironment: BackendEnvironment | undefined;
1506
1529
  }
@@ -1516,7 +1539,7 @@ export interface GetBranchRequest {
1516
1539
  appId: string | undefined;
1517
1540
  /**
1518
1541
  * @public
1519
- * <p> The name for the branch. </p>
1542
+ * <p>The name of the branch. </p>
1520
1543
  */
1521
1544
  branchName: string | undefined;
1522
1545
  }
@@ -1560,22 +1583,22 @@ export interface GetDomainAssociationResult {
1560
1583
  }
1561
1584
  /**
1562
1585
  * @public
1563
- * <p> The request structure for the get job request. </p>
1586
+ * <p>The request structure for the get job request. </p>
1564
1587
  */
1565
1588
  export interface GetJobRequest {
1566
1589
  /**
1567
1590
  * @public
1568
- * <p> The unique ID for an Amplify app. </p>
1591
+ * <p>The unique ID for an Amplify app. </p>
1569
1592
  */
1570
1593
  appId: string | undefined;
1571
1594
  /**
1572
1595
  * @public
1573
- * <p> The branch name for the job. </p>
1596
+ * <p>The name of the branch to use for the job. </p>
1574
1597
  */
1575
1598
  branchName: string | undefined;
1576
1599
  /**
1577
1600
  * @public
1578
- * <p> The unique ID for the job. </p>
1601
+ * <p>The unique ID for the job. </p>
1579
1602
  */
1580
1603
  jobId: string | undefined;
1581
1604
  }
@@ -1669,56 +1692,56 @@ export interface GetJobResult {
1669
1692
  }
1670
1693
  /**
1671
1694
  * @public
1672
- * <p> The request structure for the get webhook request. </p>
1695
+ * <p>The request structure for the get webhook request. </p>
1673
1696
  */
1674
1697
  export interface GetWebhookRequest {
1675
1698
  /**
1676
1699
  * @public
1677
- * <p> The unique ID for a webhook. </p>
1700
+ * <p>The unique ID for a webhook. </p>
1678
1701
  */
1679
1702
  webhookId: string | undefined;
1680
1703
  }
1681
1704
  /**
1682
1705
  * @public
1683
- * <p> The result structure for the get webhook request. </p>
1706
+ * <p>The result structure for the get webhook request. </p>
1684
1707
  */
1685
1708
  export interface GetWebhookResult {
1686
1709
  /**
1687
1710
  * @public
1688
- * <p> Describes the structure of a webhook. </p>
1711
+ * <p>Describes the structure of a webhook. </p>
1689
1712
  */
1690
1713
  webhook: Webhook | undefined;
1691
1714
  }
1692
1715
  /**
1693
1716
  * @public
1694
- * <p> The request structure for the list apps request. </p>
1717
+ * <p>The request structure for the list apps request. </p>
1695
1718
  */
1696
1719
  export interface ListAppsRequest {
1697
1720
  /**
1698
1721
  * @public
1699
- * <p> A pagination token. If non-null, the pagination token is returned in a result. Pass
1722
+ * <p>A pagination token. If non-null, the pagination token is returned in a result. Pass
1700
1723
  * its value in another request to retrieve more entries. </p>
1701
1724
  */
1702
1725
  nextToken?: string;
1703
1726
  /**
1704
1727
  * @public
1705
- * <p> The maximum number of records to list in a single response. </p>
1728
+ * <p>The maximum number of records to list in a single response. </p>
1706
1729
  */
1707
1730
  maxResults?: number;
1708
1731
  }
1709
1732
  /**
1710
1733
  * @public
1711
- * <p> The result structure for an Amplify app list request. </p>
1734
+ * <p>The result structure for an Amplify app list request. </p>
1712
1735
  */
1713
1736
  export interface ListAppsResult {
1714
1737
  /**
1715
1738
  * @public
1716
- * <p> A list of Amplify apps. </p>
1739
+ * <p>A list of Amplify apps. </p>
1717
1740
  */
1718
1741
  apps: App[] | undefined;
1719
1742
  /**
1720
1743
  * @public
1721
- * <p> A pagination token. Set to null to start listing apps from start. If non-null, the
1744
+ * <p>A pagination token. Set to null to start listing apps from start. If non-null, the
1722
1745
  * pagination token is returned in a result. Pass its value in here to list more projects.
1723
1746
  * </p>
1724
1747
  */
@@ -1726,128 +1749,128 @@ export interface ListAppsResult {
1726
1749
  }
1727
1750
  /**
1728
1751
  * @public
1729
- * <p> Describes the request structure for the list artifacts request. </p>
1752
+ * <p>Describes the request structure for the list artifacts request. </p>
1730
1753
  */
1731
1754
  export interface ListArtifactsRequest {
1732
1755
  /**
1733
1756
  * @public
1734
- * <p> The unique ID for an Amplify app. </p>
1757
+ * <p>The unique ID for an Amplify app. </p>
1735
1758
  */
1736
1759
  appId: string | undefined;
1737
1760
  /**
1738
1761
  * @public
1739
- * <p> The name of a branch that is part of an Amplify app. </p>
1762
+ * <p>The name of a branch that is part of an Amplify app. </p>
1740
1763
  */
1741
1764
  branchName: string | undefined;
1742
1765
  /**
1743
1766
  * @public
1744
- * <p> The unique ID for a job. </p>
1767
+ * <p>The unique ID for a job. </p>
1745
1768
  */
1746
1769
  jobId: string | undefined;
1747
1770
  /**
1748
1771
  * @public
1749
- * <p> A pagination token. Set to null to start listing artifacts from start. If a non-null
1772
+ * <p>A pagination token. Set to null to start listing artifacts from start. If a non-null
1750
1773
  * pagination token is returned in a result, pass its value in here to list more artifacts.
1751
1774
  * </p>
1752
1775
  */
1753
1776
  nextToken?: string;
1754
1777
  /**
1755
1778
  * @public
1756
- * <p> The maximum number of records to list in a single response. </p>
1779
+ * <p>The maximum number of records to list in a single response. </p>
1757
1780
  */
1758
1781
  maxResults?: number;
1759
1782
  }
1760
1783
  /**
1761
1784
  * @public
1762
- * <p> Describes an artifact. </p>
1785
+ * <p>Describes an artifact. </p>
1763
1786
  */
1764
1787
  export interface Artifact {
1765
1788
  /**
1766
1789
  * @public
1767
- * <p> The file name for the artifact. </p>
1790
+ * <p>The file name for the artifact. </p>
1768
1791
  */
1769
1792
  artifactFileName: string | undefined;
1770
1793
  /**
1771
1794
  * @public
1772
- * <p> The unique ID for the artifact. </p>
1795
+ * <p>The unique ID for the artifact. </p>
1773
1796
  */
1774
1797
  artifactId: string | undefined;
1775
1798
  }
1776
1799
  /**
1777
1800
  * @public
1778
- * <p> The result structure for the list artifacts request. </p>
1801
+ * <p>The result structure for the list artifacts request. </p>
1779
1802
  */
1780
1803
  export interface ListArtifactsResult {
1781
1804
  /**
1782
1805
  * @public
1783
- * <p> A list of artifacts. </p>
1806
+ * <p>A list of artifacts. </p>
1784
1807
  */
1785
1808
  artifacts: Artifact[] | undefined;
1786
1809
  /**
1787
1810
  * @public
1788
- * <p> A pagination token. If a non-null pagination token is returned in a result, pass its
1811
+ * <p>A pagination token. If a non-null pagination token is returned in a result, pass its
1789
1812
  * value in another request to retrieve more entries. </p>
1790
1813
  */
1791
1814
  nextToken?: string;
1792
1815
  }
1793
1816
  /**
1794
1817
  * @public
1795
- * <p> The request structure for the list backend environments request. </p>
1818
+ * <p>The request structure for the list backend environments request. </p>
1796
1819
  */
1797
1820
  export interface ListBackendEnvironmentsRequest {
1798
1821
  /**
1799
1822
  * @public
1800
- * <p> The unique ID for an Amplify app. </p>
1823
+ * <p>The unique ID for an Amplify app. </p>
1801
1824
  */
1802
1825
  appId: string | undefined;
1803
1826
  /**
1804
1827
  * @public
1805
- * <p> The name of the backend environment </p>
1828
+ * <p>The name of the backend environment </p>
1806
1829
  */
1807
1830
  environmentName?: string;
1808
1831
  /**
1809
1832
  * @public
1810
- * <p> A pagination token. Set to null to start listing backend environments from the start.
1833
+ * <p>A pagination token. Set to null to start listing backend environments from the start.
1811
1834
  * If a non-null pagination token is returned in a result, pass its value in here to list
1812
1835
  * more backend environments. </p>
1813
1836
  */
1814
1837
  nextToken?: string;
1815
1838
  /**
1816
1839
  * @public
1817
- * <p> The maximum number of records to list in a single response. </p>
1840
+ * <p>The maximum number of records to list in a single response. </p>
1818
1841
  */
1819
1842
  maxResults?: number;
1820
1843
  }
1821
1844
  /**
1822
1845
  * @public
1823
- * <p> The result structure for the list backend environments result. </p>
1846
+ * <p>The result structure for the list backend environments result. </p>
1824
1847
  */
1825
1848
  export interface ListBackendEnvironmentsResult {
1826
1849
  /**
1827
1850
  * @public
1828
- * <p> The list of backend environments for an Amplify app. </p>
1851
+ * <p>The list of backend environments for an Amplify app. </p>
1829
1852
  */
1830
1853
  backendEnvironments: BackendEnvironment[] | undefined;
1831
1854
  /**
1832
1855
  * @public
1833
- * <p> A pagination token. If a non-null pagination token is returned in a result, pass its
1856
+ * <p>A pagination token. If a non-null pagination token is returned in a result, pass its
1834
1857
  * value in another request to retrieve more entries. </p>
1835
1858
  */
1836
1859
  nextToken?: string;
1837
1860
  }
1838
1861
  /**
1839
1862
  * @public
1840
- * <p> The request structure for the list branches request. </p>
1863
+ * <p>The request structure for the list branches request. </p>
1841
1864
  */
1842
1865
  export interface ListBranchesRequest {
1843
1866
  /**
1844
1867
  * @public
1845
- * <p> The unique ID for an Amplify app. </p>
1868
+ * <p>The unique ID for an Amplify app. </p>
1846
1869
  */
1847
1870
  appId: string | undefined;
1848
1871
  /**
1849
1872
  * @public
1850
- * <p> A pagination token. Set to null to start listing branches from the start. If a
1873
+ * <p>A pagination token. Set to null to start listing branches from the start. If a
1851
1874
  * non-null pagination token is returned in a result, pass its value in here to list more
1852
1875
  * branches. </p>
1853
1876
  */
@@ -1927,64 +1950,64 @@ export interface ListJobsRequest {
1927
1950
  appId: string | undefined;
1928
1951
  /**
1929
1952
  * @public
1930
- * <p> The name for a branch. </p>
1953
+ * <p>The name of the branch to use for the request. </p>
1931
1954
  */
1932
1955
  branchName: string | undefined;
1933
1956
  /**
1934
1957
  * @public
1935
- * <p> A pagination token. Set to null to start listing steps from the start. If a non-null
1958
+ * <p>A pagination token. Set to null to start listing steps from the start. If a non-null
1936
1959
  * pagination token is returned in a result, pass its value in here to list more steps.
1937
1960
  * </p>
1938
1961
  */
1939
1962
  nextToken?: string;
1940
1963
  /**
1941
1964
  * @public
1942
- * <p> The maximum number of records to list in a single response. </p>
1965
+ * <p>The maximum number of records to list in a single response. </p>
1943
1966
  */
1944
1967
  maxResults?: number;
1945
1968
  }
1946
1969
  /**
1947
1970
  * @public
1948
- * <p> The maximum number of records to list in a single response. </p>
1971
+ * <p>The maximum number of records to list in a single response. </p>
1949
1972
  */
1950
1973
  export interface ListJobsResult {
1951
1974
  /**
1952
1975
  * @public
1953
- * <p> The result structure for the list job result request. </p>
1976
+ * <p>The result structure for the list job result request. </p>
1954
1977
  */
1955
1978
  jobSummaries: JobSummary[] | undefined;
1956
1979
  /**
1957
1980
  * @public
1958
- * <p> A pagination token. If non-null the pagination token is returned in a result. Pass
1981
+ * <p>A pagination token. If non-null the pagination token is returned in a result. Pass
1959
1982
  * its value in another request to retrieve more entries. </p>
1960
1983
  */
1961
1984
  nextToken?: string;
1962
1985
  }
1963
1986
  /**
1964
1987
  * @public
1965
- * <p> The request structure to use to list tags for a resource. </p>
1988
+ * <p>The request structure to use to list tags for a resource. </p>
1966
1989
  */
1967
1990
  export interface ListTagsForResourceRequest {
1968
1991
  /**
1969
1992
  * @public
1970
- * <p> The Amazon Resource Name (ARN) to use to list tags. </p>
1993
+ * <p>The Amazon Resource Name (ARN) to use to list tags. </p>
1971
1994
  */
1972
1995
  resourceArn: string | undefined;
1973
1996
  }
1974
1997
  /**
1975
1998
  * @public
1976
- * <p> The response for the list tags for resource request. </p>
1999
+ * <p>The response for the list tags for resource request. </p>
1977
2000
  */
1978
2001
  export interface ListTagsForResourceResponse {
1979
2002
  /**
1980
2003
  * @public
1981
- * <p> A list of tags for the specified The Amazon Resource Name (ARN). </p>
2004
+ * <p>A list of tags for the specified The Amazon Resource Name (ARN). </p>
1982
2005
  */
1983
2006
  tags?: Record<string, string>;
1984
2007
  }
1985
2008
  /**
1986
2009
  * @public
1987
- * <p> An operation failed due to a non-existent resource. </p>
2010
+ * <p>An operation failed due to a non-existent resource. </p>
1988
2011
  */
1989
2012
  export declare class ResourceNotFoundException extends __BaseException {
1990
2013
  readonly name: "ResourceNotFoundException";
@@ -1997,67 +2020,67 @@ export declare class ResourceNotFoundException extends __BaseException {
1997
2020
  }
1998
2021
  /**
1999
2022
  * @public
2000
- * <p> The request structure for the list webhooks request. </p>
2023
+ * <p>The request structure for the list webhooks request. </p>
2001
2024
  */
2002
2025
  export interface ListWebhooksRequest {
2003
2026
  /**
2004
2027
  * @public
2005
- * <p> The unique ID for an Amplify app. </p>
2028
+ * <p>The unique ID for an Amplify app. </p>
2006
2029
  */
2007
2030
  appId: string | undefined;
2008
2031
  /**
2009
2032
  * @public
2010
- * <p> A pagination token. Set to null to start listing webhooks from the start. If
2033
+ * <p>A pagination token. Set to null to start listing webhooks from the start. If
2011
2034
  * non-null,the pagination token is returned in a result. Pass its value in here to list
2012
2035
  * more webhooks. </p>
2013
2036
  */
2014
2037
  nextToken?: string;
2015
2038
  /**
2016
2039
  * @public
2017
- * <p> The maximum number of records to list in a single response. </p>
2040
+ * <p>The maximum number of records to list in a single response. </p>
2018
2041
  */
2019
2042
  maxResults?: number;
2020
2043
  }
2021
2044
  /**
2022
2045
  * @public
2023
- * <p> The result structure for the list webhooks request. </p>
2046
+ * <p>The result structure for the list webhooks request. </p>
2024
2047
  */
2025
2048
  export interface ListWebhooksResult {
2026
2049
  /**
2027
2050
  * @public
2028
- * <p> A list of webhooks. </p>
2051
+ * <p>A list of webhooks. </p>
2029
2052
  */
2030
2053
  webhooks: Webhook[] | undefined;
2031
2054
  /**
2032
2055
  * @public
2033
- * <p> A pagination token. If non-null, the pagination token is returned in a result. Pass
2056
+ * <p>A pagination token. If non-null, the pagination token is returned in a result. Pass
2034
2057
  * its value in another request to retrieve more entries. </p>
2035
2058
  */
2036
2059
  nextToken?: string;
2037
2060
  }
2038
2061
  /**
2039
2062
  * @public
2040
- * <p> The request structure for the start a deployment request. </p>
2063
+ * <p>The request structure for the start a deployment request. </p>
2041
2064
  */
2042
2065
  export interface StartDeploymentRequest {
2043
2066
  /**
2044
2067
  * @public
2045
- * <p> The unique ID for an Amplify app. </p>
2068
+ * <p>The unique ID for an Amplify app. </p>
2046
2069
  */
2047
2070
  appId: string | undefined;
2048
2071
  /**
2049
2072
  * @public
2050
- * <p> The name for the branch, for the job. </p>
2073
+ * <p>The name of the branch to use for the job. </p>
2051
2074
  */
2052
2075
  branchName: string | undefined;
2053
2076
  /**
2054
2077
  * @public
2055
- * <p> The job ID for this deployment, generated by the create deployment request. </p>
2078
+ * <p>The job ID for this deployment, generated by the create deployment request. </p>
2056
2079
  */
2057
2080
  jobId?: string;
2058
2081
  /**
2059
2082
  * @public
2060
- * <p> The source URL for this deployment, used when calling start deployment without create
2083
+ * <p>The source URL for this deployment, used when calling start deployment without create
2061
2084
  * deployment. The source URL can be any HTTP GET URL that is publicly accessible and
2062
2085
  * downloads a single .zip file. </p>
2063
2086
  */
@@ -2065,48 +2088,49 @@ export interface StartDeploymentRequest {
2065
2088
  }
2066
2089
  /**
2067
2090
  * @public
2068
- * <p> The result structure for the start a deployment request. </p>
2091
+ * <p>The result structure for the start a deployment request. </p>
2069
2092
  */
2070
2093
  export interface StartDeploymentResult {
2071
2094
  /**
2072
2095
  * @public
2073
- * <p> The summary for the job. </p>
2096
+ * <p>The summary for the job. </p>
2074
2097
  */
2075
2098
  jobSummary: JobSummary | undefined;
2076
2099
  }
2077
2100
  /**
2078
2101
  * @public
2079
- * <p> The request structure for the start job request. </p>
2102
+ * <p>The request structure for the start job request. </p>
2080
2103
  */
2081
2104
  export interface StartJobRequest {
2082
2105
  /**
2083
2106
  * @public
2084
- * <p> The unique ID for an Amplify app. </p>
2107
+ * <p>The unique ID for an Amplify app. </p>
2085
2108
  */
2086
2109
  appId: string | undefined;
2087
2110
  /**
2088
2111
  * @public
2089
- * <p> The branch name for the job. </p>
2112
+ * <p>The name of the branch to use for the job. </p>
2090
2113
  */
2091
2114
  branchName: string | undefined;
2092
2115
  /**
2093
2116
  * @public
2094
- * <p> The unique ID for an existing job. This is required if the value of
2117
+ * <p>The unique ID for an existing job. This is required if the value of
2095
2118
  * <code>jobType</code> is <code>RETRY</code>. </p>
2096
2119
  */
2097
2120
  jobId?: string;
2098
2121
  /**
2099
2122
  * @public
2100
- * <p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job
2123
+ * <p>Describes the type for the job. The job type <code>RELEASE</code> starts a new job
2101
2124
  * with the latest change from the specified branch. This value is available only for apps
2102
- * that are connected to a repository. The job type <code>RETRY</code> retries an existing
2125
+ * that are connected to a repository. </p>
2126
+ * <p>The job type <code>RETRY</code> retries an existing
2103
2127
  * job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also
2104
2128
  * required. </p>
2105
2129
  */
2106
2130
  jobType: JobType | undefined;
2107
2131
  /**
2108
2132
  * @public
2109
- * <p> A descriptive reason for starting this job. </p>
2133
+ * <p>A descriptive reason for starting the job.</p>
2110
2134
  */
2111
2135
  jobReason?: string;
2112
2136
  /**
@@ -2148,7 +2172,7 @@ export interface StopJobRequest {
2148
2172
  appId: string | undefined;
2149
2173
  /**
2150
2174
  * @public
2151
- * <p> The name for the branch, for the job. </p>
2175
+ * <p>The name of the branch to use for the stop job request. </p>
2152
2176
  */
2153
2177
  branchName: string | undefined;
2154
2178
  /**
@@ -2170,7 +2194,7 @@ export interface StopJobResult {
2170
2194
  }
2171
2195
  /**
2172
2196
  * @public
2173
- * <p> The request structure to tag a resource with a tag key and value. </p>
2197
+ * <p>The request structure to tag a resource with a tag key and value.</p>
2174
2198
  */
2175
2199
  export interface TagResourceRequest {
2176
2200
  /**
@@ -2180,61 +2204,61 @@ export interface TagResourceRequest {
2180
2204
  resourceArn: string | undefined;
2181
2205
  /**
2182
2206
  * @public
2183
- * <p> The tags used to tag the resource. </p>
2207
+ * <p>The tags used to tag the resource. </p>
2184
2208
  */
2185
2209
  tags: Record<string, string> | undefined;
2186
2210
  }
2187
2211
  /**
2188
2212
  * @public
2189
- * <p> The response for the tag resource request. </p>
2213
+ * <p>The response for the tag resource request. </p>
2190
2214
  */
2191
2215
  export interface TagResourceResponse {
2192
2216
  }
2193
2217
  /**
2194
2218
  * @public
2195
- * <p> The request structure for the untag resource request. </p>
2219
+ * <p>The request structure for the untag resource request. </p>
2196
2220
  */
2197
2221
  export interface UntagResourceRequest {
2198
2222
  /**
2199
2223
  * @public
2200
- * <p> The Amazon Resource Name (ARN) to use to untag a resource. </p>
2224
+ * <p>The Amazon Resource Name (ARN) to use to untag a resource. </p>
2201
2225
  */
2202
2226
  resourceArn: string | undefined;
2203
2227
  /**
2204
2228
  * @public
2205
- * <p> The tag keys to use to untag a resource. </p>
2229
+ * <p>The tag keys to use to untag a resource. </p>
2206
2230
  */
2207
2231
  tagKeys: string[] | undefined;
2208
2232
  }
2209
2233
  /**
2210
2234
  * @public
2211
- * <p> The response for the untag resource request. </p>
2235
+ * <p>The response for the untag resource request. </p>
2212
2236
  */
2213
2237
  export interface UntagResourceResponse {
2214
2238
  }
2215
2239
  /**
2216
2240
  * @public
2217
- * <p> The request structure for the update app request. </p>
2241
+ * <p>The request structure for the update app request. </p>
2218
2242
  */
2219
2243
  export interface UpdateAppRequest {
2220
2244
  /**
2221
2245
  * @public
2222
- * <p> The unique ID for an Amplify app. </p>
2246
+ * <p>The unique ID for an Amplify app. </p>
2223
2247
  */
2224
2248
  appId: string | undefined;
2225
2249
  /**
2226
2250
  * @public
2227
- * <p> The name for an Amplify app. </p>
2251
+ * <p>The name for an Amplify app. </p>
2228
2252
  */
2229
2253
  name?: string;
2230
2254
  /**
2231
2255
  * @public
2232
- * <p> The description for an Amplify app. </p>
2256
+ * <p>The description for an Amplify app. </p>
2233
2257
  */
2234
2258
  description?: string;
2235
2259
  /**
2236
2260
  * @public
2237
- * <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
2261
+ * <p>The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
2238
2262
  * For a dynamic server-side rendered (SSR) app, set the platform type to
2239
2263
  * <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
2240
2264
  * <code>WEB_DYNAMIC</code>.</p>
@@ -2242,45 +2266,45 @@ export interface UpdateAppRequest {
2242
2266
  platform?: Platform;
2243
2267
  /**
2244
2268
  * @public
2245
- * <p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
2269
+ * <p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
2246
2270
  */
2247
2271
  iamServiceRoleArn?: string;
2248
2272
  /**
2249
2273
  * @public
2250
- * <p> The environment variables for an Amplify app. </p>
2274
+ * <p>The environment variables for an Amplify app. </p>
2251
2275
  */
2252
2276
  environmentVariables?: Record<string, string>;
2253
2277
  /**
2254
2278
  * @public
2255
- * <p> Enables branch auto-building for an Amplify app. </p>
2279
+ * <p>Enables branch auto-building for an Amplify app. </p>
2256
2280
  */
2257
2281
  enableBranchAutoBuild?: boolean;
2258
2282
  /**
2259
2283
  * @public
2260
- * <p> Automatically disconnects a branch in the Amplify Console when you delete a branch
2284
+ * <p>Automatically disconnects a branch in the Amplify console when you delete a branch
2261
2285
  * from your Git repository. </p>
2262
2286
  */
2263
2287
  enableBranchAutoDeletion?: boolean;
2264
2288
  /**
2265
2289
  * @public
2266
- * <p> Enables basic authorization for an Amplify app. </p>
2290
+ * <p>Enables basic authorization for an Amplify app. </p>
2267
2291
  */
2268
2292
  enableBasicAuth?: boolean;
2269
2293
  /**
2270
2294
  * @public
2271
- * <p> The basic authorization credentials for an Amplify app. You must base64-encode the
2295
+ * <p>The basic authorization credentials for an Amplify app. You must base64-encode the
2272
2296
  * authorization credentials and provide them in the format
2273
2297
  * <code>user:password</code>.</p>
2274
2298
  */
2275
2299
  basicAuthCredentials?: string;
2276
2300
  /**
2277
2301
  * @public
2278
- * <p> The custom redirect and rewrite rules for an Amplify app. </p>
2302
+ * <p>The custom redirect and rewrite rules for an Amplify app. </p>
2279
2303
  */
2280
2304
  customRules?: CustomRule[];
2281
2305
  /**
2282
2306
  * @public
2283
- * <p> The build specification (build spec) for an Amplify app. </p>
2307
+ * <p>The build specification (build spec) for an Amplify app. </p>
2284
2308
  */
2285
2309
  buildSpec?: string;
2286
2310
  /**
@@ -2290,22 +2314,22 @@ export interface UpdateAppRequest {
2290
2314
  customHeaders?: string;
2291
2315
  /**
2292
2316
  * @public
2293
- * <p> Enables automated branch creation for an Amplify app. </p>
2317
+ * <p>Enables automated branch creation for an Amplify app. </p>
2294
2318
  */
2295
2319
  enableAutoBranchCreation?: boolean;
2296
2320
  /**
2297
2321
  * @public
2298
- * <p> Describes the automated branch creation glob patterns for an Amplify app. </p>
2322
+ * <p>Describes the automated branch creation glob patterns for an Amplify app. </p>
2299
2323
  */
2300
2324
  autoBranchCreationPatterns?: string[];
2301
2325
  /**
2302
2326
  * @public
2303
- * <p> The automated branch creation configuration for an Amplify app. </p>
2327
+ * <p>The automated branch creation configuration for an Amplify app. </p>
2304
2328
  */
2305
2329
  autoBranchCreationConfig?: AutoBranchCreationConfig;
2306
2330
  /**
2307
2331
  * @public
2308
- * <p> The name of the repository for an Amplify app </p>
2332
+ * <p>The name of the Git repository for an Amplify app.</p>
2309
2333
  */
2310
2334
  repository?: string;
2311
2335
  /**
@@ -2321,7 +2345,7 @@ export interface UpdateAppRequest {
2321
2345
  * update an app.</p>
2322
2346
  * <p>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work
2323
2347
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
2324
- * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
2348
+ * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
2325
2349
  * <i>Amplify User Guide</i> .</p>
2326
2350
  */
2327
2351
  oauthToken?: string;
@@ -2336,25 +2360,25 @@ export interface UpdateAppRequest {
2336
2360
  * update an app.</p>
2337
2361
  * <p>Existing Amplify apps deployed from a GitHub repository using OAuth continue to work
2338
2362
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
2339
- * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/UserGuide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
2363
+ * App. For more information, see <a href="https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth">Migrating an existing OAuth app to the Amplify GitHub App</a> in the
2340
2364
  * <i>Amplify User Guide</i> .</p>
2341
2365
  */
2342
2366
  accessToken?: string;
2343
2367
  }
2344
2368
  /**
2345
2369
  * @public
2346
- * <p> The result structure for an Amplify app update request. </p>
2370
+ * <p>The result structure for an Amplify app update request. </p>
2347
2371
  */
2348
2372
  export interface UpdateAppResult {
2349
2373
  /**
2350
2374
  * @public
2351
- * <p> Represents the updated Amplify app. </p>
2375
+ * <p>Represents the updated Amplify app. </p>
2352
2376
  */
2353
2377
  app: App | undefined;
2354
2378
  }
2355
2379
  /**
2356
2380
  * @public
2357
- * <p> The request structure for the update branch request. </p>
2381
+ * <p>The request structure for the update branch request. </p>
2358
2382
  */
2359
2383
  export interface UpdateBranchRequest {
2360
2384
  /**
@@ -2364,7 +2388,7 @@ export interface UpdateBranchRequest {
2364
2388
  appId: string | undefined;
2365
2389
  /**
2366
2390
  * @public
2367
- * <p> The name for the branch. </p>
2391
+ * <p>The name of the branch. </p>
2368
2392
  */
2369
2393
  branchName: string | undefined;
2370
2394
  /**
@@ -2444,10 +2468,15 @@ export interface UpdateBranchRequest {
2444
2468
  pullRequestEnvironmentName?: string;
2445
2469
  /**
2446
2470
  * @public
2447
- * <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
2471
+ * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
2448
2472
  * app. </p>
2449
2473
  */
2450
2474
  backendEnvironmentArn?: string;
2475
+ /**
2476
+ * @public
2477
+ * <p>The backend for a <code>Branch</code> of an Amplify app. Use for a backend created from an CloudFormation stack.</p>
2478
+ */
2479
+ backend?: Backend;
2451
2480
  }
2452
2481
  /**
2453
2482
  * @public
@@ -2511,33 +2540,33 @@ export interface UpdateDomainAssociationResult {
2511
2540
  }
2512
2541
  /**
2513
2542
  * @public
2514
- * <p> The request structure for the update webhook request. </p>
2543
+ * <p>The request structure for the update webhook request. </p>
2515
2544
  */
2516
2545
  export interface UpdateWebhookRequest {
2517
2546
  /**
2518
2547
  * @public
2519
- * <p> The unique ID for a webhook. </p>
2548
+ * <p>The unique ID for a webhook. </p>
2520
2549
  */
2521
2550
  webhookId: string | undefined;
2522
2551
  /**
2523
2552
  * @public
2524
- * <p> The name for a branch that is part of an Amplify app. </p>
2553
+ * <p>The name for a branch that is part of an Amplify app. </p>
2525
2554
  */
2526
2555
  branchName?: string;
2527
2556
  /**
2528
2557
  * @public
2529
- * <p> The description for a webhook. </p>
2558
+ * <p>The description for a webhook. </p>
2530
2559
  */
2531
2560
  description?: string;
2532
2561
  }
2533
2562
  /**
2534
2563
  * @public
2535
- * <p> The result structure for the update webhook request. </p>
2564
+ * <p>The result structure for the update webhook request. </p>
2536
2565
  */
2537
2566
  export interface UpdateWebhookResult {
2538
2567
  /**
2539
2568
  * @public
2540
- * <p> Describes a webhook that connects repository events to an Amplify app. </p>
2569
+ * <p>Describes a webhook that connects repository events to an Amplify app. </p>
2541
2570
  */
2542
2571
  webhook: Webhook | undefined;
2543
2572
  }