@aws-sdk/client-amplify 3.533.0 → 3.535.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 (79) hide show
  1. package/dist-types/Amplify.d.ts +2 -1
  2. package/dist-types/AmplifyClient.d.ts +1 -1
  3. package/dist-types/commands/CreateAppCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateBackendEnvironmentCommand.d.ts +8 -1
  5. package/dist-types/commands/CreateBranchCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateDeploymentCommand.d.ts +2 -1
  7. package/dist-types/commands/CreateDomainAssociationCommand.d.ts +2 -1
  8. package/dist-types/commands/CreateWebhookCommand.d.ts +2 -1
  9. package/dist-types/commands/DeleteAppCommand.d.ts +2 -1
  10. package/dist-types/commands/DeleteBackendEnvironmentCommand.d.ts +8 -1
  11. package/dist-types/commands/DeleteBranchCommand.d.ts +2 -1
  12. package/dist-types/commands/DeleteDomainAssociationCommand.d.ts +2 -1
  13. package/dist-types/commands/DeleteJobCommand.d.ts +2 -1
  14. package/dist-types/commands/DeleteWebhookCommand.d.ts +2 -1
  15. package/dist-types/commands/GenerateAccessLogsCommand.d.ts +2 -1
  16. package/dist-types/commands/GetAppCommand.d.ts +2 -1
  17. package/dist-types/commands/GetArtifactUrlCommand.d.ts +2 -1
  18. package/dist-types/commands/GetBackendEnvironmentCommand.d.ts +8 -1
  19. package/dist-types/commands/GetBranchCommand.d.ts +2 -1
  20. package/dist-types/commands/GetDomainAssociationCommand.d.ts +2 -1
  21. package/dist-types/commands/GetJobCommand.d.ts +2 -1
  22. package/dist-types/commands/GetWebhookCommand.d.ts +2 -1
  23. package/dist-types/commands/ListAppsCommand.d.ts +2 -1
  24. package/dist-types/commands/ListArtifactsCommand.d.ts +2 -1
  25. package/dist-types/commands/ListBackendEnvironmentsCommand.d.ts +8 -1
  26. package/dist-types/commands/ListBranchesCommand.d.ts +2 -1
  27. package/dist-types/commands/ListDomainAssociationsCommand.d.ts +2 -1
  28. package/dist-types/commands/ListJobsCommand.d.ts +2 -1
  29. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  30. package/dist-types/commands/ListWebhooksCommand.d.ts +2 -1
  31. package/dist-types/commands/StartDeploymentCommand.d.ts +2 -1
  32. package/dist-types/commands/StartJobCommand.d.ts +2 -1
  33. package/dist-types/commands/StopJobCommand.d.ts +2 -1
  34. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  35. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  36. package/dist-types/commands/UpdateAppCommand.d.ts +2 -1
  37. package/dist-types/commands/UpdateBranchCommand.d.ts +2 -1
  38. package/dist-types/commands/UpdateDomainAssociationCommand.d.ts +2 -1
  39. package/dist-types/commands/UpdateWebhookCommand.d.ts +2 -1
  40. package/dist-types/models/models_0.d.ts +440 -440
  41. package/dist-types/ts3.4/Amplify.d.ts +1 -0
  42. package/dist-types/ts3.4/commands/CreateAppCommand.d.ts +9 -0
  43. package/dist-types/ts3.4/commands/CreateBackendEnvironmentCommand.d.ts +9 -0
  44. package/dist-types/ts3.4/commands/CreateBranchCommand.d.ts +9 -0
  45. package/dist-types/ts3.4/commands/CreateDeploymentCommand.d.ts +9 -0
  46. package/dist-types/ts3.4/commands/CreateDomainAssociationCommand.d.ts +9 -0
  47. package/dist-types/ts3.4/commands/CreateWebhookCommand.d.ts +9 -0
  48. package/dist-types/ts3.4/commands/DeleteAppCommand.d.ts +9 -0
  49. package/dist-types/ts3.4/commands/DeleteBackendEnvironmentCommand.d.ts +9 -0
  50. package/dist-types/ts3.4/commands/DeleteBranchCommand.d.ts +9 -0
  51. package/dist-types/ts3.4/commands/DeleteDomainAssociationCommand.d.ts +9 -0
  52. package/dist-types/ts3.4/commands/DeleteJobCommand.d.ts +9 -0
  53. package/dist-types/ts3.4/commands/DeleteWebhookCommand.d.ts +9 -0
  54. package/dist-types/ts3.4/commands/GenerateAccessLogsCommand.d.ts +9 -0
  55. package/dist-types/ts3.4/commands/GetAppCommand.d.ts +7 -0
  56. package/dist-types/ts3.4/commands/GetArtifactUrlCommand.d.ts +9 -0
  57. package/dist-types/ts3.4/commands/GetBackendEnvironmentCommand.d.ts +9 -0
  58. package/dist-types/ts3.4/commands/GetBranchCommand.d.ts +9 -0
  59. package/dist-types/ts3.4/commands/GetDomainAssociationCommand.d.ts +9 -0
  60. package/dist-types/ts3.4/commands/GetJobCommand.d.ts +7 -0
  61. package/dist-types/ts3.4/commands/GetWebhookCommand.d.ts +9 -0
  62. package/dist-types/ts3.4/commands/ListAppsCommand.d.ts +9 -0
  63. package/dist-types/ts3.4/commands/ListArtifactsCommand.d.ts +9 -0
  64. package/dist-types/ts3.4/commands/ListBackendEnvironmentsCommand.d.ts +9 -0
  65. package/dist-types/ts3.4/commands/ListBranchesCommand.d.ts +9 -0
  66. package/dist-types/ts3.4/commands/ListDomainAssociationsCommand.d.ts +9 -0
  67. package/dist-types/ts3.4/commands/ListJobsCommand.d.ts +9 -0
  68. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  69. package/dist-types/ts3.4/commands/ListWebhooksCommand.d.ts +9 -0
  70. package/dist-types/ts3.4/commands/StartDeploymentCommand.d.ts +9 -0
  71. package/dist-types/ts3.4/commands/StartJobCommand.d.ts +9 -0
  72. package/dist-types/ts3.4/commands/StopJobCommand.d.ts +7 -0
  73. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  74. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  75. package/dist-types/ts3.4/commands/UpdateAppCommand.d.ts +9 -0
  76. package/dist-types/ts3.4/commands/UpdateBranchCommand.d.ts +9 -0
  77. package/dist-types/ts3.4/commands/UpdateDomainAssociationCommand.d.ts +9 -0
  78. package/dist-types/ts3.4/commands/UpdateWebhookCommand.d.ts +9 -0
  79. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { AmplifyServiceException as __BaseException } from "./AmplifyServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>A request contains unexpected data. </p>
5
+ * @public
6
6
  */
7
7
  export declare class BadRequestException extends __BaseException {
8
8
  readonly name: "BadRequestException";
@@ -28,83 +28,82 @@ export declare const Stage: {
28
28
  */
29
29
  export type Stage = (typeof Stage)[keyof typeof Stage];
30
30
  /**
31
- * @public
32
31
  * <p>Describes the automated branch creation configuration. </p>
32
+ * @public
33
33
  */
34
34
  export interface AutoBranchCreationConfig {
35
35
  /**
36
- * @public
37
36
  * <p>Describes the current stage for the autocreated branch. </p>
37
+ * @public
38
38
  */
39
39
  stage?: Stage;
40
40
  /**
41
- * @public
42
41
  * <p>The framework for the autocreated branch. </p>
42
+ * @public
43
43
  */
44
44
  framework?: string;
45
45
  /**
46
- * @public
47
46
  * <p>Enables auto building for the autocreated branch. </p>
47
+ * @public
48
48
  */
49
49
  enableAutoBuild?: boolean;
50
50
  /**
51
- * @public
52
51
  * <p>The environment variables for the autocreated branch. </p>
52
+ * @public
53
53
  */
54
54
  environmentVariables?: Record<string, string>;
55
55
  /**
56
- * @public
57
56
  * <p>The basic authorization credentials for the autocreated branch. You must base64-encode
58
57
  * the authorization credentials and provide them in the format
59
58
  * <code>user:password</code>.</p>
59
+ * @public
60
60
  */
61
61
  basicAuthCredentials?: string;
62
62
  /**
63
- * @public
64
63
  * <p>Enables basic authorization for the autocreated branch. </p>
64
+ * @public
65
65
  */
66
66
  enableBasicAuth?: boolean;
67
67
  /**
68
- * @public
69
68
  * <p>Enables performance mode for the branch.</p>
70
69
  * <p>Performance mode optimizes for faster hosting performance by keeping content cached at
71
70
  * the edge for a longer interval. When performance mode is enabled, hosting configuration
72
71
  * or code changes can take up to 10 minutes to roll out. </p>
72
+ * @public
73
73
  */
74
74
  enablePerformanceMode?: boolean;
75
75
  /**
76
- * @public
77
76
  * <p>The build specification (build spec) for the autocreated branch. </p>
77
+ * @public
78
78
  */
79
79
  buildSpec?: string;
80
80
  /**
81
- * @public
82
81
  * <p>Enables pull request previews for the autocreated branch. </p>
82
+ * @public
83
83
  */
84
84
  enablePullRequestPreview?: boolean;
85
85
  /**
86
- * @public
87
86
  * <p>The Amplify environment name for the pull request. </p>
87
+ * @public
88
88
  */
89
89
  pullRequestEnvironmentName?: string;
90
90
  }
91
91
  /**
92
- * @public
93
92
  * <p>Describes a custom rewrite or redirect rule. </p>
93
+ * @public
94
94
  */
95
95
  export interface CustomRule {
96
96
  /**
97
- * @public
98
97
  * <p>The source pattern for a URL rewrite or redirect rule. </p>
98
+ * @public
99
99
  */
100
100
  source: string | undefined;
101
101
  /**
102
- * @public
103
102
  * <p>The target pattern for a URL rewrite or redirect rule. </p>
103
+ * @public
104
104
  */
105
105
  target: string | undefined;
106
106
  /**
107
- * @public
108
107
  * <p>The status code for a URL rewrite or redirect rule. </p>
109
108
  * <dl>
110
109
  * <dt>200</dt>
@@ -129,11 +128,12 @@ export interface CustomRule {
129
128
  * <p>Represents a 404 rewrite rule.</p>
130
129
  * </dd>
131
130
  * </dl>
131
+ * @public
132
132
  */
133
133
  status?: string;
134
134
  /**
135
- * @public
136
135
  * <p>The condition for a URL rewrite or redirect rule, such as a country code. </p>
136
+ * @public
137
137
  */
138
138
  condition?: string;
139
139
  }
@@ -151,40 +151,39 @@ export declare const Platform: {
151
151
  */
152
152
  export type Platform = (typeof Platform)[keyof typeof Platform];
153
153
  /**
154
- * @public
155
154
  * <p>The request structure used to create apps in Amplify. </p>
155
+ * @public
156
156
  */
157
157
  export interface CreateAppRequest {
158
158
  /**
159
- * @public
160
159
  * <p>The name of the Amplify app. </p>
160
+ * @public
161
161
  */
162
162
  name: string | undefined;
163
163
  /**
164
- * @public
165
164
  * <p>The description of the Amplify app. </p>
165
+ * @public
166
166
  */
167
167
  description?: string;
168
168
  /**
169
- * @public
170
169
  * <p>The Git repository for the Amplify app. </p>
170
+ * @public
171
171
  */
172
172
  repository?: string;
173
173
  /**
174
- * @public
175
174
  * <p>The platform for the Amplify app. For a static app, set the platform type to
176
175
  * <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
177
176
  * type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
178
177
  * support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
178
+ * @public
179
179
  */
180
180
  platform?: Platform;
181
181
  /**
182
- * @public
183
182
  * <p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
183
+ * @public
184
184
  */
185
185
  iamServiceRoleArn?: string;
186
186
  /**
187
- * @public
188
187
  * <p>The OAuth token for a third-party source control system for an Amplify app. The OAuth
189
188
  * token is used to create a webhook and a read-only deploy key using SSH cloning. The
190
189
  * OAuth token is not stored.</p>
@@ -197,10 +196,10 @@ export interface CreateAppRequest {
197
196
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
198
197
  * 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
198
  * <i>Amplify User Guide</i> .</p>
199
+ * @public
200
200
  */
201
201
  oauthToken?: string;
202
202
  /**
203
- * @public
204
203
  * <p>The personal access token for a GitHub repository for an Amplify app. The personal
205
204
  * access token is used to authorize access to a GitHub repository using the Amplify GitHub
206
205
  * App. The token is not stored.</p>
@@ -212,100 +211,101 @@ export interface CreateAppRequest {
212
211
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
213
212
  * 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
213
  * <i>Amplify User Guide</i> .</p>
214
+ * @public
215
215
  */
216
216
  accessToken?: string;
217
217
  /**
218
- * @public
219
218
  * <p>The environment variables map for an Amplify app. </p>
220
219
  * <p>For a list of the environment variables that are accessible to Amplify by default, see
221
220
  * <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify
222
221
  * Environment variables</a> in the <i>Amplify Hosting User
223
222
  * Guide</i>.</p>
223
+ * @public
224
224
  */
225
225
  environmentVariables?: Record<string, string>;
226
226
  /**
227
- * @public
228
227
  * <p>Enables the auto building of branches for an Amplify app. </p>
228
+ * @public
229
229
  */
230
230
  enableBranchAutoBuild?: boolean;
231
231
  /**
232
- * @public
233
232
  * <p>Automatically disconnects a branch in the Amplify console when you delete a branch
234
233
  * from your Git repository. </p>
234
+ * @public
235
235
  */
236
236
  enableBranchAutoDeletion?: boolean;
237
237
  /**
238
- * @public
239
238
  * <p>Enables basic authorization for an Amplify app. This will apply to all branches that
240
239
  * are part of this app. </p>
240
+ * @public
241
241
  */
242
242
  enableBasicAuth?: boolean;
243
243
  /**
244
- * @public
245
244
  * <p>The credentials for basic authorization for an Amplify app. You must base64-encode the
246
245
  * authorization credentials and provide them in the format
247
246
  * <code>user:password</code>.</p>
247
+ * @public
248
248
  */
249
249
  basicAuthCredentials?: string;
250
250
  /**
251
- * @public
252
251
  * <p>The custom rewrite and redirect rules for an Amplify app. </p>
252
+ * @public
253
253
  */
254
254
  customRules?: CustomRule[];
255
255
  /**
256
- * @public
257
256
  * <p>The tag for an Amplify app. </p>
257
+ * @public
258
258
  */
259
259
  tags?: Record<string, string>;
260
260
  /**
261
- * @public
262
261
  * <p>The build specification (build spec) for an Amplify app. </p>
262
+ * @public
263
263
  */
264
264
  buildSpec?: string;
265
265
  /**
266
- * @public
267
266
  * <p>The custom HTTP headers for an Amplify app.</p>
267
+ * @public
268
268
  */
269
269
  customHeaders?: string;
270
270
  /**
271
- * @public
272
271
  * <p>Enables automated branch creation for an Amplify app. </p>
272
+ * @public
273
273
  */
274
274
  enableAutoBranchCreation?: boolean;
275
275
  /**
276
- * @public
277
276
  * <p>The automated branch creation glob patterns for an Amplify app. </p>
277
+ * @public
278
278
  */
279
279
  autoBranchCreationPatterns?: string[];
280
280
  /**
281
- * @public
282
281
  * <p>The automated branch creation configuration for an Amplify app. </p>
282
+ * @public
283
283
  */
284
284
  autoBranchCreationConfig?: AutoBranchCreationConfig;
285
285
  }
286
286
  /**
287
- * @public
288
287
  * <p>Describes the information about a production branch for an Amplify app. </p>
288
+ * @public
289
289
  */
290
290
  export interface ProductionBranch {
291
291
  /**
292
- * @public
293
292
  * <p>The last deploy time of the production branch. </p>
293
+ * @public
294
294
  */
295
295
  lastDeployTime?: Date;
296
296
  /**
297
- * @public
298
297
  * <p>The status of the production branch. </p>
298
+ * @public
299
299
  */
300
300
  status?: string;
301
301
  /**
302
- * @public
303
302
  * <p>The thumbnail URL for the production branch. </p>
303
+ * @public
304
304
  */
305
305
  thumbnailUrl?: string;
306
306
  /**
307
- * @public
308
307
  * <p>The branch name for the production branch. </p>
308
+ * @public
309
309
  */
310
310
  branchName?: string;
311
311
  }
@@ -323,140 +323,139 @@ export declare const RepositoryCloneMethod: {
323
323
  */
324
324
  export type RepositoryCloneMethod = (typeof RepositoryCloneMethod)[keyof typeof RepositoryCloneMethod];
325
325
  /**
326
- * @public
327
326
  * <p>Represents the different branches of a repository for building, deploying, and hosting
328
327
  * an Amplify app. </p>
328
+ * @public
329
329
  */
330
330
  export interface App {
331
331
  /**
332
- * @public
333
332
  * <p>The unique ID of the Amplify app. </p>
333
+ * @public
334
334
  */
335
335
  appId: string | undefined;
336
336
  /**
337
- * @public
338
337
  * <p>The Amazon Resource Name (ARN) of the Amplify app. </p>
338
+ * @public
339
339
  */
340
340
  appArn: string | undefined;
341
341
  /**
342
- * @public
343
342
  * <p>The name for the Amplify app. </p>
343
+ * @public
344
344
  */
345
345
  name: string | undefined;
346
346
  /**
347
- * @public
348
347
  * <p>The tag for the Amplify app. </p>
348
+ * @public
349
349
  */
350
350
  tags?: Record<string, string>;
351
351
  /**
352
- * @public
353
352
  * <p>The description for the Amplify app. </p>
353
+ * @public
354
354
  */
355
355
  description: string | undefined;
356
356
  /**
357
- * @public
358
357
  * <p>The Git repository for the Amplify app. </p>
358
+ * @public
359
359
  */
360
360
  repository: string | undefined;
361
361
  /**
362
- * @public
363
362
  * <p>The platform for the Amplify app. For a static app, set the platform type to
364
363
  * <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
365
364
  * type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
366
365
  * support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
366
+ * @public
367
367
  */
368
368
  platform: Platform | undefined;
369
369
  /**
370
- * @public
371
370
  * <p>Creates a date and time for the Amplify app. </p>
371
+ * @public
372
372
  */
373
373
  createTime: Date | undefined;
374
374
  /**
375
- * @public
376
375
  * <p>Updates the date and time for the Amplify app. </p>
376
+ * @public
377
377
  */
378
378
  updateTime: Date | undefined;
379
379
  /**
380
- * @public
381
380
  * <p>The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name
382
381
  * (ARN) of the Amplify app. </p>
382
+ * @public
383
383
  */
384
384
  iamServiceRoleArn?: string;
385
385
  /**
386
- * @public
387
386
  * <p>The environment variables for the Amplify app. </p>
388
387
  * <p>For a list of the environment variables that are accessible to Amplify by default, see
389
388
  * <a href="https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html">Amplify
390
389
  * Environment variables</a> in the <i>Amplify Hosting User
391
390
  * Guide</i>.</p>
391
+ * @public
392
392
  */
393
393
  environmentVariables: Record<string, string> | undefined;
394
394
  /**
395
- * @public
396
395
  * <p>The default domain for the Amplify app. </p>
396
+ * @public
397
397
  */
398
398
  defaultDomain: string | undefined;
399
399
  /**
400
- * @public
401
400
  * <p>Enables the auto-building of branches for the Amplify app. </p>
401
+ * @public
402
402
  */
403
403
  enableBranchAutoBuild: boolean | undefined;
404
404
  /**
405
- * @public
406
405
  * <p>Automatically disconnect a branch in the Amplify console when you delete a branch from
407
406
  * your Git repository.</p>
407
+ * @public
408
408
  */
409
409
  enableBranchAutoDeletion?: boolean;
410
410
  /**
411
- * @public
412
411
  * <p>Enables basic authorization for the Amplify app's branches. </p>
412
+ * @public
413
413
  */
414
414
  enableBasicAuth: boolean | undefined;
415
415
  /**
416
- * @public
417
416
  * <p>The basic authorization credentials for branches for the Amplify app. You must
418
417
  * base64-encode the authorization credentials and provide them in the format
419
418
  * <code>user:password</code>.</p>
419
+ * @public
420
420
  */
421
421
  basicAuthCredentials?: string;
422
422
  /**
423
- * @public
424
423
  * <p>Describes the custom redirect and rewrite rules for the Amplify app. </p>
424
+ * @public
425
425
  */
426
426
  customRules?: CustomRule[];
427
427
  /**
428
- * @public
429
428
  * <p>Describes the information about a production branch of the Amplify app. </p>
429
+ * @public
430
430
  */
431
431
  productionBranch?: ProductionBranch;
432
432
  /**
433
- * @public
434
433
  * <p>Describes the content of the build specification (build spec) for the Amplify app.
435
434
  * </p>
435
+ * @public
436
436
  */
437
437
  buildSpec?: string;
438
438
  /**
439
- * @public
440
439
  * <p>Describes the custom HTTP headers for the Amplify app.</p>
440
+ * @public
441
441
  */
442
442
  customHeaders?: string;
443
443
  /**
444
- * @public
445
444
  * <p>Enables automated branch creation for the Amplify app. </p>
445
+ * @public
446
446
  */
447
447
  enableAutoBranchCreation?: boolean;
448
448
  /**
449
- * @public
450
449
  * <p>Describes the automated branch creation glob patterns for the Amplify app. </p>
450
+ * @public
451
451
  */
452
452
  autoBranchCreationPatterns?: string[];
453
453
  /**
454
- * @public
455
454
  * <p>Describes the automated branch creation configuration for the Amplify app. </p>
455
+ * @public
456
456
  */
457
457
  autoBranchCreationConfig?: AutoBranchCreationConfig;
458
458
  /**
459
- * @public
460
459
  * <note>
461
460
  * <p>This is for internal use.</p>
462
461
  * </note>
@@ -464,6 +463,7 @@ export interface App {
464
463
  * to access the Git repository for an Amplify app. Amplify specifies <code>TOKEN</code>
465
464
  * for a GitHub repository, <code>SIGV4</code> for an Amazon Web Services CodeCommit
466
465
  * repository, and <code>SSH</code> for GitLab and Bitbucket repositories.</p>
466
+ * @public
467
467
  */
468
468
  repositoryCloneMethod?: RepositoryCloneMethod;
469
469
  }
@@ -472,15 +472,15 @@ export interface App {
472
472
  */
473
473
  export interface CreateAppResult {
474
474
  /**
475
- * @public
476
475
  * <p>Represents the different branches of a repository for building, deploying, and hosting
477
476
  * an Amplify app. </p>
477
+ * @public
478
478
  */
479
479
  app: App | undefined;
480
480
  }
481
481
  /**
482
- * @public
483
482
  * <p>An operation failed because a dependent service threw an exception. </p>
483
+ * @public
484
484
  */
485
485
  export declare class DependentServiceFailureException extends __BaseException {
486
486
  readonly name: "DependentServiceFailureException";
@@ -491,8 +491,8 @@ export declare class DependentServiceFailureException extends __BaseException {
491
491
  constructor(opts: __ExceptionOptionType<DependentServiceFailureException, __BaseException>);
492
492
  }
493
493
  /**
494
- * @public
495
494
  * <p>The service failed to perform an operation due to an internal issue. </p>
495
+ * @public
496
496
  */
497
497
  export declare class InternalFailureException extends __BaseException {
498
498
  readonly name: "InternalFailureException";
@@ -503,8 +503,8 @@ export declare class InternalFailureException extends __BaseException {
503
503
  constructor(opts: __ExceptionOptionType<InternalFailureException, __BaseException>);
504
504
  }
505
505
  /**
506
- * @public
507
506
  * <p>A resource could not be created because service quotas were exceeded. </p>
507
+ * @public
508
508
  */
509
509
  export declare class LimitExceededException extends __BaseException {
510
510
  readonly name: "LimitExceededException";
@@ -515,8 +515,8 @@ export declare class LimitExceededException extends __BaseException {
515
515
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
516
516
  }
517
517
  /**
518
- * @public
519
518
  * <p>An operation failed due to a lack of access. </p>
519
+ * @public
520
520
  */
521
521
  export declare class UnauthorizedException extends __BaseException {
522
522
  readonly name: "UnauthorizedException";
@@ -527,84 +527,84 @@ export declare class UnauthorizedException extends __BaseException {
527
527
  constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
528
528
  }
529
529
  /**
530
- * @public
531
530
  * <p>The request structure for the backend environment create request. </p>
531
+ * @public
532
532
  */
533
533
  export interface CreateBackendEnvironmentRequest {
534
534
  /**
535
- * @public
536
535
  * <p>The unique ID for an Amplify app. </p>
536
+ * @public
537
537
  */
538
538
  appId: string | undefined;
539
539
  /**
540
- * @public
541
540
  * <p>The name for the backend environment. </p>
541
+ * @public
542
542
  */
543
543
  environmentName: string | undefined;
544
544
  /**
545
- * @public
546
545
  * <p>The AWS CloudFormation stack name of a backend environment. </p>
546
+ * @public
547
547
  */
548
548
  stackName?: string;
549
549
  /**
550
- * @public
551
550
  * <p>The name of deployment artifacts. </p>
551
+ * @public
552
552
  */
553
553
  deploymentArtifacts?: string;
554
554
  }
555
555
  /**
556
- * @public
557
556
  * <p>Describes the backend environment for an Amplify app. </p>
557
+ * @public
558
558
  */
559
559
  export interface BackendEnvironment {
560
560
  /**
561
- * @public
562
561
  * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
563
562
  * app. </p>
563
+ * @public
564
564
  */
565
565
  backendEnvironmentArn: string | undefined;
566
566
  /**
567
- * @public
568
567
  * <p>The name for a backend environment that is part of an Amplify app. </p>
568
+ * @public
569
569
  */
570
570
  environmentName: string | undefined;
571
571
  /**
572
- * @public
573
572
  * <p>The AWS CloudFormation stack name of a backend environment. </p>
573
+ * @public
574
574
  */
575
575
  stackName?: string;
576
576
  /**
577
- * @public
578
577
  * <p>The name of deployment artifacts. </p>
578
+ * @public
579
579
  */
580
580
  deploymentArtifacts?: string;
581
581
  /**
582
- * @public
583
582
  * <p>The creation date and time for a backend environment that is part of an Amplify app.
584
583
  * </p>
584
+ * @public
585
585
  */
586
586
  createTime: Date | undefined;
587
587
  /**
588
- * @public
589
588
  * <p>The last updated date and time for a backend environment that is part of an Amplify
590
589
  * app. </p>
590
+ * @public
591
591
  */
592
592
  updateTime: Date | undefined;
593
593
  }
594
594
  /**
595
- * @public
596
595
  * <p>The result structure for the create backend environment request. </p>
596
+ * @public
597
597
  */
598
598
  export interface CreateBackendEnvironmentResult {
599
599
  /**
600
- * @public
601
600
  * <p>Describes the backend environment for an Amplify app. </p>
601
+ * @public
602
602
  */
603
603
  backendEnvironment: BackendEnvironment | undefined;
604
604
  }
605
605
  /**
606
- * @public
607
606
  * <p>An entity was not found during an operation. </p>
607
+ * @public
608
608
  */
609
609
  export declare class NotFoundException extends __BaseException {
610
610
  readonly name: "NotFoundException";
@@ -615,335 +615,335 @@ export declare class NotFoundException extends __BaseException {
615
615
  constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
616
616
  }
617
617
  /**
618
- * @public
619
618
  * <p>Describes the backend properties associated with an Amplify
620
619
  * <code>Branch</code>.</p>
620
+ * @public
621
621
  */
622
622
  export interface Backend {
623
623
  /**
624
- * @public
625
624
  * <p>The Amazon Resource Name (ARN) for the CloudFormation stack.</p>
625
+ * @public
626
626
  */
627
627
  stackArn?: string;
628
628
  }
629
629
  /**
630
- * @public
631
630
  * <p> The request structure for the create branch request. </p>
631
+ * @public
632
632
  */
633
633
  export interface CreateBranchRequest {
634
634
  /**
635
- * @public
636
635
  * <p> The unique ID for an Amplify app. </p>
636
+ * @public
637
637
  */
638
638
  appId: string | undefined;
639
639
  /**
640
- * @public
641
640
  * <p>The name for the branch. </p>
641
+ * @public
642
642
  */
643
643
  branchName: string | undefined;
644
644
  /**
645
- * @public
646
645
  * <p>The description for the branch. </p>
646
+ * @public
647
647
  */
648
648
  description?: string;
649
649
  /**
650
- * @public
651
650
  * <p>Describes the current stage for the branch. </p>
651
+ * @public
652
652
  */
653
653
  stage?: Stage;
654
654
  /**
655
- * @public
656
655
  * <p> The framework for the branch. </p>
656
+ * @public
657
657
  */
658
658
  framework?: string;
659
659
  /**
660
- * @public
661
660
  * <p> Enables notifications for the branch. </p>
661
+ * @public
662
662
  */
663
663
  enableNotification?: boolean;
664
664
  /**
665
- * @public
666
665
  * <p> Enables auto building for the branch. </p>
666
+ * @public
667
667
  */
668
668
  enableAutoBuild?: boolean;
669
669
  /**
670
- * @public
671
670
  * <p> The environment variables for the branch. </p>
671
+ * @public
672
672
  */
673
673
  environmentVariables?: Record<string, string>;
674
674
  /**
675
- * @public
676
675
  * <p> The basic authorization credentials for the branch. You must base64-encode the
677
676
  * authorization credentials and provide them in the format
678
677
  * <code>user:password</code>.</p>
678
+ * @public
679
679
  */
680
680
  basicAuthCredentials?: string;
681
681
  /**
682
- * @public
683
682
  * <p> Enables basic authorization for the branch. </p>
683
+ * @public
684
684
  */
685
685
  enableBasicAuth?: boolean;
686
686
  /**
687
- * @public
688
687
  * <p>Enables performance mode for the branch.</p>
689
688
  * <p>Performance mode optimizes for faster hosting performance by keeping content cached at
690
689
  * the edge for a longer interval. When performance mode is enabled, hosting configuration
691
690
  * or code changes can take up to 10 minutes to roll out. </p>
691
+ * @public
692
692
  */
693
693
  enablePerformanceMode?: boolean;
694
694
  /**
695
- * @public
696
695
  * <p> The tag for the branch. </p>
696
+ * @public
697
697
  */
698
698
  tags?: Record<string, string>;
699
699
  /**
700
- * @public
701
700
  * <p> The build specification (build spec) for the branch. </p>
701
+ * @public
702
702
  */
703
703
  buildSpec?: string;
704
704
  /**
705
- * @public
706
705
  * <p> The content Time To Live (TTL) for the website in seconds. </p>
706
+ * @public
707
707
  */
708
708
  ttl?: string;
709
709
  /**
710
- * @public
711
710
  * <p> The display name for a branch. This is used as the default domain prefix. </p>
711
+ * @public
712
712
  */
713
713
  displayName?: string;
714
714
  /**
715
- * @public
716
715
  * <p> Enables pull request previews for this branch. </p>
716
+ * @public
717
717
  */
718
718
  enablePullRequestPreview?: boolean;
719
719
  /**
720
- * @public
721
720
  * <p> The Amplify environment name for the pull request. </p>
721
+ * @public
722
722
  */
723
723
  pullRequestEnvironmentName?: string;
724
724
  /**
725
- * @public
726
725
  * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
727
726
  * app. </p>
727
+ * @public
728
728
  */
729
729
  backendEnvironmentArn?: string;
730
730
  /**
731
- * @public
732
731
  * <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
733
732
  * backend created from an CloudFormation stack.</p>
733
+ * @public
734
734
  */
735
735
  backend?: Backend;
736
736
  }
737
737
  /**
738
- * @public
739
738
  * <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
739
+ * @public
740
740
  */
741
741
  export interface Branch {
742
742
  /**
743
- * @public
744
743
  * <p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>
744
+ * @public
745
745
  */
746
746
  branchArn: string | undefined;
747
747
  /**
748
- * @public
749
748
  * <p> The name for the branch that is part of an Amplify app. </p>
749
+ * @public
750
750
  */
751
751
  branchName: string | undefined;
752
752
  /**
753
- * @public
754
753
  * <p> The description for the branch that is part of an Amplify app. </p>
754
+ * @public
755
755
  */
756
756
  description: string | undefined;
757
757
  /**
758
- * @public
759
758
  * <p> The tag for the branch of an Amplify app. </p>
759
+ * @public
760
760
  */
761
761
  tags?: Record<string, string>;
762
762
  /**
763
- * @public
764
763
  * <p> The current stage for the branch that is part of an Amplify app. </p>
764
+ * @public
765
765
  */
766
766
  stage: Stage | undefined;
767
767
  /**
768
- * @public
769
768
  * <p> The display name for the branch. This is used as the default domain prefix. </p>
769
+ * @public
770
770
  */
771
771
  displayName: string | undefined;
772
772
  /**
773
- * @public
774
773
  * <p> Enables notifications for a branch that is part of an Amplify app. </p>
774
+ * @public
775
775
  */
776
776
  enableNotification: boolean | undefined;
777
777
  /**
778
- * @public
779
778
  * <p> The creation date and time for a branch that is part of an Amplify app. </p>
779
+ * @public
780
780
  */
781
781
  createTime: Date | undefined;
782
782
  /**
783
- * @public
784
783
  * <p> The last updated date and time for a branch that is part of an Amplify app. </p>
784
+ * @public
785
785
  */
786
786
  updateTime: Date | undefined;
787
787
  /**
788
- * @public
789
788
  * <p> The environment variables specific to a branch of an Amplify app. </p>
789
+ * @public
790
790
  */
791
791
  environmentVariables: Record<string, string> | undefined;
792
792
  /**
793
- * @public
794
793
  * <p> Enables auto-building on push for a branch of an Amplify app. </p>
794
+ * @public
795
795
  */
796
796
  enableAutoBuild: boolean | undefined;
797
797
  /**
798
- * @public
799
798
  * <p> The custom domains for a branch of an Amplify app. </p>
799
+ * @public
800
800
  */
801
801
  customDomains: string[] | undefined;
802
802
  /**
803
- * @public
804
803
  * <p> The framework for a branch of an Amplify app. </p>
804
+ * @public
805
805
  */
806
806
  framework: string | undefined;
807
807
  /**
808
- * @public
809
808
  * <p> The ID of the active job for a branch of an Amplify app. </p>
809
+ * @public
810
810
  */
811
811
  activeJobId: string | undefined;
812
812
  /**
813
- * @public
814
813
  * <p> The total number of jobs that are part of an Amplify app. </p>
814
+ * @public
815
815
  */
816
816
  totalNumberOfJobs: string | undefined;
817
817
  /**
818
- * @public
819
818
  * <p> Enables basic authorization for a branch of an Amplify app. </p>
819
+ * @public
820
820
  */
821
821
  enableBasicAuth: boolean | undefined;
822
822
  /**
823
- * @public
824
823
  * <p>Enables performance mode for the branch.</p>
825
824
  * <p>Performance mode optimizes for faster hosting performance by keeping content cached at
826
825
  * the edge for a longer interval. When performance mode is enabled, hosting configuration
827
826
  * or code changes can take up to 10 minutes to roll out. </p>
827
+ * @public
828
828
  */
829
829
  enablePerformanceMode?: boolean;
830
830
  /**
831
- * @public
832
831
  * <p> The thumbnail URL for the branch of an Amplify app. </p>
832
+ * @public
833
833
  */
834
834
  thumbnailUrl?: string;
835
835
  /**
836
- * @public
837
836
  * <p> The basic authorization credentials for a branch of an Amplify app. You must
838
837
  * base64-encode the authorization credentials and provide them in the format
839
838
  * <code>user:password</code>.</p>
839
+ * @public
840
840
  */
841
841
  basicAuthCredentials?: string;
842
842
  /**
843
- * @public
844
843
  * <p> The build specification (build spec) content for the branch of an Amplify app.
845
844
  * </p>
845
+ * @public
846
846
  */
847
847
  buildSpec?: string;
848
848
  /**
849
- * @public
850
849
  * <p> The content Time to Live (TTL) for the website in seconds. </p>
850
+ * @public
851
851
  */
852
852
  ttl: string | undefined;
853
853
  /**
854
- * @public
855
854
  * <p> A list of custom resources that are linked to this branch. </p>
855
+ * @public
856
856
  */
857
857
  associatedResources?: string[];
858
858
  /**
859
- * @public
860
859
  * <p> Enables pull request previews for the branch. </p>
860
+ * @public
861
861
  */
862
862
  enablePullRequestPreview: boolean | undefined;
863
863
  /**
864
- * @public
865
864
  * <p> The Amplify environment name for the pull request. </p>
865
+ * @public
866
866
  */
867
867
  pullRequestEnvironmentName?: string;
868
868
  /**
869
- * @public
870
869
  * <p> The destination branch if the branch is a pull request branch. </p>
870
+ * @public
871
871
  */
872
872
  destinationBranch?: string;
873
873
  /**
874
- * @public
875
874
  * <p> The source branch if the branch is a pull request branch. </p>
875
+ * @public
876
876
  */
877
877
  sourceBranch?: string;
878
878
  /**
879
- * @public
880
879
  * <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
881
880
  * app. </p>
881
+ * @public
882
882
  */
883
883
  backendEnvironmentArn?: string;
884
884
  /**
885
- * @public
886
885
  * <p>Describes the backend properties associated with an Amplify
887
886
  * <code>Branch</code>.</p>
887
+ * @public
888
888
  */
889
889
  backend?: Backend;
890
890
  }
891
891
  /**
892
- * @public
893
892
  * <p> The result structure for create branch request. </p>
893
+ * @public
894
894
  */
895
895
  export interface CreateBranchResult {
896
896
  /**
897
- * @public
898
897
  * <p> Describes the branch for an Amplify app, which maps to a third-party repository
899
898
  * branch. </p>
899
+ * @public
900
900
  */
901
901
  branch: Branch | undefined;
902
902
  }
903
903
  /**
904
- * @public
905
904
  * <p> The request structure for the create a new deployment request. </p>
905
+ * @public
906
906
  */
907
907
  export interface CreateDeploymentRequest {
908
908
  /**
909
- * @public
910
909
  * <p> The unique ID for an Amplify app. </p>
910
+ * @public
911
911
  */
912
912
  appId: string | undefined;
913
913
  /**
914
- * @public
915
914
  * <p> The name of the branch to use for the job. </p>
915
+ * @public
916
916
  */
917
917
  branchName: string | undefined;
918
918
  /**
919
- * @public
920
919
  * <p> An optional file map that contains the file name as the key and the file content md5
921
920
  * hash as the value. If this argument is provided, the service will generate a unique
922
921
  * upload URL per file. Otherwise, the service will only generate a single upload URL for
923
922
  * the zipped files. </p>
923
+ * @public
924
924
  */
925
925
  fileMap?: Record<string, string>;
926
926
  }
927
927
  /**
928
- * @public
929
928
  * <p> The result structure for the create a new deployment request. </p>
929
+ * @public
930
930
  */
931
931
  export interface CreateDeploymentResult {
932
932
  /**
933
- * @public
934
933
  * <p> The job ID for this deployment. will supply to start deployment api. </p>
934
+ * @public
935
935
  */
936
936
  jobId?: string;
937
937
  /**
938
- * @public
939
938
  * <p> When the <code>fileMap</code> argument is provided in the request,
940
939
  * <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>
940
+ * @public
941
941
  */
942
942
  fileUploadUrls: Record<string, string> | undefined;
943
943
  /**
944
- * @public
945
944
  * <p> When the <code>fileMap</code> argument is not provided in the request, this
946
945
  * <code>zipUploadUrl</code> is returned. </p>
946
+ * @public
947
947
  */
948
948
  zipUploadUrl: string | undefined;
949
949
  }
@@ -960,14 +960,13 @@ export declare const CertificateType: {
960
960
  */
961
961
  export type CertificateType = (typeof CertificateType)[keyof typeof CertificateType];
962
962
  /**
963
- * @public
964
963
  * <p>The type of SSL/TLS certificate to use for your custom domain. If a certificate type
965
964
  * isn't specified, Amplify uses the default <code>AMPLIFY_MANAGED</code>
966
965
  * certificate.</p>
966
+ * @public
967
967
  */
968
968
  export interface CertificateSettings {
969
969
  /**
970
- * @public
971
970
  * <p>The certificate type.</p>
972
971
  * <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify
973
972
  * provisions for you.</p>
@@ -977,85 +976,85 @@ export interface CertificateSettings {
977
976
  * information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into
978
977
  * Certificate Manager</a> in the <i>ACM User
979
978
  * guide</i>.</p>
979
+ * @public
980
980
  */
981
981
  type: CertificateType | undefined;
982
982
  /**
983
- * @public
984
983
  * <p>The Amazon resource name (ARN) for the custom certificate that you have already added
985
984
  * to Certificate Manager in your Amazon Web Services account.</p>
986
985
  * <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>
986
+ * @public
987
987
  */
988
988
  customCertificateArn?: string;
989
989
  }
990
990
  /**
991
- * @public
992
991
  * <p> Describes the settings for the subdomain. </p>
992
+ * @public
993
993
  */
994
994
  export interface SubDomainSetting {
995
995
  /**
996
- * @public
997
996
  * <p> The prefix setting for the subdomain. </p>
997
+ * @public
998
998
  */
999
999
  prefix: string | undefined;
1000
1000
  /**
1001
- * @public
1002
1001
  * <p> The branch name setting for the subdomain. </p>
1002
+ * @public
1003
1003
  */
1004
1004
  branchName: string | undefined;
1005
1005
  }
1006
1006
  /**
1007
- * @public
1008
1007
  * <p> The request structure for the create domain association request. </p>
1008
+ * @public
1009
1009
  */
1010
1010
  export interface CreateDomainAssociationRequest {
1011
1011
  /**
1012
- * @public
1013
1012
  * <p> The unique ID for an Amplify app. </p>
1013
+ * @public
1014
1014
  */
1015
1015
  appId: string | undefined;
1016
1016
  /**
1017
- * @public
1018
1017
  * <p> The domain name for the domain association. </p>
1018
+ * @public
1019
1019
  */
1020
1020
  domainName: string | undefined;
1021
1021
  /**
1022
- * @public
1023
1022
  * <p> Enables the automated creation of subdomains for branches. </p>
1023
+ * @public
1024
1024
  */
1025
1025
  enableAutoSubDomain?: boolean;
1026
1026
  /**
1027
- * @public
1028
1027
  * <p> The setting for the subdomain. </p>
1028
+ * @public
1029
1029
  */
1030
1030
  subDomainSettings: SubDomainSetting[] | undefined;
1031
1031
  /**
1032
- * @public
1033
1032
  * <p> Sets the branch patterns for automatic subdomain creation. </p>
1033
+ * @public
1034
1034
  */
1035
1035
  autoSubDomainCreationPatterns?: string[];
1036
1036
  /**
1037
- * @public
1038
1037
  * <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
1039
1038
  * Resource Name (ARN) for automatically creating subdomains. </p>
1039
+ * @public
1040
1040
  */
1041
1041
  autoSubDomainIAMRole?: string;
1042
1042
  /**
1043
- * @public
1044
1043
  * <p>The type of SSL/TLS certificate to use for your custom domain. If you don't specify a
1045
1044
  * certificate type, Amplify uses the default certificate that it provisions and manages
1046
1045
  * for you.</p>
1046
+ * @public
1047
1047
  */
1048
1048
  certificateSettings?: CertificateSettings;
1049
1049
  }
1050
1050
  /**
1051
- * @public
1052
1051
  * <p>Describes the current SSL/TLS certificate that is in use for the domain. If you are
1053
1052
  * using <code>CreateDomainAssociation</code> to create a new domain association,
1054
1053
  * <code>Certificate</code> describes the new certificate that you are creating.</p>
1054
+ * @public
1055
1055
  */
1056
1056
  export interface Certificate {
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>The type of SSL/TLS certificate that you want to use.</p>
1060
1059
  * <p>Specify <code>AMPLIFY_MANAGED</code> to use the default certificate that Amplify
1061
1060
  * provisions for you.</p>
@@ -1065,18 +1064,19 @@ export interface Certificate {
1065
1064
  * information about using ACM, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html">Importing certificates into
1066
1065
  * Certificate Manager</a> in the <i>ACM User
1067
1066
  * guide</i> .</p>
1067
+ * @public
1068
1068
  */
1069
1069
  type: CertificateType | undefined;
1070
1070
  /**
1071
- * @public
1072
1071
  * <p>The Amazon resource name (ARN) for a custom certificate that you have already added to
1073
1072
  * Certificate Manager in your Amazon Web Services account. </p>
1074
1073
  * <p>This field is required only when the certificate type is <code>CUSTOM</code>.</p>
1074
+ * @public
1075
1075
  */
1076
1076
  customCertificateArn?: string;
1077
1077
  /**
1078
- * @public
1079
1078
  * <p>The DNS record for certificate verification.</p>
1079
+ * @public
1080
1080
  */
1081
1081
  certificateVerificationDNSRecord?: string;
1082
1082
  }
@@ -1101,23 +1101,23 @@ export declare const DomainStatus: {
1101
1101
  */
1102
1102
  export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
1103
1103
  /**
1104
- * @public
1105
1104
  * <p> The subdomain for the domain association. </p>
1105
+ * @public
1106
1106
  */
1107
1107
  export interface SubDomain {
1108
1108
  /**
1109
- * @public
1110
1109
  * <p> Describes the settings for the subdomain. </p>
1110
+ * @public
1111
1111
  */
1112
1112
  subDomainSetting: SubDomainSetting | undefined;
1113
1113
  /**
1114
- * @public
1115
1114
  * <p> The verified status of the subdomain </p>
1115
+ * @public
1116
1116
  */
1117
1117
  verified: boolean | undefined;
1118
1118
  /**
1119
- * @public
1120
1119
  * <p> The DNS record for the subdomain. </p>
1120
+ * @public
1121
1121
  */
1122
1122
  dnsRecord: string | undefined;
1123
1123
  }
@@ -1139,43 +1139,42 @@ export declare const UpdateStatus: {
1139
1139
  */
1140
1140
  export type UpdateStatus = (typeof UpdateStatus)[keyof typeof UpdateStatus];
1141
1141
  /**
1142
- * @public
1143
1142
  * <p>Describes the association between a custom domain and an Amplify app. </p>
1143
+ * @public
1144
1144
  */
1145
1145
  export interface DomainAssociation {
1146
1146
  /**
1147
- * @public
1148
1147
  * <p> The Amazon Resource Name (ARN) for the domain association. </p>
1148
+ * @public
1149
1149
  */
1150
1150
  domainAssociationArn: string | undefined;
1151
1151
  /**
1152
- * @public
1153
1152
  * <p> The name of the domain. </p>
1153
+ * @public
1154
1154
  */
1155
1155
  domainName: string | undefined;
1156
1156
  /**
1157
- * @public
1158
1157
  * <p> Enables the automated creation of subdomains for branches. </p>
1158
+ * @public
1159
1159
  */
1160
1160
  enableAutoSubDomain: boolean | undefined;
1161
1161
  /**
1162
- * @public
1163
1162
  * <p> Sets branch patterns for automatic subdomain creation. </p>
1163
+ * @public
1164
1164
  */
1165
1165
  autoSubDomainCreationPatterns?: string[];
1166
1166
  /**
1167
- * @public
1168
1167
  * <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
1169
1168
  * Resource Name (ARN) for automatically creating subdomains. </p>
1169
+ * @public
1170
1170
  */
1171
1171
  autoSubDomainIAMRole?: string;
1172
1172
  /**
1173
- * @public
1174
1173
  * <p> The current status of the domain association. </p>
1174
+ * @public
1175
1175
  */
1176
1176
  domainStatus: DomainStatus | undefined;
1177
1177
  /**
1178
- * @public
1179
1178
  * <p>The status of the domain update operation that is currently in progress. The following
1180
1179
  * list describes the valid update states.</p>
1181
1180
  * <dl>
@@ -1221,26 +1220,26 @@ export interface DomainAssociation {
1221
1220
  * no existing active certificate to roll back to.</p>
1222
1221
  * </dd>
1223
1222
  * </dl>
1223
+ * @public
1224
1224
  */
1225
1225
  updateStatus?: UpdateStatus;
1226
1226
  /**
1227
- * @public
1228
1227
  * <p> Additional information that describes why the domain association is in the current
1229
1228
  * state.</p>
1229
+ * @public
1230
1230
  */
1231
1231
  statusReason: string | undefined;
1232
1232
  /**
1233
- * @public
1234
1233
  * <p> The DNS record for certificate verification. </p>
1234
+ * @public
1235
1235
  */
1236
1236
  certificateVerificationDNSRecord?: string;
1237
1237
  /**
1238
- * @public
1239
1238
  * <p> The subdomains for the domain association. </p>
1239
+ * @public
1240
1240
  */
1241
1241
  subDomains: SubDomain[] | undefined;
1242
1242
  /**
1243
- * @public
1244
1243
  * <p>Describes the SSL/TLS certificate for the domain association. This can be your own
1245
1244
  * custom certificate or the default certificate that Amplify provisions for
1246
1245
  * you.</p>
@@ -1248,184 +1247,185 @@ export interface DomainAssociation {
1248
1247
  * <code>certificate</code> points to the new certificate that is being created instead
1249
1248
  * of the current active certificate. Otherwise, <code>certificate</code> points to the
1250
1249
  * current active certificate.</p>
1250
+ * @public
1251
1251
  */
1252
1252
  certificate?: Certificate;
1253
1253
  }
1254
1254
  /**
1255
- * @public
1256
1255
  * <p> The result structure for the create domain association request. </p>
1256
+ * @public
1257
1257
  */
1258
1258
  export interface CreateDomainAssociationResult {
1259
1259
  /**
1260
- * @public
1261
1260
  * <p> Describes the structure of a domain association, which associates a custom domain
1262
1261
  * with an Amplify app. </p>
1262
+ * @public
1263
1263
  */
1264
1264
  domainAssociation: DomainAssociation | undefined;
1265
1265
  }
1266
1266
  /**
1267
- * @public
1268
1267
  * <p>The request structure for the create webhook request. </p>
1268
+ * @public
1269
1269
  */
1270
1270
  export interface CreateWebhookRequest {
1271
1271
  /**
1272
- * @public
1273
1272
  * <p>The unique ID for an Amplify app. </p>
1273
+ * @public
1274
1274
  */
1275
1275
  appId: string | undefined;
1276
1276
  /**
1277
- * @public
1278
1277
  * <p>The name for a branch that is part of an Amplify app. </p>
1278
+ * @public
1279
1279
  */
1280
1280
  branchName: string | undefined;
1281
1281
  /**
1282
- * @public
1283
1282
  * <p>The description for a webhook. </p>
1283
+ * @public
1284
1284
  */
1285
1285
  description?: string;
1286
1286
  }
1287
1287
  /**
1288
- * @public
1289
1288
  * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1289
+ * @public
1290
1290
  */
1291
1291
  export interface Webhook {
1292
1292
  /**
1293
- * @public
1294
1293
  * <p>The Amazon Resource Name (ARN) for the webhook. </p>
1294
+ * @public
1295
1295
  */
1296
1296
  webhookArn: string | undefined;
1297
1297
  /**
1298
- * @public
1299
1298
  * <p>The ID of the webhook. </p>
1299
+ * @public
1300
1300
  */
1301
1301
  webhookId: string | undefined;
1302
1302
  /**
1303
- * @public
1304
1303
  * <p>The URL of the webhook. </p>
1304
+ * @public
1305
1305
  */
1306
1306
  webhookUrl: string | undefined;
1307
1307
  /**
1308
- * @public
1309
1308
  * <p>The name for a branch that is part of an Amplify app. </p>
1309
+ * @public
1310
1310
  */
1311
1311
  branchName: string | undefined;
1312
1312
  /**
1313
- * @public
1314
1313
  * <p>The description for a webhook. </p>
1314
+ * @public
1315
1315
  */
1316
1316
  description: string | undefined;
1317
1317
  /**
1318
- * @public
1319
1318
  * <p>The create date and time for a webhook. </p>
1319
+ * @public
1320
1320
  */
1321
1321
  createTime: Date | undefined;
1322
1322
  /**
1323
- * @public
1324
1323
  * <p>Updates the date and time for a webhook. </p>
1324
+ * @public
1325
1325
  */
1326
1326
  updateTime: Date | undefined;
1327
1327
  }
1328
1328
  /**
1329
- * @public
1330
1329
  * <p>The result structure for the create webhook request. </p>
1330
+ * @public
1331
1331
  */
1332
1332
  export interface CreateWebhookResult {
1333
1333
  /**
1334
- * @public
1335
1334
  * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1335
+ * @public
1336
1336
  */
1337
1337
  webhook: Webhook | undefined;
1338
1338
  }
1339
1339
  /**
1340
- * @public
1341
1340
  * <p>Describes the request structure for the delete app request. </p>
1341
+ * @public
1342
1342
  */
1343
1343
  export interface DeleteAppRequest {
1344
1344
  /**
1345
- * @public
1346
1345
  * <p>The unique ID for an Amplify app. </p>
1346
+ * @public
1347
1347
  */
1348
1348
  appId: string | undefined;
1349
1349
  }
1350
1350
  /**
1351
- * @public
1352
1351
  * <p>The result structure for the delete app request. </p>
1352
+ * @public
1353
1353
  */
1354
1354
  export interface DeleteAppResult {
1355
1355
  /**
1356
- * @public
1357
1356
  * <p>Represents the different branches of a repository for building, deploying, and hosting
1358
1357
  * an Amplify app. </p>
1358
+ * @public
1359
1359
  */
1360
1360
  app: App | undefined;
1361
1361
  }
1362
1362
  /**
1363
- * @public
1364
1363
  * <p>The request structure for the delete backend environment request. </p>
1364
+ * @public
1365
1365
  */
1366
1366
  export interface DeleteBackendEnvironmentRequest {
1367
1367
  /**
1368
- * @public
1369
1368
  * <p>The unique ID of an Amplify app. </p>
1369
+ * @public
1370
1370
  */
1371
1371
  appId: string | undefined;
1372
1372
  /**
1373
- * @public
1374
1373
  * <p>The name of a backend environment of an Amplify app. </p>
1374
+ * @public
1375
1375
  */
1376
1376
  environmentName: string | undefined;
1377
1377
  }
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>The result structure of the delete backend environment result. </p>
1380
+ * @public
1381
1381
  */
1382
1382
  export interface DeleteBackendEnvironmentResult {
1383
1383
  /**
1384
- * @public
1385
1384
  * <p>Describes the backend environment for an Amplify app. </p>
1385
+ * @public
1386
1386
  */
1387
1387
  backendEnvironment: BackendEnvironment | undefined;
1388
1388
  }
1389
1389
  /**
1390
- * @public
1391
1390
  * <p> The request structure for the delete branch request. </p>
1391
+ * @public
1392
1392
  */
1393
1393
  export interface DeleteBranchRequest {
1394
1394
  /**
1395
- * @public
1396
1395
  * <p> The unique ID for an Amplify app. </p>
1396
+ * @public
1397
1397
  */
1398
1398
  appId: string | undefined;
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>The name of the branch. </p>
1401
+ * @public
1402
1402
  */
1403
1403
  branchName: string | undefined;
1404
1404
  }
1405
1405
  /**
1406
- * @public
1407
1406
  * <p>The result structure for the delete branch request. </p>
1407
+ * @public
1408
1408
  */
1409
1409
  export interface DeleteBranchResult {
1410
1410
  /**
1411
- * @public
1412
1411
  * <p>The branch for an Amplify app, which maps to a third-party repository branch. </p>
1412
+ * @public
1413
1413
  */
1414
1414
  branch: Branch | undefined;
1415
1415
  }
1416
1416
  /**
1417
- * @public
1418
1417
  * <p> The request structure for the delete domain association request. </p>
1418
+ * @public
1419
1419
  */
1420
1420
  export interface DeleteDomainAssociationRequest {
1421
1421
  /**
1422
- * @public
1423
1422
  * <p> The unique id for an Amplify app. </p>
1423
+ * @public
1424
1424
  */
1425
1425
  appId: string | undefined;
1426
1426
  /**
1427
- * @public
1428
1427
  * <p> The name of the domain. </p>
1428
+ * @public
1429
1429
  */
1430
1430
  domainName: string | undefined;
1431
1431
  }
@@ -1434,29 +1434,29 @@ export interface DeleteDomainAssociationRequest {
1434
1434
  */
1435
1435
  export interface DeleteDomainAssociationResult {
1436
1436
  /**
1437
- * @public
1438
1437
  * <p>Describes the association between a custom domain and an Amplify app. </p>
1438
+ * @public
1439
1439
  */
1440
1440
  domainAssociation: DomainAssociation | undefined;
1441
1441
  }
1442
1442
  /**
1443
- * @public
1444
1443
  * <p> The request structure for the delete job request. </p>
1444
+ * @public
1445
1445
  */
1446
1446
  export interface DeleteJobRequest {
1447
1447
  /**
1448
- * @public
1449
1448
  * <p> The unique ID for an Amplify app. </p>
1449
+ * @public
1450
1450
  */
1451
1451
  appId: string | undefined;
1452
1452
  /**
1453
- * @public
1454
1453
  * <p>The name of the branch to use for the job. </p>
1454
+ * @public
1455
1455
  */
1456
1456
  branchName: string | undefined;
1457
1457
  /**
1458
- * @public
1459
1458
  * <p> The unique ID for the job. </p>
1459
+ * @public
1460
1460
  */
1461
1461
  jobId: string | undefined;
1462
1462
  }
@@ -1492,140 +1492,140 @@ export declare const JobStatus: {
1492
1492
  */
1493
1493
  export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
1494
1494
  /**
1495
- * @public
1496
1495
  * <p> Describes the summary for an execution job for an Amplify app. </p>
1496
+ * @public
1497
1497
  */
1498
1498
  export interface JobSummary {
1499
1499
  /**
1500
- * @public
1501
1500
  * <p> The Amazon Resource Name (ARN) for the job. </p>
1501
+ * @public
1502
1502
  */
1503
1503
  jobArn: string | undefined;
1504
1504
  /**
1505
- * @public
1506
1505
  * <p> The unique ID for the job. </p>
1506
+ * @public
1507
1507
  */
1508
1508
  jobId: string | undefined;
1509
1509
  /**
1510
- * @public
1511
1510
  * <p> The commit ID from a third-party repository provider for the job. </p>
1511
+ * @public
1512
1512
  */
1513
1513
  commitId: string | undefined;
1514
1514
  /**
1515
- * @public
1516
1515
  * <p> The commit message from a third-party repository provider for the job. </p>
1516
+ * @public
1517
1517
  */
1518
1518
  commitMessage: string | undefined;
1519
1519
  /**
1520
- * @public
1521
1520
  * <p> The commit date and time for the job. </p>
1521
+ * @public
1522
1522
  */
1523
1523
  commitTime: Date | undefined;
1524
1524
  /**
1525
- * @public
1526
1525
  * <p> The start date and time for the job. </p>
1526
+ * @public
1527
1527
  */
1528
1528
  startTime: Date | undefined;
1529
1529
  /**
1530
- * @public
1531
1530
  * <p> The current status for the job. </p>
1531
+ * @public
1532
1532
  */
1533
1533
  status: JobStatus | undefined;
1534
1534
  /**
1535
- * @public
1536
1535
  * <p> The end date and time for the job. </p>
1536
+ * @public
1537
1537
  */
1538
1538
  endTime?: Date;
1539
1539
  /**
1540
- * @public
1541
1540
  * <p> The type for the job. If the value is <code>RELEASE</code>, the job was manually
1542
1541
  * released from its source by using the <code>StartJob</code> API. If the value is
1543
1542
  * <code>RETRY</code>, the job was manually retried using the <code>StartJob</code>
1544
1543
  * API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by
1545
1544
  * webhooks. </p>
1545
+ * @public
1546
1546
  */
1547
1547
  jobType: JobType | undefined;
1548
1548
  }
1549
1549
  /**
1550
- * @public
1551
1550
  * <p> The result structure for the delete job request. </p>
1551
+ * @public
1552
1552
  */
1553
1553
  export interface DeleteJobResult {
1554
1554
  /**
1555
- * @public
1556
1555
  * <p> Describes the summary for an execution job for an Amplify app. </p>
1556
+ * @public
1557
1557
  */
1558
1558
  jobSummary: JobSummary | undefined;
1559
1559
  }
1560
1560
  /**
1561
- * @public
1562
1561
  * <p>The request structure for the delete webhook request. </p>
1562
+ * @public
1563
1563
  */
1564
1564
  export interface DeleteWebhookRequest {
1565
1565
  /**
1566
- * @public
1567
1566
  * <p>The unique ID for a webhook. </p>
1567
+ * @public
1568
1568
  */
1569
1569
  webhookId: string | undefined;
1570
1570
  }
1571
1571
  /**
1572
- * @public
1573
1572
  * <p>The result structure for the delete webhook request. </p>
1573
+ * @public
1574
1574
  */
1575
1575
  export interface DeleteWebhookResult {
1576
1576
  /**
1577
- * @public
1578
1577
  * <p>Describes a webhook that connects repository events to an Amplify app. </p>
1578
+ * @public
1579
1579
  */
1580
1580
  webhook: Webhook | undefined;
1581
1581
  }
1582
1582
  /**
1583
- * @public
1584
1583
  * <p>The request structure for the generate access logs request. </p>
1584
+ * @public
1585
1585
  */
1586
1586
  export interface GenerateAccessLogsRequest {
1587
1587
  /**
1588
- * @public
1589
1588
  * <p>The time at which the logs should start. The time range specified is inclusive of the
1590
1589
  * start time. </p>
1590
+ * @public
1591
1591
  */
1592
1592
  startTime?: Date;
1593
1593
  /**
1594
- * @public
1595
1594
  * <p>The time at which the logs should end. The time range specified is inclusive of the
1596
1595
  * end time. </p>
1596
+ * @public
1597
1597
  */
1598
1598
  endTime?: Date;
1599
1599
  /**
1600
- * @public
1601
1600
  * <p>The name of the domain. </p>
1601
+ * @public
1602
1602
  */
1603
1603
  domainName: string | undefined;
1604
1604
  /**
1605
- * @public
1606
1605
  * <p>The unique ID for an Amplify app. </p>
1606
+ * @public
1607
1607
  */
1608
1608
  appId: string | undefined;
1609
1609
  }
1610
1610
  /**
1611
- * @public
1612
1611
  * <p>The result structure for the generate access logs request. </p>
1612
+ * @public
1613
1613
  */
1614
1614
  export interface GenerateAccessLogsResult {
1615
1615
  /**
1616
- * @public
1617
1616
  * <p>The pre-signed URL for the requested access logs. </p>
1617
+ * @public
1618
1618
  */
1619
1619
  logUrl?: string;
1620
1620
  }
1621
1621
  /**
1622
- * @public
1623
1622
  * <p>The request structure for the get app request. </p>
1623
+ * @public
1624
1624
  */
1625
1625
  export interface GetAppRequest {
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>The unique ID for an Amplify app. </p>
1628
+ * @public
1629
1629
  */
1630
1630
  appId: string | undefined;
1631
1631
  }
@@ -1634,79 +1634,79 @@ export interface GetAppRequest {
1634
1634
  */
1635
1635
  export interface GetAppResult {
1636
1636
  /**
1637
- * @public
1638
1637
  * <p>Represents the different branches of a repository for building, deploying, and hosting
1639
1638
  * an Amplify app. </p>
1639
+ * @public
1640
1640
  */
1641
1641
  app: App | undefined;
1642
1642
  }
1643
1643
  /**
1644
- * @public
1645
1644
  * <p>Returns the request structure for the get artifact request. </p>
1645
+ * @public
1646
1646
  */
1647
1647
  export interface GetArtifactUrlRequest {
1648
1648
  /**
1649
- * @public
1650
1649
  * <p>The unique ID for an artifact. </p>
1650
+ * @public
1651
1651
  */
1652
1652
  artifactId: string | undefined;
1653
1653
  }
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>Returns the result structure for the get artifact request. </p>
1656
+ * @public
1657
1657
  */
1658
1658
  export interface GetArtifactUrlResult {
1659
1659
  /**
1660
- * @public
1661
1660
  * <p>The unique ID for an artifact. </p>
1661
+ * @public
1662
1662
  */
1663
1663
  artifactId: string | undefined;
1664
1664
  /**
1665
- * @public
1666
1665
  * <p>The presigned URL for the artifact. </p>
1666
+ * @public
1667
1667
  */
1668
1668
  artifactUrl: string | undefined;
1669
1669
  }
1670
1670
  /**
1671
- * @public
1672
1671
  * <p>The request structure for the get backend environment request. </p>
1672
+ * @public
1673
1673
  */
1674
1674
  export interface GetBackendEnvironmentRequest {
1675
1675
  /**
1676
- * @public
1677
1676
  * <p>The unique id for an Amplify app. </p>
1677
+ * @public
1678
1678
  */
1679
1679
  appId: string | undefined;
1680
1680
  /**
1681
- * @public
1682
1681
  * <p>The name for the backend environment. </p>
1682
+ * @public
1683
1683
  */
1684
1684
  environmentName: string | undefined;
1685
1685
  }
1686
1686
  /**
1687
- * @public
1688
1687
  * <p>The result structure for the get backend environment result. </p>
1688
+ * @public
1689
1689
  */
1690
1690
  export interface GetBackendEnvironmentResult {
1691
1691
  /**
1692
- * @public
1693
1692
  * <p>Describes the backend environment for an Amplify app. </p>
1693
+ * @public
1694
1694
  */
1695
1695
  backendEnvironment: BackendEnvironment | undefined;
1696
1696
  }
1697
1697
  /**
1698
- * @public
1699
1698
  * <p> The request structure for the get branch request. </p>
1699
+ * @public
1700
1700
  */
1701
1701
  export interface GetBranchRequest {
1702
1702
  /**
1703
- * @public
1704
1703
  * <p> The unique ID for an Amplify app. </p>
1704
+ * @public
1705
1705
  */
1706
1706
  appId: string | undefined;
1707
1707
  /**
1708
- * @public
1709
1708
  * <p>The name of the branch. </p>
1709
+ * @public
1710
1710
  */
1711
1711
  branchName: string | undefined;
1712
1712
  }
@@ -1715,135 +1715,135 @@ export interface GetBranchRequest {
1715
1715
  */
1716
1716
  export interface GetBranchResult {
1717
1717
  /**
1718
- * @public
1719
1718
  * <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
1719
+ * @public
1720
1720
  */
1721
1721
  branch: Branch | undefined;
1722
1722
  }
1723
1723
  /**
1724
- * @public
1725
1724
  * <p> The request structure for the get domain association request. </p>
1725
+ * @public
1726
1726
  */
1727
1727
  export interface GetDomainAssociationRequest {
1728
1728
  /**
1729
- * @public
1730
1729
  * <p> The unique id for an Amplify app. </p>
1730
+ * @public
1731
1731
  */
1732
1732
  appId: string | undefined;
1733
1733
  /**
1734
- * @public
1735
1734
  * <p> The name of the domain. </p>
1735
+ * @public
1736
1736
  */
1737
1737
  domainName: string | undefined;
1738
1738
  }
1739
1739
  /**
1740
- * @public
1741
1740
  * <p> The result structure for the get domain association request. </p>
1741
+ * @public
1742
1742
  */
1743
1743
  export interface GetDomainAssociationResult {
1744
1744
  /**
1745
- * @public
1746
1745
  * <p> Describes the structure of a domain association, which associates a custom domain
1747
1746
  * with an Amplify app. </p>
1747
+ * @public
1748
1748
  */
1749
1749
  domainAssociation: DomainAssociation | undefined;
1750
1750
  }
1751
1751
  /**
1752
- * @public
1753
1752
  * <p>The request structure for the get job request. </p>
1753
+ * @public
1754
1754
  */
1755
1755
  export interface GetJobRequest {
1756
1756
  /**
1757
- * @public
1758
1757
  * <p>The unique ID for an Amplify app. </p>
1758
+ * @public
1759
1759
  */
1760
1760
  appId: string | undefined;
1761
1761
  /**
1762
- * @public
1763
1762
  * <p>The name of the branch to use for the job. </p>
1763
+ * @public
1764
1764
  */
1765
1765
  branchName: string | undefined;
1766
1766
  /**
1767
- * @public
1768
1767
  * <p>The unique ID for the job. </p>
1768
+ * @public
1769
1769
  */
1770
1770
  jobId: string | undefined;
1771
1771
  }
1772
1772
  /**
1773
- * @public
1774
1773
  * <p> Describes an execution step, for an execution job, for an Amplify app. </p>
1774
+ * @public
1775
1775
  */
1776
1776
  export interface Step {
1777
1777
  /**
1778
- * @public
1779
1778
  * <p> The name of the execution step. </p>
1779
+ * @public
1780
1780
  */
1781
1781
  stepName: string | undefined;
1782
1782
  /**
1783
- * @public
1784
1783
  * <p> The start date and time of the execution step. </p>
1784
+ * @public
1785
1785
  */
1786
1786
  startTime: Date | undefined;
1787
1787
  /**
1788
- * @public
1789
1788
  * <p> The status of the execution step. </p>
1789
+ * @public
1790
1790
  */
1791
1791
  status: JobStatus | undefined;
1792
1792
  /**
1793
- * @public
1794
1793
  * <p> The end date and time of the execution step. </p>
1794
+ * @public
1795
1795
  */
1796
1796
  endTime: Date | undefined;
1797
1797
  /**
1798
- * @public
1799
1798
  * <p> The URL to the logs for the execution step. </p>
1799
+ * @public
1800
1800
  */
1801
1801
  logUrl?: string;
1802
1802
  /**
1803
- * @public
1804
1803
  * <p> The URL to the artifact for the execution step. </p>
1804
+ * @public
1805
1805
  */
1806
1806
  artifactsUrl?: string;
1807
1807
  /**
1808
- * @public
1809
1808
  * <p> The URL to the test artifact for the execution step. </p>
1809
+ * @public
1810
1810
  */
1811
1811
  testArtifactsUrl?: string;
1812
1812
  /**
1813
- * @public
1814
1813
  * <p> The URL to the test configuration for the execution step. </p>
1814
+ * @public
1815
1815
  */
1816
1816
  testConfigUrl?: string;
1817
1817
  /**
1818
- * @public
1819
1818
  * <p> The list of screenshot URLs for the execution step, if relevant. </p>
1819
+ * @public
1820
1820
  */
1821
1821
  screenshots?: Record<string, string>;
1822
1822
  /**
1823
- * @public
1824
1823
  * <p> The reason for the current step status. </p>
1824
+ * @public
1825
1825
  */
1826
1826
  statusReason?: string;
1827
1827
  /**
1828
- * @public
1829
1828
  * <p> The context for the current step. Includes a build image if the step is build.
1830
1829
  * </p>
1830
+ * @public
1831
1831
  */
1832
1832
  context?: string;
1833
1833
  }
1834
1834
  /**
1835
- * @public
1836
1835
  * <p> Describes an execution job for an Amplify app. </p>
1836
+ * @public
1837
1837
  */
1838
1838
  export interface Job {
1839
1839
  /**
1840
- * @public
1841
1840
  * <p> Describes the summary for an execution job for an Amplify app. </p>
1841
+ * @public
1842
1842
  */
1843
1843
  summary: JobSummary | undefined;
1844
1844
  /**
1845
- * @public
1846
1845
  * <p> The execution steps for an execution job, for an Amplify app. </p>
1846
+ * @public
1847
1847
  */
1848
1848
  steps: Step[] | undefined;
1849
1849
  }
@@ -1852,329 +1852,329 @@ export interface Job {
1852
1852
  */
1853
1853
  export interface GetJobResult {
1854
1854
  /**
1855
- * @public
1856
1855
  * <p> Describes an execution job for an Amplify app. </p>
1856
+ * @public
1857
1857
  */
1858
1858
  job: Job | undefined;
1859
1859
  }
1860
1860
  /**
1861
- * @public
1862
1861
  * <p>The request structure for the get webhook request. </p>
1862
+ * @public
1863
1863
  */
1864
1864
  export interface GetWebhookRequest {
1865
1865
  /**
1866
- * @public
1867
1866
  * <p>The unique ID for a webhook. </p>
1867
+ * @public
1868
1868
  */
1869
1869
  webhookId: string | undefined;
1870
1870
  }
1871
1871
  /**
1872
- * @public
1873
1872
  * <p>The result structure for the get webhook request. </p>
1873
+ * @public
1874
1874
  */
1875
1875
  export interface GetWebhookResult {
1876
1876
  /**
1877
- * @public
1878
1877
  * <p>Describes the structure of a webhook. </p>
1878
+ * @public
1879
1879
  */
1880
1880
  webhook: Webhook | undefined;
1881
1881
  }
1882
1882
  /**
1883
- * @public
1884
1883
  * <p>The request structure for the list apps request. </p>
1884
+ * @public
1885
1885
  */
1886
1886
  export interface ListAppsRequest {
1887
1887
  /**
1888
- * @public
1889
1888
  * <p>A pagination token. If non-null, the pagination token is returned in a result. Pass
1890
1889
  * its value in another request to retrieve more entries. </p>
1890
+ * @public
1891
1891
  */
1892
1892
  nextToken?: string;
1893
1893
  /**
1894
- * @public
1895
1894
  * <p>The maximum number of records to list in a single response. </p>
1895
+ * @public
1896
1896
  */
1897
1897
  maxResults?: number;
1898
1898
  }
1899
1899
  /**
1900
- * @public
1901
1900
  * <p>The result structure for an Amplify app list request. </p>
1901
+ * @public
1902
1902
  */
1903
1903
  export interface ListAppsResult {
1904
1904
  /**
1905
- * @public
1906
1905
  * <p>A list of Amplify apps. </p>
1906
+ * @public
1907
1907
  */
1908
1908
  apps: App[] | undefined;
1909
1909
  /**
1910
- * @public
1911
1910
  * <p>A pagination token. Set to null to start listing apps from start. If non-null, the
1912
1911
  * pagination token is returned in a result. Pass its value in here to list more projects.
1913
1912
  * </p>
1913
+ * @public
1914
1914
  */
1915
1915
  nextToken?: string;
1916
1916
  }
1917
1917
  /**
1918
- * @public
1919
1918
  * <p>Describes the request structure for the list artifacts request. </p>
1919
+ * @public
1920
1920
  */
1921
1921
  export interface ListArtifactsRequest {
1922
1922
  /**
1923
- * @public
1924
1923
  * <p>The unique ID for an Amplify app. </p>
1924
+ * @public
1925
1925
  */
1926
1926
  appId: string | undefined;
1927
1927
  /**
1928
- * @public
1929
1928
  * <p>The name of a branch that is part of an Amplify app. </p>
1929
+ * @public
1930
1930
  */
1931
1931
  branchName: string | undefined;
1932
1932
  /**
1933
- * @public
1934
1933
  * <p>The unique ID for a job. </p>
1934
+ * @public
1935
1935
  */
1936
1936
  jobId: string | undefined;
1937
1937
  /**
1938
- * @public
1939
1938
  * <p>A pagination token. Set to null to start listing artifacts from start. If a non-null
1940
1939
  * pagination token is returned in a result, pass its value in here to list more artifacts.
1941
1940
  * </p>
1941
+ * @public
1942
1942
  */
1943
1943
  nextToken?: string;
1944
1944
  /**
1945
- * @public
1946
1945
  * <p>The maximum number of records to list in a single response. </p>
1946
+ * @public
1947
1947
  */
1948
1948
  maxResults?: number;
1949
1949
  }
1950
1950
  /**
1951
- * @public
1952
1951
  * <p>Describes an artifact. </p>
1952
+ * @public
1953
1953
  */
1954
1954
  export interface Artifact {
1955
1955
  /**
1956
- * @public
1957
1956
  * <p>The file name for the artifact. </p>
1957
+ * @public
1958
1958
  */
1959
1959
  artifactFileName: string | undefined;
1960
1960
  /**
1961
- * @public
1962
1961
  * <p>The unique ID for the artifact. </p>
1962
+ * @public
1963
1963
  */
1964
1964
  artifactId: string | undefined;
1965
1965
  }
1966
1966
  /**
1967
- * @public
1968
1967
  * <p>The result structure for the list artifacts request. </p>
1968
+ * @public
1969
1969
  */
1970
1970
  export interface ListArtifactsResult {
1971
1971
  /**
1972
- * @public
1973
1972
  * <p>A list of artifacts. </p>
1973
+ * @public
1974
1974
  */
1975
1975
  artifacts: Artifact[] | undefined;
1976
1976
  /**
1977
- * @public
1978
1977
  * <p>A pagination token. If a non-null pagination token is returned in a result, pass its
1979
1978
  * value in another request to retrieve more entries. </p>
1979
+ * @public
1980
1980
  */
1981
1981
  nextToken?: string;
1982
1982
  }
1983
1983
  /**
1984
- * @public
1985
1984
  * <p>The request structure for the list backend environments request. </p>
1985
+ * @public
1986
1986
  */
1987
1987
  export interface ListBackendEnvironmentsRequest {
1988
1988
  /**
1989
- * @public
1990
1989
  * <p>The unique ID for an Amplify app. </p>
1990
+ * @public
1991
1991
  */
1992
1992
  appId: string | undefined;
1993
1993
  /**
1994
- * @public
1995
1994
  * <p>The name of the backend environment </p>
1995
+ * @public
1996
1996
  */
1997
1997
  environmentName?: string;
1998
1998
  /**
1999
- * @public
2000
1999
  * <p>A pagination token. Set to null to start listing backend environments from the start.
2001
2000
  * If a non-null pagination token is returned in a result, pass its value in here to list
2002
2001
  * more backend environments. </p>
2002
+ * @public
2003
2003
  */
2004
2004
  nextToken?: string;
2005
2005
  /**
2006
- * @public
2007
2006
  * <p>The maximum number of records to list in a single response. </p>
2007
+ * @public
2008
2008
  */
2009
2009
  maxResults?: number;
2010
2010
  }
2011
2011
  /**
2012
- * @public
2013
2012
  * <p>The result structure for the list backend environments result. </p>
2013
+ * @public
2014
2014
  */
2015
2015
  export interface ListBackendEnvironmentsResult {
2016
2016
  /**
2017
- * @public
2018
2017
  * <p>The list of backend environments for an Amplify app. </p>
2018
+ * @public
2019
2019
  */
2020
2020
  backendEnvironments: BackendEnvironment[] | undefined;
2021
2021
  /**
2022
- * @public
2023
2022
  * <p>A pagination token. If a non-null pagination token is returned in a result, pass its
2024
2023
  * value in another request to retrieve more entries. </p>
2024
+ * @public
2025
2025
  */
2026
2026
  nextToken?: string;
2027
2027
  }
2028
2028
  /**
2029
- * @public
2030
2029
  * <p>The request structure for the list branches request. </p>
2030
+ * @public
2031
2031
  */
2032
2032
  export interface ListBranchesRequest {
2033
2033
  /**
2034
- * @public
2035
2034
  * <p>The unique ID for an Amplify app. </p>
2035
+ * @public
2036
2036
  */
2037
2037
  appId: string | undefined;
2038
2038
  /**
2039
- * @public
2040
2039
  * <p>A pagination token. Set to null to start listing branches from the start. If a
2041
2040
  * non-null pagination token is returned in a result, pass its value in here to list more
2042
2041
  * branches. </p>
2042
+ * @public
2043
2043
  */
2044
2044
  nextToken?: string;
2045
2045
  /**
2046
- * @public
2047
2046
  * <p> The maximum number of records to list in a single response. </p>
2047
+ * @public
2048
2048
  */
2049
2049
  maxResults?: number;
2050
2050
  }
2051
2051
  /**
2052
- * @public
2053
2052
  * <p> The result structure for the list branches request. </p>
2053
+ * @public
2054
2054
  */
2055
2055
  export interface ListBranchesResult {
2056
2056
  /**
2057
- * @public
2058
2057
  * <p> A list of branches for an Amplify app. </p>
2058
+ * @public
2059
2059
  */
2060
2060
  branches: Branch[] | undefined;
2061
2061
  /**
2062
- * @public
2063
2062
  * <p> A pagination token. If a non-null pagination token is returned in a result, pass its
2064
2063
  * value in another request to retrieve more entries. </p>
2064
+ * @public
2065
2065
  */
2066
2066
  nextToken?: string;
2067
2067
  }
2068
2068
  /**
2069
- * @public
2070
2069
  * <p> The request structure for the list domain associations request. </p>
2070
+ * @public
2071
2071
  */
2072
2072
  export interface ListDomainAssociationsRequest {
2073
2073
  /**
2074
- * @public
2075
2074
  * <p> The unique ID for an Amplify app. </p>
2075
+ * @public
2076
2076
  */
2077
2077
  appId: string | undefined;
2078
2078
  /**
2079
- * @public
2080
2079
  * <p> A pagination token. Set to null to start listing apps from the start. If non-null, a
2081
2080
  * pagination token is returned in a result. Pass its value in here to list more projects.
2082
2081
  * </p>
2082
+ * @public
2083
2083
  */
2084
2084
  nextToken?: string;
2085
2085
  /**
2086
- * @public
2087
2086
  * <p> The maximum number of records to list in a single response. </p>
2087
+ * @public
2088
2088
  */
2089
2089
  maxResults?: number;
2090
2090
  }
2091
2091
  /**
2092
- * @public
2093
2092
  * <p> The result structure for the list domain association request. </p>
2093
+ * @public
2094
2094
  */
2095
2095
  export interface ListDomainAssociationsResult {
2096
2096
  /**
2097
- * @public
2098
2097
  * <p> A list of domain associations. </p>
2098
+ * @public
2099
2099
  */
2100
2100
  domainAssociations: DomainAssociation[] | undefined;
2101
2101
  /**
2102
- * @public
2103
2102
  * <p> A pagination token. If non-null, a pagination token is returned in a result. Pass its
2104
2103
  * value in another request to retrieve more entries. </p>
2104
+ * @public
2105
2105
  */
2106
2106
  nextToken?: string;
2107
2107
  }
2108
2108
  /**
2109
- * @public
2110
2109
  * <p> The request structure for the list jobs request. </p>
2110
+ * @public
2111
2111
  */
2112
2112
  export interface ListJobsRequest {
2113
2113
  /**
2114
- * @public
2115
2114
  * <p> The unique ID for an Amplify app. </p>
2115
+ * @public
2116
2116
  */
2117
2117
  appId: string | undefined;
2118
2118
  /**
2119
- * @public
2120
2119
  * <p>The name of the branch to use for the request. </p>
2120
+ * @public
2121
2121
  */
2122
2122
  branchName: string | undefined;
2123
2123
  /**
2124
- * @public
2125
2124
  * <p>A pagination token. Set to null to start listing steps from the start. If a non-null
2126
2125
  * pagination token is returned in a result, pass its value in here to list more steps.
2127
2126
  * </p>
2127
+ * @public
2128
2128
  */
2129
2129
  nextToken?: string;
2130
2130
  /**
2131
- * @public
2132
2131
  * <p>The maximum number of records to list in a single response. </p>
2132
+ * @public
2133
2133
  */
2134
2134
  maxResults?: number;
2135
2135
  }
2136
2136
  /**
2137
- * @public
2138
2137
  * <p>The maximum number of records to list in a single response. </p>
2138
+ * @public
2139
2139
  */
2140
2140
  export interface ListJobsResult {
2141
2141
  /**
2142
- * @public
2143
2142
  * <p>The result structure for the list job result request. </p>
2143
+ * @public
2144
2144
  */
2145
2145
  jobSummaries: JobSummary[] | undefined;
2146
2146
  /**
2147
- * @public
2148
2147
  * <p>A pagination token. If non-null the pagination token is returned in a result. Pass its
2149
2148
  * value in another request to retrieve more entries. </p>
2149
+ * @public
2150
2150
  */
2151
2151
  nextToken?: string;
2152
2152
  }
2153
2153
  /**
2154
- * @public
2155
2154
  * <p>The request structure to use to list tags for a resource. </p>
2155
+ * @public
2156
2156
  */
2157
2157
  export interface ListTagsForResourceRequest {
2158
2158
  /**
2159
- * @public
2160
2159
  * <p>The Amazon Resource Name (ARN) to use to list tags. </p>
2160
+ * @public
2161
2161
  */
2162
2162
  resourceArn: string | undefined;
2163
2163
  }
2164
2164
  /**
2165
- * @public
2166
2165
  * <p>The response for the list tags for resource request. </p>
2166
+ * @public
2167
2167
  */
2168
2168
  export interface ListTagsForResourceResponse {
2169
2169
  /**
2170
- * @public
2171
2170
  * <p>A list of tags for the specified The Amazon Resource Name (ARN). </p>
2171
+ * @public
2172
2172
  */
2173
2173
  tags?: Record<string, string>;
2174
2174
  }
2175
2175
  /**
2176
- * @public
2177
2176
  * <p>An operation failed due to a non-existent resource. </p>
2177
+ * @public
2178
2178
  */
2179
2179
  export declare class ResourceNotFoundException extends __BaseException {
2180
2180
  readonly name: "ResourceNotFoundException";
@@ -2186,320 +2186,319 @@ export declare class ResourceNotFoundException extends __BaseException {
2186
2186
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
2187
2187
  }
2188
2188
  /**
2189
- * @public
2190
2189
  * <p>The request structure for the list webhooks request. </p>
2190
+ * @public
2191
2191
  */
2192
2192
  export interface ListWebhooksRequest {
2193
2193
  /**
2194
- * @public
2195
2194
  * <p>The unique ID for an Amplify app. </p>
2195
+ * @public
2196
2196
  */
2197
2197
  appId: string | undefined;
2198
2198
  /**
2199
- * @public
2200
2199
  * <p>A pagination token. Set to null to start listing webhooks from the start. If
2201
2200
  * non-null,the pagination token is returned in a result. Pass its value in here to list
2202
2201
  * more webhooks. </p>
2202
+ * @public
2203
2203
  */
2204
2204
  nextToken?: string;
2205
2205
  /**
2206
- * @public
2207
2206
  * <p>The maximum number of records to list in a single response. </p>
2207
+ * @public
2208
2208
  */
2209
2209
  maxResults?: number;
2210
2210
  }
2211
2211
  /**
2212
- * @public
2213
2212
  * <p>The result structure for the list webhooks request. </p>
2213
+ * @public
2214
2214
  */
2215
2215
  export interface ListWebhooksResult {
2216
2216
  /**
2217
- * @public
2218
2217
  * <p>A list of webhooks. </p>
2218
+ * @public
2219
2219
  */
2220
2220
  webhooks: Webhook[] | undefined;
2221
2221
  /**
2222
- * @public
2223
2222
  * <p>A pagination token. If non-null, the pagination token is returned in a result. Pass
2224
2223
  * its value in another request to retrieve more entries. </p>
2224
+ * @public
2225
2225
  */
2226
2226
  nextToken?: string;
2227
2227
  }
2228
2228
  /**
2229
- * @public
2230
2229
  * <p>The request structure for the start a deployment request. </p>
2230
+ * @public
2231
2231
  */
2232
2232
  export interface StartDeploymentRequest {
2233
2233
  /**
2234
- * @public
2235
2234
  * <p>The unique ID for an Amplify app. </p>
2235
+ * @public
2236
2236
  */
2237
2237
  appId: string | undefined;
2238
2238
  /**
2239
- * @public
2240
2239
  * <p>The name of the branch to use for the job. </p>
2240
+ * @public
2241
2241
  */
2242
2242
  branchName: string | undefined;
2243
2243
  /**
2244
- * @public
2245
2244
  * <p>The job ID for this deployment, generated by the create deployment request. </p>
2245
+ * @public
2246
2246
  */
2247
2247
  jobId?: string;
2248
2248
  /**
2249
- * @public
2250
2249
  * <p>The source URL for this deployment, used when calling start deployment without create
2251
2250
  * deployment. The source URL can be any HTTP GET URL that is publicly accessible and
2252
2251
  * downloads a single .zip file. </p>
2252
+ * @public
2253
2253
  */
2254
2254
  sourceUrl?: string;
2255
2255
  }
2256
2256
  /**
2257
- * @public
2258
2257
  * <p>The result structure for the start a deployment request. </p>
2258
+ * @public
2259
2259
  */
2260
2260
  export interface StartDeploymentResult {
2261
2261
  /**
2262
- * @public
2263
2262
  * <p>The summary for the job. </p>
2263
+ * @public
2264
2264
  */
2265
2265
  jobSummary: JobSummary | undefined;
2266
2266
  }
2267
2267
  /**
2268
- * @public
2269
2268
  * <p>The request structure for the start job request. </p>
2269
+ * @public
2270
2270
  */
2271
2271
  export interface StartJobRequest {
2272
2272
  /**
2273
- * @public
2274
2273
  * <p>The unique ID for an Amplify app. </p>
2274
+ * @public
2275
2275
  */
2276
2276
  appId: string | undefined;
2277
2277
  /**
2278
- * @public
2279
2278
  * <p>The name of the branch to use for the job. </p>
2279
+ * @public
2280
2280
  */
2281
2281
  branchName: string | undefined;
2282
2282
  /**
2283
- * @public
2284
2283
  * <p>The unique ID for an existing job. This is required if the value of
2285
2284
  * <code>jobType</code> is <code>RETRY</code>. </p>
2285
+ * @public
2286
2286
  */
2287
2287
  jobId?: string;
2288
2288
  /**
2289
- * @public
2290
2289
  * <p>Describes the type for the job. The job type <code>RELEASE</code> starts a new job
2291
2290
  * with the latest change from the specified branch. This value is available only for apps
2292
2291
  * that are connected to a repository. </p>
2293
2292
  * <p>The job type <code>RETRY</code> retries an existing job. If the job type value is
2294
2293
  * <code>RETRY</code>, the <code>jobId</code> is also required. </p>
2294
+ * @public
2295
2295
  */
2296
2296
  jobType: JobType | undefined;
2297
2297
  /**
2298
- * @public
2299
2298
  * <p>A descriptive reason for starting the job.</p>
2299
+ * @public
2300
2300
  */
2301
2301
  jobReason?: string;
2302
2302
  /**
2303
- * @public
2304
2303
  * <p> The commit ID from a third-party repository provider for the job. </p>
2304
+ * @public
2305
2305
  */
2306
2306
  commitId?: string;
2307
2307
  /**
2308
- * @public
2309
2308
  * <p> The commit message from a third-party repository provider for the job. </p>
2309
+ * @public
2310
2310
  */
2311
2311
  commitMessage?: string;
2312
2312
  /**
2313
- * @public
2314
2313
  * <p> The commit date and time for the job. </p>
2314
+ * @public
2315
2315
  */
2316
2316
  commitTime?: Date;
2317
2317
  }
2318
2318
  /**
2319
- * @public
2320
2319
  * <p> The result structure for the run job request. </p>
2320
+ * @public
2321
2321
  */
2322
2322
  export interface StartJobResult {
2323
2323
  /**
2324
- * @public
2325
2324
  * <p> The summary for the job. </p>
2325
+ * @public
2326
2326
  */
2327
2327
  jobSummary: JobSummary | undefined;
2328
2328
  }
2329
2329
  /**
2330
- * @public
2331
2330
  * <p> The request structure for the stop job request. </p>
2331
+ * @public
2332
2332
  */
2333
2333
  export interface StopJobRequest {
2334
2334
  /**
2335
- * @public
2336
2335
  * <p> The unique ID for an Amplify app. </p>
2336
+ * @public
2337
2337
  */
2338
2338
  appId: string | undefined;
2339
2339
  /**
2340
- * @public
2341
2340
  * <p>The name of the branch to use for the stop job request. </p>
2341
+ * @public
2342
2342
  */
2343
2343
  branchName: string | undefined;
2344
2344
  /**
2345
- * @public
2346
2345
  * <p> The unique id for the job. </p>
2346
+ * @public
2347
2347
  */
2348
2348
  jobId: string | undefined;
2349
2349
  }
2350
2350
  /**
2351
- * @public
2352
2351
  * <p> The result structure for the stop job request. </p>
2352
+ * @public
2353
2353
  */
2354
2354
  export interface StopJobResult {
2355
2355
  /**
2356
- * @public
2357
2356
  * <p> The summary for the job. </p>
2357
+ * @public
2358
2358
  */
2359
2359
  jobSummary: JobSummary | undefined;
2360
2360
  }
2361
2361
  /**
2362
- * @public
2363
2362
  * <p>The request structure to tag a resource with a tag key and value.</p>
2363
+ * @public
2364
2364
  */
2365
2365
  export interface TagResourceRequest {
2366
2366
  /**
2367
- * @public
2368
2367
  * <p> The Amazon Resource Name (ARN) to use to tag a resource. </p>
2368
+ * @public
2369
2369
  */
2370
2370
  resourceArn: string | undefined;
2371
2371
  /**
2372
- * @public
2373
2372
  * <p>The tags used to tag the resource. </p>
2373
+ * @public
2374
2374
  */
2375
2375
  tags: Record<string, string> | undefined;
2376
2376
  }
2377
2377
  /**
2378
- * @public
2379
2378
  * <p>The response for the tag resource request. </p>
2379
+ * @public
2380
2380
  */
2381
2381
  export interface TagResourceResponse {
2382
2382
  }
2383
2383
  /**
2384
- * @public
2385
2384
  * <p>The request structure for the untag resource request. </p>
2385
+ * @public
2386
2386
  */
2387
2387
  export interface UntagResourceRequest {
2388
2388
  /**
2389
- * @public
2390
2389
  * <p>The Amazon Resource Name (ARN) to use to untag a resource. </p>
2390
+ * @public
2391
2391
  */
2392
2392
  resourceArn: string | undefined;
2393
2393
  /**
2394
- * @public
2395
2394
  * <p>The tag keys to use to untag a resource. </p>
2395
+ * @public
2396
2396
  */
2397
2397
  tagKeys: string[] | undefined;
2398
2398
  }
2399
2399
  /**
2400
- * @public
2401
2400
  * <p>The response for the untag resource request. </p>
2401
+ * @public
2402
2402
  */
2403
2403
  export interface UntagResourceResponse {
2404
2404
  }
2405
2405
  /**
2406
- * @public
2407
2406
  * <p>The request structure for the update app request. </p>
2407
+ * @public
2408
2408
  */
2409
2409
  export interface UpdateAppRequest {
2410
2410
  /**
2411
- * @public
2412
2411
  * <p>The unique ID for an Amplify app. </p>
2412
+ * @public
2413
2413
  */
2414
2414
  appId: string | undefined;
2415
2415
  /**
2416
- * @public
2417
2416
  * <p>The name for an Amplify app. </p>
2417
+ * @public
2418
2418
  */
2419
2419
  name?: string;
2420
2420
  /**
2421
- * @public
2422
2421
  * <p>The description for an Amplify app. </p>
2422
+ * @public
2423
2423
  */
2424
2424
  description?: string;
2425
2425
  /**
2426
- * @public
2427
2426
  * <p>The platform for the Amplify app. For a static app, set the platform type to
2428
2427
  * <code>WEB</code>. For a dynamic server-side rendered (SSR) app, set the platform
2429
2428
  * type to <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR
2430
2429
  * support only, set the platform type to <code>WEB_DYNAMIC</code>.</p>
2430
+ * @public
2431
2431
  */
2432
2432
  platform?: Platform;
2433
2433
  /**
2434
- * @public
2435
2434
  * <p>The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
2435
+ * @public
2436
2436
  */
2437
2437
  iamServiceRoleArn?: string;
2438
2438
  /**
2439
- * @public
2440
2439
  * <p>The environment variables for an Amplify app. </p>
2440
+ * @public
2441
2441
  */
2442
2442
  environmentVariables?: Record<string, string>;
2443
2443
  /**
2444
- * @public
2445
2444
  * <p>Enables branch auto-building for an Amplify app. </p>
2445
+ * @public
2446
2446
  */
2447
2447
  enableBranchAutoBuild?: boolean;
2448
2448
  /**
2449
- * @public
2450
2449
  * <p>Automatically disconnects a branch in the Amplify console when you delete a branch
2451
2450
  * from your Git repository. </p>
2451
+ * @public
2452
2452
  */
2453
2453
  enableBranchAutoDeletion?: boolean;
2454
2454
  /**
2455
- * @public
2456
2455
  * <p>Enables basic authorization for an Amplify app. </p>
2456
+ * @public
2457
2457
  */
2458
2458
  enableBasicAuth?: boolean;
2459
2459
  /**
2460
- * @public
2461
2460
  * <p>The basic authorization credentials for an Amplify app. You must base64-encode the
2462
2461
  * authorization credentials and provide them in the format
2463
2462
  * <code>user:password</code>.</p>
2463
+ * @public
2464
2464
  */
2465
2465
  basicAuthCredentials?: string;
2466
2466
  /**
2467
- * @public
2468
2467
  * <p>The custom redirect and rewrite rules for an Amplify app. </p>
2468
+ * @public
2469
2469
  */
2470
2470
  customRules?: CustomRule[];
2471
2471
  /**
2472
- * @public
2473
2472
  * <p>The build specification (build spec) for an Amplify app. </p>
2473
+ * @public
2474
2474
  */
2475
2475
  buildSpec?: string;
2476
2476
  /**
2477
- * @public
2478
2477
  * <p>The custom HTTP headers for an Amplify app.</p>
2478
+ * @public
2479
2479
  */
2480
2480
  customHeaders?: string;
2481
2481
  /**
2482
- * @public
2483
2482
  * <p>Enables automated branch creation for an Amplify app. </p>
2483
+ * @public
2484
2484
  */
2485
2485
  enableAutoBranchCreation?: boolean;
2486
2486
  /**
2487
- * @public
2488
2487
  * <p>Describes the automated branch creation glob patterns for an Amplify app. </p>
2488
+ * @public
2489
2489
  */
2490
2490
  autoBranchCreationPatterns?: string[];
2491
2491
  /**
2492
- * @public
2493
2492
  * <p>The automated branch creation configuration for an Amplify app. </p>
2493
+ * @public
2494
2494
  */
2495
2495
  autoBranchCreationConfig?: AutoBranchCreationConfig;
2496
2496
  /**
2497
- * @public
2498
2497
  * <p>The name of the Git repository for an Amplify app.</p>
2498
+ * @public
2499
2499
  */
2500
2500
  repository?: string;
2501
2501
  /**
2502
- * @public
2503
2502
  * <p>The OAuth token for a third-party source control system for an Amplify app. The OAuth
2504
2503
  * token is used to create a webhook and a read-only deploy key using SSH cloning. The
2505
2504
  * OAuth token is not stored.</p>
@@ -2513,10 +2512,10 @@ export interface UpdateAppRequest {
2513
2512
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
2514
2513
  * 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
2515
2514
  * <i>Amplify User Guide</i> .</p>
2515
+ * @public
2516
2516
  */
2517
2517
  oauthToken?: string;
2518
2518
  /**
2519
- * @public
2520
2519
  * <p>The personal access token for a GitHub repository for an Amplify app. The personal
2521
2520
  * access token is used to authorize access to a GitHub repository using the Amplify GitHub
2522
2521
  * App. The token is not stored.</p>
@@ -2528,217 +2527,218 @@ export interface UpdateAppRequest {
2528
2527
  * with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub
2529
2528
  * 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
2530
2529
  * <i>Amplify User Guide</i> .</p>
2530
+ * @public
2531
2531
  */
2532
2532
  accessToken?: string;
2533
2533
  }
2534
2534
  /**
2535
- * @public
2536
2535
  * <p>The result structure for an Amplify app update request. </p>
2536
+ * @public
2537
2537
  */
2538
2538
  export interface UpdateAppResult {
2539
2539
  /**
2540
- * @public
2541
2540
  * <p>Represents the updated Amplify app. </p>
2541
+ * @public
2542
2542
  */
2543
2543
  app: App | undefined;
2544
2544
  }
2545
2545
  /**
2546
- * @public
2547
2546
  * <p>The request structure for the update branch request. </p>
2547
+ * @public
2548
2548
  */
2549
2549
  export interface UpdateBranchRequest {
2550
2550
  /**
2551
- * @public
2552
2551
  * <p> The unique ID for an Amplify app. </p>
2552
+ * @public
2553
2553
  */
2554
2554
  appId: string | undefined;
2555
2555
  /**
2556
- * @public
2557
2556
  * <p>The name of the branch. </p>
2557
+ * @public
2558
2558
  */
2559
2559
  branchName: string | undefined;
2560
2560
  /**
2561
- * @public
2562
2561
  * <p> The description for the branch. </p>
2562
+ * @public
2563
2563
  */
2564
2564
  description?: string;
2565
2565
  /**
2566
- * @public
2567
2566
  * <p> The framework for the branch. </p>
2567
+ * @public
2568
2568
  */
2569
2569
  framework?: string;
2570
2570
  /**
2571
- * @public
2572
2571
  * <p> Describes the current stage for the branch. </p>
2572
+ * @public
2573
2573
  */
2574
2574
  stage?: Stage;
2575
2575
  /**
2576
- * @public
2577
2576
  * <p> Enables notifications for the branch. </p>
2577
+ * @public
2578
2578
  */
2579
2579
  enableNotification?: boolean;
2580
2580
  /**
2581
- * @public
2582
2581
  * <p> Enables auto building for the branch. </p>
2582
+ * @public
2583
2583
  */
2584
2584
  enableAutoBuild?: boolean;
2585
2585
  /**
2586
- * @public
2587
2586
  * <p> The environment variables for the branch. </p>
2587
+ * @public
2588
2588
  */
2589
2589
  environmentVariables?: Record<string, string>;
2590
2590
  /**
2591
- * @public
2592
2591
  * <p> The basic authorization credentials for the branch. You must base64-encode the
2593
2592
  * authorization credentials and provide them in the format
2594
2593
  * <code>user:password</code>.</p>
2594
+ * @public
2595
2595
  */
2596
2596
  basicAuthCredentials?: string;
2597
2597
  /**
2598
- * @public
2599
2598
  * <p> Enables basic authorization for the branch. </p>
2599
+ * @public
2600
2600
  */
2601
2601
  enableBasicAuth?: boolean;
2602
2602
  /**
2603
- * @public
2604
2603
  * <p>Enables performance mode for the branch.</p>
2605
2604
  * <p>Performance mode optimizes for faster hosting performance by keeping content cached at
2606
2605
  * the edge for a longer interval. When performance mode is enabled, hosting configuration
2607
2606
  * or code changes can take up to 10 minutes to roll out. </p>
2607
+ * @public
2608
2608
  */
2609
2609
  enablePerformanceMode?: boolean;
2610
2610
  /**
2611
- * @public
2612
2611
  * <p> The build specification (build spec) for the branch. </p>
2612
+ * @public
2613
2613
  */
2614
2614
  buildSpec?: string;
2615
2615
  /**
2616
- * @public
2617
2616
  * <p> The content Time to Live (TTL) for the website in seconds. </p>
2617
+ * @public
2618
2618
  */
2619
2619
  ttl?: string;
2620
2620
  /**
2621
- * @public
2622
2621
  * <p> The display name for a branch. This is used as the default domain prefix. </p>
2622
+ * @public
2623
2623
  */
2624
2624
  displayName?: string;
2625
2625
  /**
2626
- * @public
2627
2626
  * <p> Enables pull request previews for this branch. </p>
2627
+ * @public
2628
2628
  */
2629
2629
  enablePullRequestPreview?: boolean;
2630
2630
  /**
2631
- * @public
2632
2631
  * <p> The Amplify environment name for the pull request. </p>
2632
+ * @public
2633
2633
  */
2634
2634
  pullRequestEnvironmentName?: string;
2635
2635
  /**
2636
- * @public
2637
2636
  * <p>The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
2638
2637
  * app. </p>
2638
+ * @public
2639
2639
  */
2640
2640
  backendEnvironmentArn?: string;
2641
2641
  /**
2642
- * @public
2643
2642
  * <p>The backend for a <code>Branch</code> of an Amplify app. Use for a
2644
2643
  * backend created from an CloudFormation stack.</p>
2644
+ * @public
2645
2645
  */
2646
2646
  backend?: Backend;
2647
2647
  }
2648
2648
  /**
2649
- * @public
2650
2649
  * <p> The result structure for the update branch request. </p>
2650
+ * @public
2651
2651
  */
2652
2652
  export interface UpdateBranchResult {
2653
2653
  /**
2654
- * @public
2655
2654
  * <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
2655
+ * @public
2656
2656
  */
2657
2657
  branch: Branch | undefined;
2658
2658
  }
2659
2659
  /**
2660
- * @public
2661
2660
  * <p> The request structure for the update domain association request. </p>
2661
+ * @public
2662
2662
  */
2663
2663
  export interface UpdateDomainAssociationRequest {
2664
2664
  /**
2665
- * @public
2666
2665
  * <p> The unique ID for an Amplify app. </p>
2666
+ * @public
2667
2667
  */
2668
2668
  appId: string | undefined;
2669
2669
  /**
2670
- * @public
2671
2670
  * <p> The name of the domain. </p>
2671
+ * @public
2672
2672
  */
2673
2673
  domainName: string | undefined;
2674
2674
  /**
2675
- * @public
2676
2675
  * <p> Enables the automated creation of subdomains for branches. </p>
2676
+ * @public
2677
2677
  */
2678
2678
  enableAutoSubDomain?: boolean;
2679
2679
  /**
2680
- * @public
2681
2680
  * <p> Describes the settings for the subdomain. </p>
2681
+ * @public
2682
2682
  */
2683
2683
  subDomainSettings?: SubDomainSetting[];
2684
2684
  /**
2685
- * @public
2686
2685
  * <p> Sets the branch patterns for automatic subdomain creation. </p>
2686
+ * @public
2687
2687
  */
2688
2688
  autoSubDomainCreationPatterns?: string[];
2689
2689
  /**
2690
- * @public
2691
2690
  * <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
2692
2691
  * Resource Name (ARN) for automatically creating subdomains. </p>
2692
+ * @public
2693
2693
  */
2694
2694
  autoSubDomainIAMRole?: string;
2695
2695
  /**
2696
- * @public
2697
2696
  * <p>The type of SSL/TLS certificate to use for your custom domain.</p>
2697
+ * @public
2698
2698
  */
2699
2699
  certificateSettings?: CertificateSettings;
2700
2700
  }
2701
2701
  /**
2702
- * @public
2703
2702
  * <p> The result structure for the update domain association request. </p>
2703
+ * @public
2704
2704
  */
2705
2705
  export interface UpdateDomainAssociationResult {
2706
2706
  /**
2707
- * @public
2708
2707
  * <p> Describes a domain association, which associates a custom domain with an Amplify app.
2709
2708
  * </p>
2709
+ * @public
2710
2710
  */
2711
2711
  domainAssociation: DomainAssociation | undefined;
2712
2712
  }
2713
2713
  /**
2714
- * @public
2715
2714
  * <p>The request structure for the update webhook request. </p>
2715
+ * @public
2716
2716
  */
2717
2717
  export interface UpdateWebhookRequest {
2718
2718
  /**
2719
- * @public
2720
2719
  * <p>The unique ID for a webhook. </p>
2720
+ * @public
2721
2721
  */
2722
2722
  webhookId: string | undefined;
2723
2723
  /**
2724
- * @public
2725
2724
  * <p>The name for a branch that is part of an Amplify app. </p>
2725
+ * @public
2726
2726
  */
2727
2727
  branchName?: string;
2728
2728
  /**
2729
- * @public
2730
2729
  * <p>The description for a webhook. </p>
2730
+ * @public
2731
2731
  */
2732
2732
  description?: string;
2733
2733
  }
2734
2734
  /**
2735
- * @public
2736
2735
  * <p>The result structure for the update webhook request. </p>
2736
+ * @public
2737
2737
  */
2738
2738
  export interface UpdateWebhookResult {
2739
2739
  /**
2740
- * @public
2741
2740
  * <p>Describes a webhook that connects repository events to an Amplify app. </p>
2741
+ * @public
2742
2742
  */
2743
2743
  webhook: Webhook | undefined;
2744
2744
  }