@aws-sdk/client-amplify 3.379.1 → 3.385.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.
- package/dist-types/models/models_0.d.ts +334 -0
- package/package.json +5 -5
|
@@ -33,32 +33,39 @@ export type Stage = (typeof Stage)[keyof typeof Stage];
|
|
|
33
33
|
*/
|
|
34
34
|
export interface AutoBranchCreationConfig {
|
|
35
35
|
/**
|
|
36
|
+
* @public
|
|
36
37
|
* <p> Describes the current stage for the autocreated branch. </p>
|
|
37
38
|
*/
|
|
38
39
|
stage?: Stage | string;
|
|
39
40
|
/**
|
|
41
|
+
* @public
|
|
40
42
|
* <p> The framework for the autocreated branch. </p>
|
|
41
43
|
*/
|
|
42
44
|
framework?: string;
|
|
43
45
|
/**
|
|
46
|
+
* @public
|
|
44
47
|
* <p> Enables auto building for the autocreated branch. </p>
|
|
45
48
|
*/
|
|
46
49
|
enableAutoBuild?: boolean;
|
|
47
50
|
/**
|
|
51
|
+
* @public
|
|
48
52
|
* <p> The environment variables for the autocreated branch. </p>
|
|
49
53
|
*/
|
|
50
54
|
environmentVariables?: Record<string, string>;
|
|
51
55
|
/**
|
|
56
|
+
* @public
|
|
52
57
|
* <p> The basic authorization credentials for the autocreated branch. You must
|
|
53
58
|
* base64-encode the authorization credentials and provide them in the format
|
|
54
59
|
* <code>user:password</code>.</p>
|
|
55
60
|
*/
|
|
56
61
|
basicAuthCredentials?: string;
|
|
57
62
|
/**
|
|
63
|
+
* @public
|
|
58
64
|
* <p> Enables basic authorization for the autocreated branch. </p>
|
|
59
65
|
*/
|
|
60
66
|
enableBasicAuth?: boolean;
|
|
61
67
|
/**
|
|
68
|
+
* @public
|
|
62
69
|
* <p>Enables performance mode for the branch.</p>
|
|
63
70
|
* <p>Performance mode optimizes for faster hosting performance by keeping content cached at
|
|
64
71
|
* the edge for a longer interval. When performance mode is enabled, hosting configuration
|
|
@@ -66,14 +73,17 @@ export interface AutoBranchCreationConfig {
|
|
|
66
73
|
*/
|
|
67
74
|
enablePerformanceMode?: boolean;
|
|
68
75
|
/**
|
|
76
|
+
* @public
|
|
69
77
|
* <p> The build specification (build spec) for the autocreated branch. </p>
|
|
70
78
|
*/
|
|
71
79
|
buildSpec?: string;
|
|
72
80
|
/**
|
|
81
|
+
* @public
|
|
73
82
|
* <p> Enables pull request previews for the autocreated branch. </p>
|
|
74
83
|
*/
|
|
75
84
|
enablePullRequestPreview?: boolean;
|
|
76
85
|
/**
|
|
86
|
+
* @public
|
|
77
87
|
* <p> The Amplify environment name for the pull request. </p>
|
|
78
88
|
*/
|
|
79
89
|
pullRequestEnvironmentName?: string;
|
|
@@ -84,14 +94,17 @@ export interface AutoBranchCreationConfig {
|
|
|
84
94
|
*/
|
|
85
95
|
export interface CustomRule {
|
|
86
96
|
/**
|
|
97
|
+
* @public
|
|
87
98
|
* <p> The source pattern for a URL rewrite or redirect rule. </p>
|
|
88
99
|
*/
|
|
89
100
|
source: string | undefined;
|
|
90
101
|
/**
|
|
102
|
+
* @public
|
|
91
103
|
* <p> The target pattern for a URL rewrite or redirect rule. </p>
|
|
92
104
|
*/
|
|
93
105
|
target: string | undefined;
|
|
94
106
|
/**
|
|
107
|
+
* @public
|
|
95
108
|
* <p> The status code for a URL rewrite or redirect rule. </p>
|
|
96
109
|
*
|
|
97
110
|
* <dl>
|
|
@@ -120,6 +133,7 @@ export interface CustomRule {
|
|
|
120
133
|
*/
|
|
121
134
|
status?: string;
|
|
122
135
|
/**
|
|
136
|
+
* @public
|
|
123
137
|
* <p> The condition for a URL rewrite or redirect rule, such as a country code. </p>
|
|
124
138
|
*/
|
|
125
139
|
condition?: string;
|
|
@@ -143,18 +157,22 @@ export type Platform = (typeof Platform)[keyof typeof Platform];
|
|
|
143
157
|
*/
|
|
144
158
|
export interface CreateAppRequest {
|
|
145
159
|
/**
|
|
160
|
+
* @public
|
|
146
161
|
* <p> The name for an Amplify app. </p>
|
|
147
162
|
*/
|
|
148
163
|
name: string | undefined;
|
|
149
164
|
/**
|
|
165
|
+
* @public
|
|
150
166
|
* <p> The description for an Amplify app. </p>
|
|
151
167
|
*/
|
|
152
168
|
description?: string;
|
|
153
169
|
/**
|
|
170
|
+
* @public
|
|
154
171
|
* <p> The repository for an Amplify app. </p>
|
|
155
172
|
*/
|
|
156
173
|
repository?: string;
|
|
157
174
|
/**
|
|
175
|
+
* @public
|
|
158
176
|
* <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
|
|
159
177
|
* For a dynamic server-side rendered (SSR) app, set the platform type to
|
|
160
178
|
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
|
|
@@ -162,10 +180,12 @@ export interface CreateAppRequest {
|
|
|
162
180
|
*/
|
|
163
181
|
platform?: Platform | string;
|
|
164
182
|
/**
|
|
183
|
+
* @public
|
|
165
184
|
* <p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
|
|
166
185
|
*/
|
|
167
186
|
iamServiceRoleArn?: string;
|
|
168
187
|
/**
|
|
188
|
+
* @public
|
|
169
189
|
* <p>The OAuth token for a third-party source control system for an Amplify app. The OAuth
|
|
170
190
|
* token is used to create a webhook and a read-only deploy key using SSH cloning. The
|
|
171
191
|
* OAuth token is not stored.</p>
|
|
@@ -181,6 +201,7 @@ export interface CreateAppRequest {
|
|
|
181
201
|
*/
|
|
182
202
|
oauthToken?: string;
|
|
183
203
|
/**
|
|
204
|
+
* @public
|
|
184
205
|
* <p>The personal access token for a GitHub repository for an Amplify app. The personal
|
|
185
206
|
* access token is used to authorize access to a GitHub repository using the Amplify GitHub
|
|
186
207
|
* App. The token is not stored.</p>
|
|
@@ -195,54 +216,66 @@ export interface CreateAppRequest {
|
|
|
195
216
|
*/
|
|
196
217
|
accessToken?: string;
|
|
197
218
|
/**
|
|
219
|
+
* @public
|
|
198
220
|
* <p> The environment variables map for an Amplify app. </p>
|
|
199
221
|
*/
|
|
200
222
|
environmentVariables?: Record<string, string>;
|
|
201
223
|
/**
|
|
224
|
+
* @public
|
|
202
225
|
* <p> Enables the auto building of branches for an Amplify app. </p>
|
|
203
226
|
*/
|
|
204
227
|
enableBranchAutoBuild?: boolean;
|
|
205
228
|
/**
|
|
229
|
+
* @public
|
|
206
230
|
* <p> Automatically disconnects a branch in the Amplify Console when you delete a branch
|
|
207
231
|
* from your Git repository. </p>
|
|
208
232
|
*/
|
|
209
233
|
enableBranchAutoDeletion?: boolean;
|
|
210
234
|
/**
|
|
235
|
+
* @public
|
|
211
236
|
* <p> Enables basic authorization for an Amplify app. This will apply to all branches that
|
|
212
237
|
* are part of this app. </p>
|
|
213
238
|
*/
|
|
214
239
|
enableBasicAuth?: boolean;
|
|
215
240
|
/**
|
|
241
|
+
* @public
|
|
216
242
|
* <p> The credentials for basic authorization for an Amplify app. You must base64-encode
|
|
217
243
|
* the authorization credentials and provide them in the format
|
|
218
244
|
* <code>user:password</code>.</p>
|
|
219
245
|
*/
|
|
220
246
|
basicAuthCredentials?: string;
|
|
221
247
|
/**
|
|
248
|
+
* @public
|
|
222
249
|
* <p> The custom rewrite and redirect rules for an Amplify app. </p>
|
|
223
250
|
*/
|
|
224
251
|
customRules?: CustomRule[];
|
|
225
252
|
/**
|
|
253
|
+
* @public
|
|
226
254
|
* <p> The tag for an Amplify app. </p>
|
|
227
255
|
*/
|
|
228
256
|
tags?: Record<string, string>;
|
|
229
257
|
/**
|
|
258
|
+
* @public
|
|
230
259
|
* <p> The build specification (build spec) for an Amplify app. </p>
|
|
231
260
|
*/
|
|
232
261
|
buildSpec?: string;
|
|
233
262
|
/**
|
|
263
|
+
* @public
|
|
234
264
|
* <p>The custom HTTP headers for an Amplify app.</p>
|
|
235
265
|
*/
|
|
236
266
|
customHeaders?: string;
|
|
237
267
|
/**
|
|
268
|
+
* @public
|
|
238
269
|
* <p> Enables automated branch creation for an Amplify app. </p>
|
|
239
270
|
*/
|
|
240
271
|
enableAutoBranchCreation?: boolean;
|
|
241
272
|
/**
|
|
273
|
+
* @public
|
|
242
274
|
* <p> The automated branch creation glob patterns for an Amplify app. </p>
|
|
243
275
|
*/
|
|
244
276
|
autoBranchCreationPatterns?: string[];
|
|
245
277
|
/**
|
|
278
|
+
* @public
|
|
246
279
|
* <p> The automated branch creation configuration for an Amplify app. </p>
|
|
247
280
|
*/
|
|
248
281
|
autoBranchCreationConfig?: AutoBranchCreationConfig;
|
|
@@ -253,18 +286,22 @@ export interface CreateAppRequest {
|
|
|
253
286
|
*/
|
|
254
287
|
export interface ProductionBranch {
|
|
255
288
|
/**
|
|
289
|
+
* @public
|
|
256
290
|
* <p> The last deploy time of the production branch. </p>
|
|
257
291
|
*/
|
|
258
292
|
lastDeployTime?: Date;
|
|
259
293
|
/**
|
|
294
|
+
* @public
|
|
260
295
|
* <p> The status of the production branch. </p>
|
|
261
296
|
*/
|
|
262
297
|
status?: string;
|
|
263
298
|
/**
|
|
299
|
+
* @public
|
|
264
300
|
* <p> The thumbnail URL for the production branch. </p>
|
|
265
301
|
*/
|
|
266
302
|
thumbnailUrl?: string;
|
|
267
303
|
/**
|
|
304
|
+
* @public
|
|
268
305
|
* <p> The branch name for the production branch. </p>
|
|
269
306
|
*/
|
|
270
307
|
branchName?: string;
|
|
@@ -289,30 +326,37 @@ export type RepositoryCloneMethod = (typeof RepositoryCloneMethod)[keyof typeof
|
|
|
289
326
|
*/
|
|
290
327
|
export interface App {
|
|
291
328
|
/**
|
|
329
|
+
* @public
|
|
292
330
|
* <p> The unique ID of the Amplify app. </p>
|
|
293
331
|
*/
|
|
294
332
|
appId: string | undefined;
|
|
295
333
|
/**
|
|
334
|
+
* @public
|
|
296
335
|
* <p> The Amazon Resource Name (ARN) of the Amplify app. </p>
|
|
297
336
|
*/
|
|
298
337
|
appArn: string | undefined;
|
|
299
338
|
/**
|
|
339
|
+
* @public
|
|
300
340
|
* <p> The name for the Amplify app. </p>
|
|
301
341
|
*/
|
|
302
342
|
name: string | undefined;
|
|
303
343
|
/**
|
|
344
|
+
* @public
|
|
304
345
|
* <p> The tag for the Amplify app. </p>
|
|
305
346
|
*/
|
|
306
347
|
tags?: Record<string, string>;
|
|
307
348
|
/**
|
|
349
|
+
* @public
|
|
308
350
|
* <p> The description for the Amplify app. </p>
|
|
309
351
|
*/
|
|
310
352
|
description: string | undefined;
|
|
311
353
|
/**
|
|
354
|
+
* @public
|
|
312
355
|
* <p> The Git repository for the Amplify app. </p>
|
|
313
356
|
*/
|
|
314
357
|
repository: string | undefined;
|
|
315
358
|
/**
|
|
359
|
+
* @public
|
|
316
360
|
* <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
|
|
317
361
|
* For a dynamic server-side rendered (SSR) app, set the platform type to
|
|
318
362
|
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
|
|
@@ -320,75 +364,92 @@ export interface App {
|
|
|
320
364
|
*/
|
|
321
365
|
platform: Platform | string | undefined;
|
|
322
366
|
/**
|
|
367
|
+
* @public
|
|
323
368
|
* <p> Creates a date and time for the Amplify app. </p>
|
|
324
369
|
*/
|
|
325
370
|
createTime: Date | undefined;
|
|
326
371
|
/**
|
|
372
|
+
* @public
|
|
327
373
|
* <p> Updates the date and time for the Amplify app. </p>
|
|
328
374
|
*/
|
|
329
375
|
updateTime: Date | undefined;
|
|
330
376
|
/**
|
|
377
|
+
* @public
|
|
331
378
|
* <p> The AWS Identity and Access Management (IAM) service role for the Amazon Resource
|
|
332
379
|
* Name (ARN) of the Amplify app. </p>
|
|
333
380
|
*/
|
|
334
381
|
iamServiceRoleArn?: string;
|
|
335
382
|
/**
|
|
383
|
+
* @public
|
|
336
384
|
* <p> The environment variables for the Amplify app. </p>
|
|
337
385
|
*/
|
|
338
386
|
environmentVariables: Record<string, string> | undefined;
|
|
339
387
|
/**
|
|
388
|
+
* @public
|
|
340
389
|
* <p> The default domain for the Amplify app. </p>
|
|
341
390
|
*/
|
|
342
391
|
defaultDomain: string | undefined;
|
|
343
392
|
/**
|
|
393
|
+
* @public
|
|
344
394
|
* <p> Enables the auto-building of branches for the Amplify app. </p>
|
|
345
395
|
*/
|
|
346
396
|
enableBranchAutoBuild: boolean | undefined;
|
|
347
397
|
/**
|
|
398
|
+
* @public
|
|
348
399
|
* <p> Automatically disconnect a branch in the Amplify Console when you delete a branch
|
|
349
400
|
* from your Git repository. </p>
|
|
350
401
|
*/
|
|
351
402
|
enableBranchAutoDeletion?: boolean;
|
|
352
403
|
/**
|
|
404
|
+
* @public
|
|
353
405
|
* <p> Enables basic authorization for the Amplify app's branches. </p>
|
|
354
406
|
*/
|
|
355
407
|
enableBasicAuth: boolean | undefined;
|
|
356
408
|
/**
|
|
409
|
+
* @public
|
|
357
410
|
* <p> The basic authorization credentials for branches for the Amplify app. You must
|
|
358
411
|
* base64-encode the authorization credentials and provide them in the format
|
|
359
412
|
* <code>user:password</code>.</p>
|
|
360
413
|
*/
|
|
361
414
|
basicAuthCredentials?: string;
|
|
362
415
|
/**
|
|
416
|
+
* @public
|
|
363
417
|
* <p> Describes the custom redirect and rewrite rules for the Amplify app. </p>
|
|
364
418
|
*/
|
|
365
419
|
customRules?: CustomRule[];
|
|
366
420
|
/**
|
|
421
|
+
* @public
|
|
367
422
|
* <p> Describes the information about a production branch of the Amplify app. </p>
|
|
368
423
|
*/
|
|
369
424
|
productionBranch?: ProductionBranch;
|
|
370
425
|
/**
|
|
426
|
+
* @public
|
|
371
427
|
* <p> Describes the content of the build specification (build spec) for the Amplify app.
|
|
372
428
|
* </p>
|
|
373
429
|
*/
|
|
374
430
|
buildSpec?: string;
|
|
375
431
|
/**
|
|
432
|
+
* @public
|
|
376
433
|
* <p>Describes the custom HTTP headers for the Amplify app.</p>
|
|
377
434
|
*/
|
|
378
435
|
customHeaders?: string;
|
|
379
436
|
/**
|
|
437
|
+
* @public
|
|
380
438
|
* <p> Enables automated branch creation for the Amplify app. </p>
|
|
381
439
|
*/
|
|
382
440
|
enableAutoBranchCreation?: boolean;
|
|
383
441
|
/**
|
|
442
|
+
* @public
|
|
384
443
|
* <p> Describes the automated branch creation glob patterns for the Amplify app. </p>
|
|
385
444
|
*/
|
|
386
445
|
autoBranchCreationPatterns?: string[];
|
|
387
446
|
/**
|
|
447
|
+
* @public
|
|
388
448
|
* <p> Describes the automated branch creation configuration for the Amplify app. </p>
|
|
389
449
|
*/
|
|
390
450
|
autoBranchCreationConfig?: AutoBranchCreationConfig;
|
|
391
451
|
/**
|
|
452
|
+
* @public
|
|
392
453
|
* <note>
|
|
393
454
|
* <p>This is for internal use.</p>
|
|
394
455
|
* </note>
|
|
@@ -404,6 +465,7 @@ export interface App {
|
|
|
404
465
|
*/
|
|
405
466
|
export interface CreateAppResult {
|
|
406
467
|
/**
|
|
468
|
+
* @public
|
|
407
469
|
* <p> Represents the different branches of a repository for building, deploying, and
|
|
408
470
|
* hosting an Amplify app. </p>
|
|
409
471
|
*/
|
|
@@ -463,18 +525,22 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
463
525
|
*/
|
|
464
526
|
export interface CreateBackendEnvironmentRequest {
|
|
465
527
|
/**
|
|
528
|
+
* @public
|
|
466
529
|
* <p> The unique ID for an Amplify app. </p>
|
|
467
530
|
*/
|
|
468
531
|
appId: string | undefined;
|
|
469
532
|
/**
|
|
533
|
+
* @public
|
|
470
534
|
* <p> The name for the backend environment. </p>
|
|
471
535
|
*/
|
|
472
536
|
environmentName: string | undefined;
|
|
473
537
|
/**
|
|
538
|
+
* @public
|
|
474
539
|
* <p> The AWS CloudFormation stack name of a backend environment. </p>
|
|
475
540
|
*/
|
|
476
541
|
stackName?: string;
|
|
477
542
|
/**
|
|
543
|
+
* @public
|
|
478
544
|
* <p> The name of deployment artifacts. </p>
|
|
479
545
|
*/
|
|
480
546
|
deploymentArtifacts?: string;
|
|
@@ -485,28 +551,34 @@ export interface CreateBackendEnvironmentRequest {
|
|
|
485
551
|
*/
|
|
486
552
|
export interface BackendEnvironment {
|
|
487
553
|
/**
|
|
554
|
+
* @public
|
|
488
555
|
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
|
|
489
556
|
* app. </p>
|
|
490
557
|
*/
|
|
491
558
|
backendEnvironmentArn: string | undefined;
|
|
492
559
|
/**
|
|
560
|
+
* @public
|
|
493
561
|
* <p> The name for a backend environment that is part of an Amplify app. </p>
|
|
494
562
|
*/
|
|
495
563
|
environmentName: string | undefined;
|
|
496
564
|
/**
|
|
565
|
+
* @public
|
|
497
566
|
* <p> The AWS CloudFormation stack name of a backend environment. </p>
|
|
498
567
|
*/
|
|
499
568
|
stackName?: string;
|
|
500
569
|
/**
|
|
570
|
+
* @public
|
|
501
571
|
* <p> The name of deployment artifacts. </p>
|
|
502
572
|
*/
|
|
503
573
|
deploymentArtifacts?: string;
|
|
504
574
|
/**
|
|
575
|
+
* @public
|
|
505
576
|
* <p> The creation date and time for a backend environment that is part of an Amplify app.
|
|
506
577
|
* </p>
|
|
507
578
|
*/
|
|
508
579
|
createTime: Date | undefined;
|
|
509
580
|
/**
|
|
581
|
+
* @public
|
|
510
582
|
* <p> The last updated date and time for a backend environment that is part of an Amplify
|
|
511
583
|
* app. </p>
|
|
512
584
|
*/
|
|
@@ -518,6 +590,7 @@ export interface BackendEnvironment {
|
|
|
518
590
|
*/
|
|
519
591
|
export interface CreateBackendEnvironmentResult {
|
|
520
592
|
/**
|
|
593
|
+
* @public
|
|
521
594
|
* <p> Describes the backend environment for an Amplify app. </p>
|
|
522
595
|
*/
|
|
523
596
|
backendEnvironment: BackendEnvironment | undefined;
|
|
@@ -540,48 +613,59 @@ export declare class NotFoundException extends __BaseException {
|
|
|
540
613
|
*/
|
|
541
614
|
export interface CreateBranchRequest {
|
|
542
615
|
/**
|
|
616
|
+
* @public
|
|
543
617
|
* <p> The unique ID for an Amplify app. </p>
|
|
544
618
|
*/
|
|
545
619
|
appId: string | undefined;
|
|
546
620
|
/**
|
|
621
|
+
* @public
|
|
547
622
|
* <p> The name for the branch. </p>
|
|
548
623
|
*/
|
|
549
624
|
branchName: string | undefined;
|
|
550
625
|
/**
|
|
626
|
+
* @public
|
|
551
627
|
* <p> The description for the branch. </p>
|
|
552
628
|
*/
|
|
553
629
|
description?: string;
|
|
554
630
|
/**
|
|
631
|
+
* @public
|
|
555
632
|
* <p> Describes the current stage for the branch. </p>
|
|
556
633
|
*/
|
|
557
634
|
stage?: Stage | string;
|
|
558
635
|
/**
|
|
636
|
+
* @public
|
|
559
637
|
* <p> The framework for the branch. </p>
|
|
560
638
|
*/
|
|
561
639
|
framework?: string;
|
|
562
640
|
/**
|
|
641
|
+
* @public
|
|
563
642
|
* <p> Enables notifications for the branch. </p>
|
|
564
643
|
*/
|
|
565
644
|
enableNotification?: boolean;
|
|
566
645
|
/**
|
|
646
|
+
* @public
|
|
567
647
|
* <p> Enables auto building for the branch. </p>
|
|
568
648
|
*/
|
|
569
649
|
enableAutoBuild?: boolean;
|
|
570
650
|
/**
|
|
651
|
+
* @public
|
|
571
652
|
* <p> The environment variables for the branch. </p>
|
|
572
653
|
*/
|
|
573
654
|
environmentVariables?: Record<string, string>;
|
|
574
655
|
/**
|
|
656
|
+
* @public
|
|
575
657
|
* <p> The basic authorization credentials for the branch. You must base64-encode the
|
|
576
658
|
* authorization credentials and provide them in the format
|
|
577
659
|
* <code>user:password</code>.</p>
|
|
578
660
|
*/
|
|
579
661
|
basicAuthCredentials?: string;
|
|
580
662
|
/**
|
|
663
|
+
* @public
|
|
581
664
|
* <p> Enables basic authorization for the branch. </p>
|
|
582
665
|
*/
|
|
583
666
|
enableBasicAuth?: boolean;
|
|
584
667
|
/**
|
|
668
|
+
* @public
|
|
585
669
|
* <p>Enables performance mode for the branch.</p>
|
|
586
670
|
* <p>Performance mode optimizes for faster hosting performance by keeping content cached at
|
|
587
671
|
* the edge for a longer interval. When performance mode is enabled, hosting configuration
|
|
@@ -589,30 +673,37 @@ export interface CreateBranchRequest {
|
|
|
589
673
|
*/
|
|
590
674
|
enablePerformanceMode?: boolean;
|
|
591
675
|
/**
|
|
676
|
+
* @public
|
|
592
677
|
* <p> The tag for the branch. </p>
|
|
593
678
|
*/
|
|
594
679
|
tags?: Record<string, string>;
|
|
595
680
|
/**
|
|
681
|
+
* @public
|
|
596
682
|
* <p> The build specification (build spec) for the branch. </p>
|
|
597
683
|
*/
|
|
598
684
|
buildSpec?: string;
|
|
599
685
|
/**
|
|
686
|
+
* @public
|
|
600
687
|
* <p> The content Time To Live (TTL) for the website in seconds. </p>
|
|
601
688
|
*/
|
|
602
689
|
ttl?: string;
|
|
603
690
|
/**
|
|
691
|
+
* @public
|
|
604
692
|
* <p> The display name for a branch. This is used as the default domain prefix. </p>
|
|
605
693
|
*/
|
|
606
694
|
displayName?: string;
|
|
607
695
|
/**
|
|
696
|
+
* @public
|
|
608
697
|
* <p> Enables pull request previews for this branch. </p>
|
|
609
698
|
*/
|
|
610
699
|
enablePullRequestPreview?: boolean;
|
|
611
700
|
/**
|
|
701
|
+
* @public
|
|
612
702
|
* <p> The Amplify environment name for the pull request. </p>
|
|
613
703
|
*/
|
|
614
704
|
pullRequestEnvironmentName?: string;
|
|
615
705
|
/**
|
|
706
|
+
* @public
|
|
616
707
|
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
|
|
617
708
|
* app. </p>
|
|
618
709
|
*/
|
|
@@ -624,70 +715,87 @@ export interface CreateBranchRequest {
|
|
|
624
715
|
*/
|
|
625
716
|
export interface Branch {
|
|
626
717
|
/**
|
|
718
|
+
* @public
|
|
627
719
|
* <p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>
|
|
628
720
|
*/
|
|
629
721
|
branchArn: string | undefined;
|
|
630
722
|
/**
|
|
723
|
+
* @public
|
|
631
724
|
* <p> The name for the branch that is part of an Amplify app. </p>
|
|
632
725
|
*/
|
|
633
726
|
branchName: string | undefined;
|
|
634
727
|
/**
|
|
728
|
+
* @public
|
|
635
729
|
* <p> The description for the branch that is part of an Amplify app. </p>
|
|
636
730
|
*/
|
|
637
731
|
description: string | undefined;
|
|
638
732
|
/**
|
|
733
|
+
* @public
|
|
639
734
|
* <p> The tag for the branch of an Amplify app. </p>
|
|
640
735
|
*/
|
|
641
736
|
tags?: Record<string, string>;
|
|
642
737
|
/**
|
|
738
|
+
* @public
|
|
643
739
|
* <p> The current stage for the branch that is part of an Amplify app. </p>
|
|
644
740
|
*/
|
|
645
741
|
stage: Stage | string | undefined;
|
|
646
742
|
/**
|
|
743
|
+
* @public
|
|
647
744
|
* <p> The display name for the branch. This is used as the default domain prefix. </p>
|
|
648
745
|
*/
|
|
649
746
|
displayName: string | undefined;
|
|
650
747
|
/**
|
|
748
|
+
* @public
|
|
651
749
|
* <p> Enables notifications for a branch that is part of an Amplify app. </p>
|
|
652
750
|
*/
|
|
653
751
|
enableNotification: boolean | undefined;
|
|
654
752
|
/**
|
|
753
|
+
* @public
|
|
655
754
|
* <p> The creation date and time for a branch that is part of an Amplify app. </p>
|
|
656
755
|
*/
|
|
657
756
|
createTime: Date | undefined;
|
|
658
757
|
/**
|
|
758
|
+
* @public
|
|
659
759
|
* <p> The last updated date and time for a branch that is part of an Amplify app. </p>
|
|
660
760
|
*/
|
|
661
761
|
updateTime: Date | undefined;
|
|
662
762
|
/**
|
|
763
|
+
* @public
|
|
663
764
|
* <p> The environment variables specific to a branch of an Amplify app. </p>
|
|
664
765
|
*/
|
|
665
766
|
environmentVariables: Record<string, string> | undefined;
|
|
666
767
|
/**
|
|
768
|
+
* @public
|
|
667
769
|
* <p> Enables auto-building on push for a branch of an Amplify app. </p>
|
|
668
770
|
*/
|
|
669
771
|
enableAutoBuild: boolean | undefined;
|
|
670
772
|
/**
|
|
773
|
+
* @public
|
|
671
774
|
* <p> The custom domains for a branch of an Amplify app. </p>
|
|
672
775
|
*/
|
|
673
776
|
customDomains: string[] | undefined;
|
|
674
777
|
/**
|
|
778
|
+
* @public
|
|
675
779
|
* <p> The framework for a branch of an Amplify app. </p>
|
|
676
780
|
*/
|
|
677
781
|
framework: string | undefined;
|
|
678
782
|
/**
|
|
783
|
+
* @public
|
|
679
784
|
* <p> The ID of the active job for a branch of an Amplify app. </p>
|
|
680
785
|
*/
|
|
681
786
|
activeJobId: string | undefined;
|
|
682
787
|
/**
|
|
788
|
+
* @public
|
|
683
789
|
* <p> The total number of jobs that are part of an Amplify app. </p>
|
|
684
790
|
*/
|
|
685
791
|
totalNumberOfJobs: string | undefined;
|
|
686
792
|
/**
|
|
793
|
+
* @public
|
|
687
794
|
* <p> Enables basic authorization for a branch of an Amplify app. </p>
|
|
688
795
|
*/
|
|
689
796
|
enableBasicAuth: boolean | undefined;
|
|
690
797
|
/**
|
|
798
|
+
* @public
|
|
691
799
|
* <p>Enables performance mode for the branch.</p>
|
|
692
800
|
* <p>Performance mode optimizes for faster hosting performance by keeping content cached at
|
|
693
801
|
* the edge for a longer interval. When performance mode is enabled, hosting configuration
|
|
@@ -695,45 +803,55 @@ export interface Branch {
|
|
|
695
803
|
*/
|
|
696
804
|
enablePerformanceMode?: boolean;
|
|
697
805
|
/**
|
|
806
|
+
* @public
|
|
698
807
|
* <p> The thumbnail URL for the branch of an Amplify app. </p>
|
|
699
808
|
*/
|
|
700
809
|
thumbnailUrl?: string;
|
|
701
810
|
/**
|
|
811
|
+
* @public
|
|
702
812
|
* <p> The basic authorization credentials for a branch of an Amplify app. You must
|
|
703
813
|
* base64-encode the authorization credentials and provide them in the format
|
|
704
814
|
* <code>user:password</code>.</p>
|
|
705
815
|
*/
|
|
706
816
|
basicAuthCredentials?: string;
|
|
707
817
|
/**
|
|
818
|
+
* @public
|
|
708
819
|
* <p> The build specification (build spec) content for the branch of an Amplify app.
|
|
709
820
|
* </p>
|
|
710
821
|
*/
|
|
711
822
|
buildSpec?: string;
|
|
712
823
|
/**
|
|
824
|
+
* @public
|
|
713
825
|
* <p> The content Time to Live (TTL) for the website in seconds. </p>
|
|
714
826
|
*/
|
|
715
827
|
ttl: string | undefined;
|
|
716
828
|
/**
|
|
829
|
+
* @public
|
|
717
830
|
* <p> A list of custom resources that are linked to this branch. </p>
|
|
718
831
|
*/
|
|
719
832
|
associatedResources?: string[];
|
|
720
833
|
/**
|
|
834
|
+
* @public
|
|
721
835
|
* <p> Enables pull request previews for the branch. </p>
|
|
722
836
|
*/
|
|
723
837
|
enablePullRequestPreview: boolean | undefined;
|
|
724
838
|
/**
|
|
839
|
+
* @public
|
|
725
840
|
* <p> The Amplify environment name for the pull request. </p>
|
|
726
841
|
*/
|
|
727
842
|
pullRequestEnvironmentName?: string;
|
|
728
843
|
/**
|
|
844
|
+
* @public
|
|
729
845
|
* <p> The destination branch if the branch is a pull request branch. </p>
|
|
730
846
|
*/
|
|
731
847
|
destinationBranch?: string;
|
|
732
848
|
/**
|
|
849
|
+
* @public
|
|
733
850
|
* <p> The source branch if the branch is a pull request branch. </p>
|
|
734
851
|
*/
|
|
735
852
|
sourceBranch?: string;
|
|
736
853
|
/**
|
|
854
|
+
* @public
|
|
737
855
|
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
|
|
738
856
|
* app. </p>
|
|
739
857
|
*/
|
|
@@ -745,6 +863,7 @@ export interface Branch {
|
|
|
745
863
|
*/
|
|
746
864
|
export interface CreateBranchResult {
|
|
747
865
|
/**
|
|
866
|
+
* @public
|
|
748
867
|
* <p> Describes the branch for an Amplify app, which maps to a third-party repository
|
|
749
868
|
* branch. </p>
|
|
750
869
|
*/
|
|
@@ -756,14 +875,17 @@ export interface CreateBranchResult {
|
|
|
756
875
|
*/
|
|
757
876
|
export interface CreateDeploymentRequest {
|
|
758
877
|
/**
|
|
878
|
+
* @public
|
|
759
879
|
* <p> The unique ID for an Amplify app. </p>
|
|
760
880
|
*/
|
|
761
881
|
appId: string | undefined;
|
|
762
882
|
/**
|
|
883
|
+
* @public
|
|
763
884
|
* <p> The name for the branch, for the job. </p>
|
|
764
885
|
*/
|
|
765
886
|
branchName: string | undefined;
|
|
766
887
|
/**
|
|
888
|
+
* @public
|
|
767
889
|
* <p> An optional file map that contains the file name as the key and the file content md5
|
|
768
890
|
* hash as the value. If this argument is provided, the service will generate a unique
|
|
769
891
|
* upload URL per file. Otherwise, the service will only generate a single upload URL for
|
|
@@ -777,15 +899,18 @@ export interface CreateDeploymentRequest {
|
|
|
777
899
|
*/
|
|
778
900
|
export interface CreateDeploymentResult {
|
|
779
901
|
/**
|
|
902
|
+
* @public
|
|
780
903
|
* <p> The job ID for this deployment. will supply to start deployment api. </p>
|
|
781
904
|
*/
|
|
782
905
|
jobId?: string;
|
|
783
906
|
/**
|
|
907
|
+
* @public
|
|
784
908
|
* <p> When the <code>fileMap</code> argument is provided in the request,
|
|
785
909
|
* <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>
|
|
786
910
|
*/
|
|
787
911
|
fileUploadUrls: Record<string, string> | undefined;
|
|
788
912
|
/**
|
|
913
|
+
* @public
|
|
789
914
|
* <p> When the <code>fileMap</code> argument is not provided in the request, this
|
|
790
915
|
* <code>zipUploadUrl</code> is returned. </p>
|
|
791
916
|
*/
|
|
@@ -797,10 +922,12 @@ export interface CreateDeploymentResult {
|
|
|
797
922
|
*/
|
|
798
923
|
export interface SubDomainSetting {
|
|
799
924
|
/**
|
|
925
|
+
* @public
|
|
800
926
|
* <p> The prefix setting for the subdomain. </p>
|
|
801
927
|
*/
|
|
802
928
|
prefix: string | undefined;
|
|
803
929
|
/**
|
|
930
|
+
* @public
|
|
804
931
|
* <p> The branch name setting for the subdomain. </p>
|
|
805
932
|
*/
|
|
806
933
|
branchName: string | undefined;
|
|
@@ -811,26 +938,32 @@ export interface SubDomainSetting {
|
|
|
811
938
|
*/
|
|
812
939
|
export interface CreateDomainAssociationRequest {
|
|
813
940
|
/**
|
|
941
|
+
* @public
|
|
814
942
|
* <p> The unique ID for an Amplify app. </p>
|
|
815
943
|
*/
|
|
816
944
|
appId: string | undefined;
|
|
817
945
|
/**
|
|
946
|
+
* @public
|
|
818
947
|
* <p> The domain name for the domain association. </p>
|
|
819
948
|
*/
|
|
820
949
|
domainName: string | undefined;
|
|
821
950
|
/**
|
|
951
|
+
* @public
|
|
822
952
|
* <p> Enables the automated creation of subdomains for branches. </p>
|
|
823
953
|
*/
|
|
824
954
|
enableAutoSubDomain?: boolean;
|
|
825
955
|
/**
|
|
956
|
+
* @public
|
|
826
957
|
* <p> The setting for the subdomain. </p>
|
|
827
958
|
*/
|
|
828
959
|
subDomainSettings: SubDomainSetting[] | undefined;
|
|
829
960
|
/**
|
|
961
|
+
* @public
|
|
830
962
|
* <p> Sets the branch patterns for automatic subdomain creation. </p>
|
|
831
963
|
*/
|
|
832
964
|
autoSubDomainCreationPatterns?: string[];
|
|
833
965
|
/**
|
|
966
|
+
* @public
|
|
834
967
|
* <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
|
|
835
968
|
* Resource Name (ARN) for automatically creating subdomains. </p>
|
|
836
969
|
*/
|
|
@@ -860,14 +993,17 @@ export type DomainStatus = (typeof DomainStatus)[keyof typeof DomainStatus];
|
|
|
860
993
|
*/
|
|
861
994
|
export interface SubDomain {
|
|
862
995
|
/**
|
|
996
|
+
* @public
|
|
863
997
|
* <p> Describes the settings for the subdomain. </p>
|
|
864
998
|
*/
|
|
865
999
|
subDomainSetting: SubDomainSetting | undefined;
|
|
866
1000
|
/**
|
|
1001
|
+
* @public
|
|
867
1002
|
* <p> The verified status of the subdomain </p>
|
|
868
1003
|
*/
|
|
869
1004
|
verified: boolean | undefined;
|
|
870
1005
|
/**
|
|
1006
|
+
* @public
|
|
871
1007
|
* <p> The DNS record for the subdomain. </p>
|
|
872
1008
|
*/
|
|
873
1009
|
dnsRecord: string | undefined;
|
|
@@ -879,39 +1015,48 @@ export interface SubDomain {
|
|
|
879
1015
|
*/
|
|
880
1016
|
export interface DomainAssociation {
|
|
881
1017
|
/**
|
|
1018
|
+
* @public
|
|
882
1019
|
* <p> The Amazon Resource Name (ARN) for the domain association. </p>
|
|
883
1020
|
*/
|
|
884
1021
|
domainAssociationArn: string | undefined;
|
|
885
1022
|
/**
|
|
1023
|
+
* @public
|
|
886
1024
|
* <p> The name of the domain. </p>
|
|
887
1025
|
*/
|
|
888
1026
|
domainName: string | undefined;
|
|
889
1027
|
/**
|
|
1028
|
+
* @public
|
|
890
1029
|
* <p> Enables the automated creation of subdomains for branches. </p>
|
|
891
1030
|
*/
|
|
892
1031
|
enableAutoSubDomain: boolean | undefined;
|
|
893
1032
|
/**
|
|
1033
|
+
* @public
|
|
894
1034
|
* <p> Sets branch patterns for automatic subdomain creation. </p>
|
|
895
1035
|
*/
|
|
896
1036
|
autoSubDomainCreationPatterns?: string[];
|
|
897
1037
|
/**
|
|
1038
|
+
* @public
|
|
898
1039
|
* <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
|
|
899
1040
|
* Resource Name (ARN) for automatically creating subdomains. </p>
|
|
900
1041
|
*/
|
|
901
1042
|
autoSubDomainIAMRole?: string;
|
|
902
1043
|
/**
|
|
1044
|
+
* @public
|
|
903
1045
|
* <p> The current status of the domain association. </p>
|
|
904
1046
|
*/
|
|
905
1047
|
domainStatus: DomainStatus | string | undefined;
|
|
906
1048
|
/**
|
|
1049
|
+
* @public
|
|
907
1050
|
* <p> The reason for the current status of the domain association. </p>
|
|
908
1051
|
*/
|
|
909
1052
|
statusReason: string | undefined;
|
|
910
1053
|
/**
|
|
1054
|
+
* @public
|
|
911
1055
|
* <p> The DNS record for certificate verification. </p>
|
|
912
1056
|
*/
|
|
913
1057
|
certificateVerificationDNSRecord?: string;
|
|
914
1058
|
/**
|
|
1059
|
+
* @public
|
|
915
1060
|
* <p> The subdomains for the domain association. </p>
|
|
916
1061
|
*/
|
|
917
1062
|
subDomains: SubDomain[] | undefined;
|
|
@@ -922,6 +1067,7 @@ export interface DomainAssociation {
|
|
|
922
1067
|
*/
|
|
923
1068
|
export interface CreateDomainAssociationResult {
|
|
924
1069
|
/**
|
|
1070
|
+
* @public
|
|
925
1071
|
* <p> Describes the structure of a domain association, which associates a custom domain
|
|
926
1072
|
* with an Amplify app. </p>
|
|
927
1073
|
*/
|
|
@@ -933,14 +1079,17 @@ export interface CreateDomainAssociationResult {
|
|
|
933
1079
|
*/
|
|
934
1080
|
export interface CreateWebhookRequest {
|
|
935
1081
|
/**
|
|
1082
|
+
* @public
|
|
936
1083
|
* <p> The unique ID for an Amplify app. </p>
|
|
937
1084
|
*/
|
|
938
1085
|
appId: string | undefined;
|
|
939
1086
|
/**
|
|
1087
|
+
* @public
|
|
940
1088
|
* <p> The name for a branch that is part of an Amplify app. </p>
|
|
941
1089
|
*/
|
|
942
1090
|
branchName: string | undefined;
|
|
943
1091
|
/**
|
|
1092
|
+
* @public
|
|
944
1093
|
* <p> The description for a webhook. </p>
|
|
945
1094
|
*/
|
|
946
1095
|
description?: string;
|
|
@@ -951,30 +1100,37 @@ export interface CreateWebhookRequest {
|
|
|
951
1100
|
*/
|
|
952
1101
|
export interface Webhook {
|
|
953
1102
|
/**
|
|
1103
|
+
* @public
|
|
954
1104
|
* <p> The Amazon Resource Name (ARN) for the webhook. </p>
|
|
955
1105
|
*/
|
|
956
1106
|
webhookArn: string | undefined;
|
|
957
1107
|
/**
|
|
1108
|
+
* @public
|
|
958
1109
|
* <p> The ID of the webhook. </p>
|
|
959
1110
|
*/
|
|
960
1111
|
webhookId: string | undefined;
|
|
961
1112
|
/**
|
|
1113
|
+
* @public
|
|
962
1114
|
* <p> The URL of the webhook. </p>
|
|
963
1115
|
*/
|
|
964
1116
|
webhookUrl: string | undefined;
|
|
965
1117
|
/**
|
|
1118
|
+
* @public
|
|
966
1119
|
* <p> The name for a branch that is part of an Amplify app. </p>
|
|
967
1120
|
*/
|
|
968
1121
|
branchName: string | undefined;
|
|
969
1122
|
/**
|
|
1123
|
+
* @public
|
|
970
1124
|
* <p> The description for a webhook. </p>
|
|
971
1125
|
*/
|
|
972
1126
|
description: string | undefined;
|
|
973
1127
|
/**
|
|
1128
|
+
* @public
|
|
974
1129
|
* <p> The create date and time for a webhook. </p>
|
|
975
1130
|
*/
|
|
976
1131
|
createTime: Date | undefined;
|
|
977
1132
|
/**
|
|
1133
|
+
* @public
|
|
978
1134
|
* <p> Updates the date and time for a webhook. </p>
|
|
979
1135
|
*/
|
|
980
1136
|
updateTime: Date | undefined;
|
|
@@ -985,6 +1141,7 @@ export interface Webhook {
|
|
|
985
1141
|
*/
|
|
986
1142
|
export interface CreateWebhookResult {
|
|
987
1143
|
/**
|
|
1144
|
+
* @public
|
|
988
1145
|
* <p> Describes a webhook that connects repository events to an Amplify app. </p>
|
|
989
1146
|
*/
|
|
990
1147
|
webhook: Webhook | undefined;
|
|
@@ -995,6 +1152,7 @@ export interface CreateWebhookResult {
|
|
|
995
1152
|
*/
|
|
996
1153
|
export interface DeleteAppRequest {
|
|
997
1154
|
/**
|
|
1155
|
+
* @public
|
|
998
1156
|
* <p> The unique ID for an Amplify app. </p>
|
|
999
1157
|
*/
|
|
1000
1158
|
appId: string | undefined;
|
|
@@ -1005,6 +1163,7 @@ export interface DeleteAppRequest {
|
|
|
1005
1163
|
*/
|
|
1006
1164
|
export interface DeleteAppResult {
|
|
1007
1165
|
/**
|
|
1166
|
+
* @public
|
|
1008
1167
|
* <p> Represents the different branches of a repository for building, deploying, and
|
|
1009
1168
|
* hosting an Amplify app. </p>
|
|
1010
1169
|
*/
|
|
@@ -1016,10 +1175,12 @@ export interface DeleteAppResult {
|
|
|
1016
1175
|
*/
|
|
1017
1176
|
export interface DeleteBackendEnvironmentRequest {
|
|
1018
1177
|
/**
|
|
1178
|
+
* @public
|
|
1019
1179
|
* <p> The unique ID of an Amplify app. </p>
|
|
1020
1180
|
*/
|
|
1021
1181
|
appId: string | undefined;
|
|
1022
1182
|
/**
|
|
1183
|
+
* @public
|
|
1023
1184
|
* <p> The name of a backend environment of an Amplify app. </p>
|
|
1024
1185
|
*/
|
|
1025
1186
|
environmentName: string | undefined;
|
|
@@ -1030,6 +1191,7 @@ export interface DeleteBackendEnvironmentRequest {
|
|
|
1030
1191
|
*/
|
|
1031
1192
|
export interface DeleteBackendEnvironmentResult {
|
|
1032
1193
|
/**
|
|
1194
|
+
* @public
|
|
1033
1195
|
* <p> Describes the backend environment for an Amplify app. </p>
|
|
1034
1196
|
*/
|
|
1035
1197
|
backendEnvironment: BackendEnvironment | undefined;
|
|
@@ -1040,10 +1202,12 @@ export interface DeleteBackendEnvironmentResult {
|
|
|
1040
1202
|
*/
|
|
1041
1203
|
export interface DeleteBranchRequest {
|
|
1042
1204
|
/**
|
|
1205
|
+
* @public
|
|
1043
1206
|
* <p> The unique ID for an Amplify app. </p>
|
|
1044
1207
|
*/
|
|
1045
1208
|
appId: string | undefined;
|
|
1046
1209
|
/**
|
|
1210
|
+
* @public
|
|
1047
1211
|
* <p> The name for the branch. </p>
|
|
1048
1212
|
*/
|
|
1049
1213
|
branchName: string | undefined;
|
|
@@ -1054,6 +1218,7 @@ export interface DeleteBranchRequest {
|
|
|
1054
1218
|
*/
|
|
1055
1219
|
export interface DeleteBranchResult {
|
|
1056
1220
|
/**
|
|
1221
|
+
* @public
|
|
1057
1222
|
* <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
|
|
1058
1223
|
*/
|
|
1059
1224
|
branch: Branch | undefined;
|
|
@@ -1064,10 +1229,12 @@ export interface DeleteBranchResult {
|
|
|
1064
1229
|
*/
|
|
1065
1230
|
export interface DeleteDomainAssociationRequest {
|
|
1066
1231
|
/**
|
|
1232
|
+
* @public
|
|
1067
1233
|
* <p> The unique id for an Amplify app. </p>
|
|
1068
1234
|
*/
|
|
1069
1235
|
appId: string | undefined;
|
|
1070
1236
|
/**
|
|
1237
|
+
* @public
|
|
1071
1238
|
* <p> The name of the domain. </p>
|
|
1072
1239
|
*/
|
|
1073
1240
|
domainName: string | undefined;
|
|
@@ -1077,6 +1244,7 @@ export interface DeleteDomainAssociationRequest {
|
|
|
1077
1244
|
*/
|
|
1078
1245
|
export interface DeleteDomainAssociationResult {
|
|
1079
1246
|
/**
|
|
1247
|
+
* @public
|
|
1080
1248
|
* <p> Describes a domain association that associates a custom domain with an Amplify app.
|
|
1081
1249
|
* </p>
|
|
1082
1250
|
*/
|
|
@@ -1088,14 +1256,17 @@ export interface DeleteDomainAssociationResult {
|
|
|
1088
1256
|
*/
|
|
1089
1257
|
export interface DeleteJobRequest {
|
|
1090
1258
|
/**
|
|
1259
|
+
* @public
|
|
1091
1260
|
* <p> The unique ID for an Amplify app. </p>
|
|
1092
1261
|
*/
|
|
1093
1262
|
appId: string | undefined;
|
|
1094
1263
|
/**
|
|
1264
|
+
* @public
|
|
1095
1265
|
* <p> The name for the branch, for the job. </p>
|
|
1096
1266
|
*/
|
|
1097
1267
|
branchName: string | undefined;
|
|
1098
1268
|
/**
|
|
1269
|
+
* @public
|
|
1099
1270
|
* <p> The unique ID for the job. </p>
|
|
1100
1271
|
*/
|
|
1101
1272
|
jobId: string | undefined;
|
|
@@ -1137,38 +1308,47 @@ export type JobStatus = (typeof JobStatus)[keyof typeof JobStatus];
|
|
|
1137
1308
|
*/
|
|
1138
1309
|
export interface JobSummary {
|
|
1139
1310
|
/**
|
|
1311
|
+
* @public
|
|
1140
1312
|
* <p> The Amazon Resource Name (ARN) for the job. </p>
|
|
1141
1313
|
*/
|
|
1142
1314
|
jobArn: string | undefined;
|
|
1143
1315
|
/**
|
|
1316
|
+
* @public
|
|
1144
1317
|
* <p> The unique ID for the job. </p>
|
|
1145
1318
|
*/
|
|
1146
1319
|
jobId: string | undefined;
|
|
1147
1320
|
/**
|
|
1321
|
+
* @public
|
|
1148
1322
|
* <p> The commit ID from a third-party repository provider for the job. </p>
|
|
1149
1323
|
*/
|
|
1150
1324
|
commitId: string | undefined;
|
|
1151
1325
|
/**
|
|
1326
|
+
* @public
|
|
1152
1327
|
* <p> The commit message from a third-party repository provider for the job. </p>
|
|
1153
1328
|
*/
|
|
1154
1329
|
commitMessage: string | undefined;
|
|
1155
1330
|
/**
|
|
1331
|
+
* @public
|
|
1156
1332
|
* <p> The commit date and time for the job. </p>
|
|
1157
1333
|
*/
|
|
1158
1334
|
commitTime: Date | undefined;
|
|
1159
1335
|
/**
|
|
1336
|
+
* @public
|
|
1160
1337
|
* <p> The start date and time for the job. </p>
|
|
1161
1338
|
*/
|
|
1162
1339
|
startTime: Date | undefined;
|
|
1163
1340
|
/**
|
|
1341
|
+
* @public
|
|
1164
1342
|
* <p> The current status for the job. </p>
|
|
1165
1343
|
*/
|
|
1166
1344
|
status: JobStatus | string | undefined;
|
|
1167
1345
|
/**
|
|
1346
|
+
* @public
|
|
1168
1347
|
* <p> The end date and time for the job. </p>
|
|
1169
1348
|
*/
|
|
1170
1349
|
endTime?: Date;
|
|
1171
1350
|
/**
|
|
1351
|
+
* @public
|
|
1172
1352
|
* <p> The type for the job. If the value is <code>RELEASE</code>, the job was manually
|
|
1173
1353
|
* released from its source by using the <code>StartJob</code> API. If the value is
|
|
1174
1354
|
* <code>RETRY</code>, the job was manually retried using the <code>StartJob</code>
|
|
@@ -1183,6 +1363,7 @@ export interface JobSummary {
|
|
|
1183
1363
|
*/
|
|
1184
1364
|
export interface DeleteJobResult {
|
|
1185
1365
|
/**
|
|
1366
|
+
* @public
|
|
1186
1367
|
* <p> Describes the summary for an execution job for an Amplify app. </p>
|
|
1187
1368
|
*/
|
|
1188
1369
|
jobSummary: JobSummary | undefined;
|
|
@@ -1193,6 +1374,7 @@ export interface DeleteJobResult {
|
|
|
1193
1374
|
*/
|
|
1194
1375
|
export interface DeleteWebhookRequest {
|
|
1195
1376
|
/**
|
|
1377
|
+
* @public
|
|
1196
1378
|
* <p> The unique ID for a webhook. </p>
|
|
1197
1379
|
*/
|
|
1198
1380
|
webhookId: string | undefined;
|
|
@@ -1203,6 +1385,7 @@ export interface DeleteWebhookRequest {
|
|
|
1203
1385
|
*/
|
|
1204
1386
|
export interface DeleteWebhookResult {
|
|
1205
1387
|
/**
|
|
1388
|
+
* @public
|
|
1206
1389
|
* <p> Describes a webhook that connects repository events to an Amplify app. </p>
|
|
1207
1390
|
*/
|
|
1208
1391
|
webhook: Webhook | undefined;
|
|
@@ -1213,20 +1396,24 @@ export interface DeleteWebhookResult {
|
|
|
1213
1396
|
*/
|
|
1214
1397
|
export interface GenerateAccessLogsRequest {
|
|
1215
1398
|
/**
|
|
1399
|
+
* @public
|
|
1216
1400
|
* <p> The time at which the logs should start. The time range specified is inclusive of the
|
|
1217
1401
|
* start time. </p>
|
|
1218
1402
|
*/
|
|
1219
1403
|
startTime?: Date;
|
|
1220
1404
|
/**
|
|
1405
|
+
* @public
|
|
1221
1406
|
* <p> The time at which the logs should end. The time range specified is inclusive of the
|
|
1222
1407
|
* end time. </p>
|
|
1223
1408
|
*/
|
|
1224
1409
|
endTime?: Date;
|
|
1225
1410
|
/**
|
|
1411
|
+
* @public
|
|
1226
1412
|
* <p> The name of the domain. </p>
|
|
1227
1413
|
*/
|
|
1228
1414
|
domainName: string | undefined;
|
|
1229
1415
|
/**
|
|
1416
|
+
* @public
|
|
1230
1417
|
* <p> The unique ID for an Amplify app. </p>
|
|
1231
1418
|
*/
|
|
1232
1419
|
appId: string | undefined;
|
|
@@ -1237,6 +1424,7 @@ export interface GenerateAccessLogsRequest {
|
|
|
1237
1424
|
*/
|
|
1238
1425
|
export interface GenerateAccessLogsResult {
|
|
1239
1426
|
/**
|
|
1427
|
+
* @public
|
|
1240
1428
|
* <p> The pre-signed URL for the requested access logs. </p>
|
|
1241
1429
|
*/
|
|
1242
1430
|
logUrl?: string;
|
|
@@ -1247,6 +1435,7 @@ export interface GenerateAccessLogsResult {
|
|
|
1247
1435
|
*/
|
|
1248
1436
|
export interface GetAppRequest {
|
|
1249
1437
|
/**
|
|
1438
|
+
* @public
|
|
1250
1439
|
* <p> The unique ID for an Amplify app. </p>
|
|
1251
1440
|
*/
|
|
1252
1441
|
appId: string | undefined;
|
|
@@ -1256,6 +1445,7 @@ export interface GetAppRequest {
|
|
|
1256
1445
|
*/
|
|
1257
1446
|
export interface GetAppResult {
|
|
1258
1447
|
/**
|
|
1448
|
+
* @public
|
|
1259
1449
|
* <p> Represents the different branches of a repository for building, deploying, and
|
|
1260
1450
|
* hosting an Amplify app. </p>
|
|
1261
1451
|
*/
|
|
@@ -1267,6 +1457,7 @@ export interface GetAppResult {
|
|
|
1267
1457
|
*/
|
|
1268
1458
|
export interface GetArtifactUrlRequest {
|
|
1269
1459
|
/**
|
|
1460
|
+
* @public
|
|
1270
1461
|
* <p> The unique ID for an artifact. </p>
|
|
1271
1462
|
*/
|
|
1272
1463
|
artifactId: string | undefined;
|
|
@@ -1277,10 +1468,12 @@ export interface GetArtifactUrlRequest {
|
|
|
1277
1468
|
*/
|
|
1278
1469
|
export interface GetArtifactUrlResult {
|
|
1279
1470
|
/**
|
|
1471
|
+
* @public
|
|
1280
1472
|
* <p> The unique ID for an artifact. </p>
|
|
1281
1473
|
*/
|
|
1282
1474
|
artifactId: string | undefined;
|
|
1283
1475
|
/**
|
|
1476
|
+
* @public
|
|
1284
1477
|
* <p> The presigned URL for the artifact. </p>
|
|
1285
1478
|
*/
|
|
1286
1479
|
artifactUrl: string | undefined;
|
|
@@ -1291,10 +1484,12 @@ export interface GetArtifactUrlResult {
|
|
|
1291
1484
|
*/
|
|
1292
1485
|
export interface GetBackendEnvironmentRequest {
|
|
1293
1486
|
/**
|
|
1487
|
+
* @public
|
|
1294
1488
|
* <p> The unique id for an Amplify app. </p>
|
|
1295
1489
|
*/
|
|
1296
1490
|
appId: string | undefined;
|
|
1297
1491
|
/**
|
|
1492
|
+
* @public
|
|
1298
1493
|
* <p> The name for the backend environment. </p>
|
|
1299
1494
|
*/
|
|
1300
1495
|
environmentName: string | undefined;
|
|
@@ -1305,6 +1500,7 @@ export interface GetBackendEnvironmentRequest {
|
|
|
1305
1500
|
*/
|
|
1306
1501
|
export interface GetBackendEnvironmentResult {
|
|
1307
1502
|
/**
|
|
1503
|
+
* @public
|
|
1308
1504
|
* <p> Describes the backend environment for an Amplify app. </p>
|
|
1309
1505
|
*/
|
|
1310
1506
|
backendEnvironment: BackendEnvironment | undefined;
|
|
@@ -1315,10 +1511,12 @@ export interface GetBackendEnvironmentResult {
|
|
|
1315
1511
|
*/
|
|
1316
1512
|
export interface GetBranchRequest {
|
|
1317
1513
|
/**
|
|
1514
|
+
* @public
|
|
1318
1515
|
* <p> The unique ID for an Amplify app. </p>
|
|
1319
1516
|
*/
|
|
1320
1517
|
appId: string | undefined;
|
|
1321
1518
|
/**
|
|
1519
|
+
* @public
|
|
1322
1520
|
* <p> The name for the branch. </p>
|
|
1323
1521
|
*/
|
|
1324
1522
|
branchName: string | undefined;
|
|
@@ -1328,6 +1526,7 @@ export interface GetBranchRequest {
|
|
|
1328
1526
|
*/
|
|
1329
1527
|
export interface GetBranchResult {
|
|
1330
1528
|
/**
|
|
1529
|
+
* @public
|
|
1331
1530
|
* <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
|
|
1332
1531
|
*/
|
|
1333
1532
|
branch: Branch | undefined;
|
|
@@ -1338,10 +1537,12 @@ export interface GetBranchResult {
|
|
|
1338
1537
|
*/
|
|
1339
1538
|
export interface GetDomainAssociationRequest {
|
|
1340
1539
|
/**
|
|
1540
|
+
* @public
|
|
1341
1541
|
* <p> The unique id for an Amplify app. </p>
|
|
1342
1542
|
*/
|
|
1343
1543
|
appId: string | undefined;
|
|
1344
1544
|
/**
|
|
1545
|
+
* @public
|
|
1345
1546
|
* <p> The name of the domain. </p>
|
|
1346
1547
|
*/
|
|
1347
1548
|
domainName: string | undefined;
|
|
@@ -1352,6 +1553,7 @@ export interface GetDomainAssociationRequest {
|
|
|
1352
1553
|
*/
|
|
1353
1554
|
export interface GetDomainAssociationResult {
|
|
1354
1555
|
/**
|
|
1556
|
+
* @public
|
|
1355
1557
|
* <p> Describes the structure of a domain association, which associates a custom domain
|
|
1356
1558
|
* with an Amplify app. </p>
|
|
1357
1559
|
*/
|
|
@@ -1363,14 +1565,17 @@ export interface GetDomainAssociationResult {
|
|
|
1363
1565
|
*/
|
|
1364
1566
|
export interface GetJobRequest {
|
|
1365
1567
|
/**
|
|
1568
|
+
* @public
|
|
1366
1569
|
* <p> The unique ID for an Amplify app. </p>
|
|
1367
1570
|
*/
|
|
1368
1571
|
appId: string | undefined;
|
|
1369
1572
|
/**
|
|
1573
|
+
* @public
|
|
1370
1574
|
* <p> The branch name for the job. </p>
|
|
1371
1575
|
*/
|
|
1372
1576
|
branchName: string | undefined;
|
|
1373
1577
|
/**
|
|
1578
|
+
* @public
|
|
1374
1579
|
* <p> The unique ID for the job. </p>
|
|
1375
1580
|
*/
|
|
1376
1581
|
jobId: string | undefined;
|
|
@@ -1381,46 +1586,57 @@ export interface GetJobRequest {
|
|
|
1381
1586
|
*/
|
|
1382
1587
|
export interface Step {
|
|
1383
1588
|
/**
|
|
1589
|
+
* @public
|
|
1384
1590
|
* <p> The name of the execution step. </p>
|
|
1385
1591
|
*/
|
|
1386
1592
|
stepName: string | undefined;
|
|
1387
1593
|
/**
|
|
1594
|
+
* @public
|
|
1388
1595
|
* <p> The start date and time of the execution step. </p>
|
|
1389
1596
|
*/
|
|
1390
1597
|
startTime: Date | undefined;
|
|
1391
1598
|
/**
|
|
1599
|
+
* @public
|
|
1392
1600
|
* <p> The status of the execution step. </p>
|
|
1393
1601
|
*/
|
|
1394
1602
|
status: JobStatus | string | undefined;
|
|
1395
1603
|
/**
|
|
1604
|
+
* @public
|
|
1396
1605
|
* <p> The end date and time of the execution step. </p>
|
|
1397
1606
|
*/
|
|
1398
1607
|
endTime: Date | undefined;
|
|
1399
1608
|
/**
|
|
1609
|
+
* @public
|
|
1400
1610
|
* <p> The URL to the logs for the execution step. </p>
|
|
1401
1611
|
*/
|
|
1402
1612
|
logUrl?: string;
|
|
1403
1613
|
/**
|
|
1614
|
+
* @public
|
|
1404
1615
|
* <p> The URL to the artifact for the execution step. </p>
|
|
1405
1616
|
*/
|
|
1406
1617
|
artifactsUrl?: string;
|
|
1407
1618
|
/**
|
|
1619
|
+
* @public
|
|
1408
1620
|
* <p> The URL to the test artifact for the execution step. </p>
|
|
1409
1621
|
*/
|
|
1410
1622
|
testArtifactsUrl?: string;
|
|
1411
1623
|
/**
|
|
1624
|
+
* @public
|
|
1412
1625
|
* <p> The URL to the test configuration for the execution step. </p>
|
|
1413
1626
|
*/
|
|
1414
1627
|
testConfigUrl?: string;
|
|
1415
1628
|
/**
|
|
1629
|
+
* @public
|
|
1416
1630
|
* <p> The list of screenshot URLs for the execution step, if relevant. </p>
|
|
1417
1631
|
*/
|
|
1418
1632
|
screenshots?: Record<string, string>;
|
|
1419
1633
|
/**
|
|
1634
|
+
* @public
|
|
1420
1635
|
* <p> The reason for the current step status. </p>
|
|
1421
1636
|
*/
|
|
1422
1637
|
statusReason?: string;
|
|
1423
1638
|
/**
|
|
1639
|
+
* @public
|
|
1424
1640
|
* <p> The context for the current step. Includes a build image if the step is build.
|
|
1425
1641
|
* </p>
|
|
1426
1642
|
*/
|
|
@@ -1432,10 +1648,12 @@ export interface Step {
|
|
|
1432
1648
|
*/
|
|
1433
1649
|
export interface Job {
|
|
1434
1650
|
/**
|
|
1651
|
+
* @public
|
|
1435
1652
|
* <p> Describes the summary for an execution job for an Amplify app. </p>
|
|
1436
1653
|
*/
|
|
1437
1654
|
summary: JobSummary | undefined;
|
|
1438
1655
|
/**
|
|
1656
|
+
* @public
|
|
1439
1657
|
* <p> The execution steps for an execution job, for an Amplify app. </p>
|
|
1440
1658
|
*/
|
|
1441
1659
|
steps: Step[] | undefined;
|
|
@@ -1445,6 +1663,7 @@ export interface Job {
|
|
|
1445
1663
|
*/
|
|
1446
1664
|
export interface GetJobResult {
|
|
1447
1665
|
/**
|
|
1666
|
+
* @public
|
|
1448
1667
|
* <p> Describes an execution job for an Amplify app. </p>
|
|
1449
1668
|
*/
|
|
1450
1669
|
job: Job | undefined;
|
|
@@ -1455,6 +1674,7 @@ export interface GetJobResult {
|
|
|
1455
1674
|
*/
|
|
1456
1675
|
export interface GetWebhookRequest {
|
|
1457
1676
|
/**
|
|
1677
|
+
* @public
|
|
1458
1678
|
* <p> The unique ID for a webhook. </p>
|
|
1459
1679
|
*/
|
|
1460
1680
|
webhookId: string | undefined;
|
|
@@ -1465,6 +1685,7 @@ export interface GetWebhookRequest {
|
|
|
1465
1685
|
*/
|
|
1466
1686
|
export interface GetWebhookResult {
|
|
1467
1687
|
/**
|
|
1688
|
+
* @public
|
|
1468
1689
|
* <p> Describes the structure of a webhook. </p>
|
|
1469
1690
|
*/
|
|
1470
1691
|
webhook: Webhook | undefined;
|
|
@@ -1475,11 +1696,13 @@ export interface GetWebhookResult {
|
|
|
1475
1696
|
*/
|
|
1476
1697
|
export interface ListAppsRequest {
|
|
1477
1698
|
/**
|
|
1699
|
+
* @public
|
|
1478
1700
|
* <p> A pagination token. If non-null, the pagination token is returned in a result. Pass
|
|
1479
1701
|
* its value in another request to retrieve more entries. </p>
|
|
1480
1702
|
*/
|
|
1481
1703
|
nextToken?: string;
|
|
1482
1704
|
/**
|
|
1705
|
+
* @public
|
|
1483
1706
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1484
1707
|
*/
|
|
1485
1708
|
maxResults?: number;
|
|
@@ -1490,10 +1713,12 @@ export interface ListAppsRequest {
|
|
|
1490
1713
|
*/
|
|
1491
1714
|
export interface ListAppsResult {
|
|
1492
1715
|
/**
|
|
1716
|
+
* @public
|
|
1493
1717
|
* <p> A list of Amplify apps. </p>
|
|
1494
1718
|
*/
|
|
1495
1719
|
apps: App[] | undefined;
|
|
1496
1720
|
/**
|
|
1721
|
+
* @public
|
|
1497
1722
|
* <p> A pagination token. Set to null to start listing apps from start. If non-null, the
|
|
1498
1723
|
* pagination token is returned in a result. Pass its value in here to list more projects.
|
|
1499
1724
|
* </p>
|
|
@@ -1506,24 +1731,29 @@ export interface ListAppsResult {
|
|
|
1506
1731
|
*/
|
|
1507
1732
|
export interface ListArtifactsRequest {
|
|
1508
1733
|
/**
|
|
1734
|
+
* @public
|
|
1509
1735
|
* <p> The unique ID for an Amplify app. </p>
|
|
1510
1736
|
*/
|
|
1511
1737
|
appId: string | undefined;
|
|
1512
1738
|
/**
|
|
1739
|
+
* @public
|
|
1513
1740
|
* <p> The name of a branch that is part of an Amplify app. </p>
|
|
1514
1741
|
*/
|
|
1515
1742
|
branchName: string | undefined;
|
|
1516
1743
|
/**
|
|
1744
|
+
* @public
|
|
1517
1745
|
* <p> The unique ID for a job. </p>
|
|
1518
1746
|
*/
|
|
1519
1747
|
jobId: string | undefined;
|
|
1520
1748
|
/**
|
|
1749
|
+
* @public
|
|
1521
1750
|
* <p> A pagination token. Set to null to start listing artifacts from start. If a non-null
|
|
1522
1751
|
* pagination token is returned in a result, pass its value in here to list more artifacts.
|
|
1523
1752
|
* </p>
|
|
1524
1753
|
*/
|
|
1525
1754
|
nextToken?: string;
|
|
1526
1755
|
/**
|
|
1756
|
+
* @public
|
|
1527
1757
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1528
1758
|
*/
|
|
1529
1759
|
maxResults?: number;
|
|
@@ -1534,10 +1764,12 @@ export interface ListArtifactsRequest {
|
|
|
1534
1764
|
*/
|
|
1535
1765
|
export interface Artifact {
|
|
1536
1766
|
/**
|
|
1767
|
+
* @public
|
|
1537
1768
|
* <p> The file name for the artifact. </p>
|
|
1538
1769
|
*/
|
|
1539
1770
|
artifactFileName: string | undefined;
|
|
1540
1771
|
/**
|
|
1772
|
+
* @public
|
|
1541
1773
|
* <p> The unique ID for the artifact. </p>
|
|
1542
1774
|
*/
|
|
1543
1775
|
artifactId: string | undefined;
|
|
@@ -1548,10 +1780,12 @@ export interface Artifact {
|
|
|
1548
1780
|
*/
|
|
1549
1781
|
export interface ListArtifactsResult {
|
|
1550
1782
|
/**
|
|
1783
|
+
* @public
|
|
1551
1784
|
* <p> A list of artifacts. </p>
|
|
1552
1785
|
*/
|
|
1553
1786
|
artifacts: Artifact[] | undefined;
|
|
1554
1787
|
/**
|
|
1788
|
+
* @public
|
|
1555
1789
|
* <p> A pagination token. If a non-null pagination token is returned in a result, pass its
|
|
1556
1790
|
* value in another request to retrieve more entries. </p>
|
|
1557
1791
|
*/
|
|
@@ -1563,20 +1797,24 @@ export interface ListArtifactsResult {
|
|
|
1563
1797
|
*/
|
|
1564
1798
|
export interface ListBackendEnvironmentsRequest {
|
|
1565
1799
|
/**
|
|
1800
|
+
* @public
|
|
1566
1801
|
* <p> The unique ID for an Amplify app. </p>
|
|
1567
1802
|
*/
|
|
1568
1803
|
appId: string | undefined;
|
|
1569
1804
|
/**
|
|
1805
|
+
* @public
|
|
1570
1806
|
* <p> The name of the backend environment </p>
|
|
1571
1807
|
*/
|
|
1572
1808
|
environmentName?: string;
|
|
1573
1809
|
/**
|
|
1810
|
+
* @public
|
|
1574
1811
|
* <p> A pagination token. Set to null to start listing backend environments from the start.
|
|
1575
1812
|
* If a non-null pagination token is returned in a result, pass its value in here to list
|
|
1576
1813
|
* more backend environments. </p>
|
|
1577
1814
|
*/
|
|
1578
1815
|
nextToken?: string;
|
|
1579
1816
|
/**
|
|
1817
|
+
* @public
|
|
1580
1818
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1581
1819
|
*/
|
|
1582
1820
|
maxResults?: number;
|
|
@@ -1587,10 +1825,12 @@ export interface ListBackendEnvironmentsRequest {
|
|
|
1587
1825
|
*/
|
|
1588
1826
|
export interface ListBackendEnvironmentsResult {
|
|
1589
1827
|
/**
|
|
1828
|
+
* @public
|
|
1590
1829
|
* <p> The list of backend environments for an Amplify app. </p>
|
|
1591
1830
|
*/
|
|
1592
1831
|
backendEnvironments: BackendEnvironment[] | undefined;
|
|
1593
1832
|
/**
|
|
1833
|
+
* @public
|
|
1594
1834
|
* <p> A pagination token. If a non-null pagination token is returned in a result, pass its
|
|
1595
1835
|
* value in another request to retrieve more entries. </p>
|
|
1596
1836
|
*/
|
|
@@ -1602,16 +1842,19 @@ export interface ListBackendEnvironmentsResult {
|
|
|
1602
1842
|
*/
|
|
1603
1843
|
export interface ListBranchesRequest {
|
|
1604
1844
|
/**
|
|
1845
|
+
* @public
|
|
1605
1846
|
* <p> The unique ID for an Amplify app. </p>
|
|
1606
1847
|
*/
|
|
1607
1848
|
appId: string | undefined;
|
|
1608
1849
|
/**
|
|
1850
|
+
* @public
|
|
1609
1851
|
* <p> A pagination token. Set to null to start listing branches from the start. If a
|
|
1610
1852
|
* non-null pagination token is returned in a result, pass its value in here to list more
|
|
1611
1853
|
* branches. </p>
|
|
1612
1854
|
*/
|
|
1613
1855
|
nextToken?: string;
|
|
1614
1856
|
/**
|
|
1857
|
+
* @public
|
|
1615
1858
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1616
1859
|
*/
|
|
1617
1860
|
maxResults?: number;
|
|
@@ -1622,10 +1865,12 @@ export interface ListBranchesRequest {
|
|
|
1622
1865
|
*/
|
|
1623
1866
|
export interface ListBranchesResult {
|
|
1624
1867
|
/**
|
|
1868
|
+
* @public
|
|
1625
1869
|
* <p> A list of branches for an Amplify app. </p>
|
|
1626
1870
|
*/
|
|
1627
1871
|
branches: Branch[] | undefined;
|
|
1628
1872
|
/**
|
|
1873
|
+
* @public
|
|
1629
1874
|
* <p> A pagination token. If a non-null pagination token is returned in a result, pass its
|
|
1630
1875
|
* value in another request to retrieve more entries. </p>
|
|
1631
1876
|
*/
|
|
@@ -1637,16 +1882,19 @@ export interface ListBranchesResult {
|
|
|
1637
1882
|
*/
|
|
1638
1883
|
export interface ListDomainAssociationsRequest {
|
|
1639
1884
|
/**
|
|
1885
|
+
* @public
|
|
1640
1886
|
* <p> The unique ID for an Amplify app. </p>
|
|
1641
1887
|
*/
|
|
1642
1888
|
appId: string | undefined;
|
|
1643
1889
|
/**
|
|
1890
|
+
* @public
|
|
1644
1891
|
* <p> A pagination token. Set to null to start listing apps from the start. If non-null, a
|
|
1645
1892
|
* pagination token is returned in a result. Pass its value in here to list more projects.
|
|
1646
1893
|
* </p>
|
|
1647
1894
|
*/
|
|
1648
1895
|
nextToken?: string;
|
|
1649
1896
|
/**
|
|
1897
|
+
* @public
|
|
1650
1898
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1651
1899
|
*/
|
|
1652
1900
|
maxResults?: number;
|
|
@@ -1657,10 +1905,12 @@ export interface ListDomainAssociationsRequest {
|
|
|
1657
1905
|
*/
|
|
1658
1906
|
export interface ListDomainAssociationsResult {
|
|
1659
1907
|
/**
|
|
1908
|
+
* @public
|
|
1660
1909
|
* <p> A list of domain associations. </p>
|
|
1661
1910
|
*/
|
|
1662
1911
|
domainAssociations: DomainAssociation[] | undefined;
|
|
1663
1912
|
/**
|
|
1913
|
+
* @public
|
|
1664
1914
|
* <p> A pagination token. If non-null, a pagination token is returned in a result. Pass its
|
|
1665
1915
|
* value in another request to retrieve more entries. </p>
|
|
1666
1916
|
*/
|
|
@@ -1672,20 +1922,24 @@ export interface ListDomainAssociationsResult {
|
|
|
1672
1922
|
*/
|
|
1673
1923
|
export interface ListJobsRequest {
|
|
1674
1924
|
/**
|
|
1925
|
+
* @public
|
|
1675
1926
|
* <p> The unique ID for an Amplify app. </p>
|
|
1676
1927
|
*/
|
|
1677
1928
|
appId: string | undefined;
|
|
1678
1929
|
/**
|
|
1930
|
+
* @public
|
|
1679
1931
|
* <p> The name for a branch. </p>
|
|
1680
1932
|
*/
|
|
1681
1933
|
branchName: string | undefined;
|
|
1682
1934
|
/**
|
|
1935
|
+
* @public
|
|
1683
1936
|
* <p> A pagination token. Set to null to start listing steps from the start. If a non-null
|
|
1684
1937
|
* pagination token is returned in a result, pass its value in here to list more steps.
|
|
1685
1938
|
* </p>
|
|
1686
1939
|
*/
|
|
1687
1940
|
nextToken?: string;
|
|
1688
1941
|
/**
|
|
1942
|
+
* @public
|
|
1689
1943
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1690
1944
|
*/
|
|
1691
1945
|
maxResults?: number;
|
|
@@ -1696,10 +1950,12 @@ export interface ListJobsRequest {
|
|
|
1696
1950
|
*/
|
|
1697
1951
|
export interface ListJobsResult {
|
|
1698
1952
|
/**
|
|
1953
|
+
* @public
|
|
1699
1954
|
* <p> The result structure for the list job result request. </p>
|
|
1700
1955
|
*/
|
|
1701
1956
|
jobSummaries: JobSummary[] | undefined;
|
|
1702
1957
|
/**
|
|
1958
|
+
* @public
|
|
1703
1959
|
* <p> A pagination token. If non-null the pagination token is returned in a result. Pass
|
|
1704
1960
|
* its value in another request to retrieve more entries. </p>
|
|
1705
1961
|
*/
|
|
@@ -1711,6 +1967,7 @@ export interface ListJobsResult {
|
|
|
1711
1967
|
*/
|
|
1712
1968
|
export interface ListTagsForResourceRequest {
|
|
1713
1969
|
/**
|
|
1970
|
+
* @public
|
|
1714
1971
|
* <p> The Amazon Resource Name (ARN) to use to list tags. </p>
|
|
1715
1972
|
*/
|
|
1716
1973
|
resourceArn: string | undefined;
|
|
@@ -1721,6 +1978,7 @@ export interface ListTagsForResourceRequest {
|
|
|
1721
1978
|
*/
|
|
1722
1979
|
export interface ListTagsForResourceResponse {
|
|
1723
1980
|
/**
|
|
1981
|
+
* @public
|
|
1724
1982
|
* <p> A list of tags for the specified The Amazon Resource Name (ARN). </p>
|
|
1725
1983
|
*/
|
|
1726
1984
|
tags?: Record<string, string>;
|
|
@@ -1744,16 +2002,19 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
1744
2002
|
*/
|
|
1745
2003
|
export interface ListWebhooksRequest {
|
|
1746
2004
|
/**
|
|
2005
|
+
* @public
|
|
1747
2006
|
* <p> The unique ID for an Amplify app. </p>
|
|
1748
2007
|
*/
|
|
1749
2008
|
appId: string | undefined;
|
|
1750
2009
|
/**
|
|
2010
|
+
* @public
|
|
1751
2011
|
* <p> A pagination token. Set to null to start listing webhooks from the start. If
|
|
1752
2012
|
* non-null,the pagination token is returned in a result. Pass its value in here to list
|
|
1753
2013
|
* more webhooks. </p>
|
|
1754
2014
|
*/
|
|
1755
2015
|
nextToken?: string;
|
|
1756
2016
|
/**
|
|
2017
|
+
* @public
|
|
1757
2018
|
* <p> The maximum number of records to list in a single response. </p>
|
|
1758
2019
|
*/
|
|
1759
2020
|
maxResults?: number;
|
|
@@ -1764,10 +2025,12 @@ export interface ListWebhooksRequest {
|
|
|
1764
2025
|
*/
|
|
1765
2026
|
export interface ListWebhooksResult {
|
|
1766
2027
|
/**
|
|
2028
|
+
* @public
|
|
1767
2029
|
* <p> A list of webhooks. </p>
|
|
1768
2030
|
*/
|
|
1769
2031
|
webhooks: Webhook[] | undefined;
|
|
1770
2032
|
/**
|
|
2033
|
+
* @public
|
|
1771
2034
|
* <p> A pagination token. If non-null, the pagination token is returned in a result. Pass
|
|
1772
2035
|
* its value in another request to retrieve more entries. </p>
|
|
1773
2036
|
*/
|
|
@@ -1779,18 +2042,22 @@ export interface ListWebhooksResult {
|
|
|
1779
2042
|
*/
|
|
1780
2043
|
export interface StartDeploymentRequest {
|
|
1781
2044
|
/**
|
|
2045
|
+
* @public
|
|
1782
2046
|
* <p> The unique ID for an Amplify app. </p>
|
|
1783
2047
|
*/
|
|
1784
2048
|
appId: string | undefined;
|
|
1785
2049
|
/**
|
|
2050
|
+
* @public
|
|
1786
2051
|
* <p> The name for the branch, for the job. </p>
|
|
1787
2052
|
*/
|
|
1788
2053
|
branchName: string | undefined;
|
|
1789
2054
|
/**
|
|
2055
|
+
* @public
|
|
1790
2056
|
* <p> The job ID for this deployment, generated by the create deployment request. </p>
|
|
1791
2057
|
*/
|
|
1792
2058
|
jobId?: string;
|
|
1793
2059
|
/**
|
|
2060
|
+
* @public
|
|
1794
2061
|
* <p> The source URL for this deployment, used when calling start deployment without create
|
|
1795
2062
|
* deployment. The source URL can be any HTTP GET URL that is publicly accessible and
|
|
1796
2063
|
* downloads a single .zip file. </p>
|
|
@@ -1803,6 +2070,7 @@ export interface StartDeploymentRequest {
|
|
|
1803
2070
|
*/
|
|
1804
2071
|
export interface StartDeploymentResult {
|
|
1805
2072
|
/**
|
|
2073
|
+
* @public
|
|
1806
2074
|
* <p> The summary for the job. </p>
|
|
1807
2075
|
*/
|
|
1808
2076
|
jobSummary: JobSummary | undefined;
|
|
@@ -1813,19 +2081,23 @@ export interface StartDeploymentResult {
|
|
|
1813
2081
|
*/
|
|
1814
2082
|
export interface StartJobRequest {
|
|
1815
2083
|
/**
|
|
2084
|
+
* @public
|
|
1816
2085
|
* <p> The unique ID for an Amplify app. </p>
|
|
1817
2086
|
*/
|
|
1818
2087
|
appId: string | undefined;
|
|
1819
2088
|
/**
|
|
2089
|
+
* @public
|
|
1820
2090
|
* <p> The branch name for the job. </p>
|
|
1821
2091
|
*/
|
|
1822
2092
|
branchName: string | undefined;
|
|
1823
2093
|
/**
|
|
2094
|
+
* @public
|
|
1824
2095
|
* <p> The unique ID for an existing job. This is required if the value of
|
|
1825
2096
|
* <code>jobType</code> is <code>RETRY</code>. </p>
|
|
1826
2097
|
*/
|
|
1827
2098
|
jobId?: string;
|
|
1828
2099
|
/**
|
|
2100
|
+
* @public
|
|
1829
2101
|
* <p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job
|
|
1830
2102
|
* with the latest change from the specified branch. This value is available only for apps
|
|
1831
2103
|
* that are connected to a repository. The job type <code>RETRY</code> retries an existing
|
|
@@ -1834,18 +2106,22 @@ export interface StartJobRequest {
|
|
|
1834
2106
|
*/
|
|
1835
2107
|
jobType: JobType | string | undefined;
|
|
1836
2108
|
/**
|
|
2109
|
+
* @public
|
|
1837
2110
|
* <p> A descriptive reason for starting this job. </p>
|
|
1838
2111
|
*/
|
|
1839
2112
|
jobReason?: string;
|
|
1840
2113
|
/**
|
|
2114
|
+
* @public
|
|
1841
2115
|
* <p> The commit ID from a third-party repository provider for the job. </p>
|
|
1842
2116
|
*/
|
|
1843
2117
|
commitId?: string;
|
|
1844
2118
|
/**
|
|
2119
|
+
* @public
|
|
1845
2120
|
* <p> The commit message from a third-party repository provider for the job. </p>
|
|
1846
2121
|
*/
|
|
1847
2122
|
commitMessage?: string;
|
|
1848
2123
|
/**
|
|
2124
|
+
* @public
|
|
1849
2125
|
* <p> The commit date and time for the job. </p>
|
|
1850
2126
|
*/
|
|
1851
2127
|
commitTime?: Date;
|
|
@@ -1856,6 +2132,7 @@ export interface StartJobRequest {
|
|
|
1856
2132
|
*/
|
|
1857
2133
|
export interface StartJobResult {
|
|
1858
2134
|
/**
|
|
2135
|
+
* @public
|
|
1859
2136
|
* <p> The summary for the job. </p>
|
|
1860
2137
|
*/
|
|
1861
2138
|
jobSummary: JobSummary | undefined;
|
|
@@ -1866,14 +2143,17 @@ export interface StartJobResult {
|
|
|
1866
2143
|
*/
|
|
1867
2144
|
export interface StopJobRequest {
|
|
1868
2145
|
/**
|
|
2146
|
+
* @public
|
|
1869
2147
|
* <p> The unique ID for an Amplify app. </p>
|
|
1870
2148
|
*/
|
|
1871
2149
|
appId: string | undefined;
|
|
1872
2150
|
/**
|
|
2151
|
+
* @public
|
|
1873
2152
|
* <p> The name for the branch, for the job. </p>
|
|
1874
2153
|
*/
|
|
1875
2154
|
branchName: string | undefined;
|
|
1876
2155
|
/**
|
|
2156
|
+
* @public
|
|
1877
2157
|
* <p> The unique id for the job. </p>
|
|
1878
2158
|
*/
|
|
1879
2159
|
jobId: string | undefined;
|
|
@@ -1884,6 +2164,7 @@ export interface StopJobRequest {
|
|
|
1884
2164
|
*/
|
|
1885
2165
|
export interface StopJobResult {
|
|
1886
2166
|
/**
|
|
2167
|
+
* @public
|
|
1887
2168
|
* <p> The summary for the job. </p>
|
|
1888
2169
|
*/
|
|
1889
2170
|
jobSummary: JobSummary | undefined;
|
|
@@ -1894,10 +2175,12 @@ export interface StopJobResult {
|
|
|
1894
2175
|
*/
|
|
1895
2176
|
export interface TagResourceRequest {
|
|
1896
2177
|
/**
|
|
2178
|
+
* @public
|
|
1897
2179
|
* <p> The Amazon Resource Name (ARN) to use to tag a resource. </p>
|
|
1898
2180
|
*/
|
|
1899
2181
|
resourceArn: string | undefined;
|
|
1900
2182
|
/**
|
|
2183
|
+
* @public
|
|
1901
2184
|
* <p> The tags used to tag the resource. </p>
|
|
1902
2185
|
*/
|
|
1903
2186
|
tags: Record<string, string> | undefined;
|
|
@@ -1914,10 +2197,12 @@ export interface TagResourceResponse {
|
|
|
1914
2197
|
*/
|
|
1915
2198
|
export interface UntagResourceRequest {
|
|
1916
2199
|
/**
|
|
2200
|
+
* @public
|
|
1917
2201
|
* <p> The Amazon Resource Name (ARN) to use to untag a resource. </p>
|
|
1918
2202
|
*/
|
|
1919
2203
|
resourceArn: string | undefined;
|
|
1920
2204
|
/**
|
|
2205
|
+
* @public
|
|
1921
2206
|
* <p> The tag keys to use to untag a resource. </p>
|
|
1922
2207
|
*/
|
|
1923
2208
|
tagKeys: string[] | undefined;
|
|
@@ -1934,18 +2219,22 @@ export interface UntagResourceResponse {
|
|
|
1934
2219
|
*/
|
|
1935
2220
|
export interface UpdateAppRequest {
|
|
1936
2221
|
/**
|
|
2222
|
+
* @public
|
|
1937
2223
|
* <p> The unique ID for an Amplify app. </p>
|
|
1938
2224
|
*/
|
|
1939
2225
|
appId: string | undefined;
|
|
1940
2226
|
/**
|
|
2227
|
+
* @public
|
|
1941
2228
|
* <p> The name for an Amplify app. </p>
|
|
1942
2229
|
*/
|
|
1943
2230
|
name?: string;
|
|
1944
2231
|
/**
|
|
2232
|
+
* @public
|
|
1945
2233
|
* <p> The description for an Amplify app. </p>
|
|
1946
2234
|
*/
|
|
1947
2235
|
description?: string;
|
|
1948
2236
|
/**
|
|
2237
|
+
* @public
|
|
1949
2238
|
* <p> The platform for the Amplify app. For a static app, set the platform type to <code>WEB</code>.
|
|
1950
2239
|
* For a dynamic server-side rendered (SSR) app, set the platform type to
|
|
1951
2240
|
* <code>WEB_COMPUTE</code>. For an app requiring Amplify Hosting's original SSR support only, set the platform type to
|
|
@@ -1953,61 +2242,75 @@ export interface UpdateAppRequest {
|
|
|
1953
2242
|
*/
|
|
1954
2243
|
platform?: Platform | string;
|
|
1955
2244
|
/**
|
|
2245
|
+
* @public
|
|
1956
2246
|
* <p> The AWS Identity and Access Management (IAM) service role for an Amplify app. </p>
|
|
1957
2247
|
*/
|
|
1958
2248
|
iamServiceRoleArn?: string;
|
|
1959
2249
|
/**
|
|
2250
|
+
* @public
|
|
1960
2251
|
* <p> The environment variables for an Amplify app. </p>
|
|
1961
2252
|
*/
|
|
1962
2253
|
environmentVariables?: Record<string, string>;
|
|
1963
2254
|
/**
|
|
2255
|
+
* @public
|
|
1964
2256
|
* <p> Enables branch auto-building for an Amplify app. </p>
|
|
1965
2257
|
*/
|
|
1966
2258
|
enableBranchAutoBuild?: boolean;
|
|
1967
2259
|
/**
|
|
2260
|
+
* @public
|
|
1968
2261
|
* <p> Automatically disconnects a branch in the Amplify Console when you delete a branch
|
|
1969
2262
|
* from your Git repository. </p>
|
|
1970
2263
|
*/
|
|
1971
2264
|
enableBranchAutoDeletion?: boolean;
|
|
1972
2265
|
/**
|
|
2266
|
+
* @public
|
|
1973
2267
|
* <p> Enables basic authorization for an Amplify app. </p>
|
|
1974
2268
|
*/
|
|
1975
2269
|
enableBasicAuth?: boolean;
|
|
1976
2270
|
/**
|
|
2271
|
+
* @public
|
|
1977
2272
|
* <p> The basic authorization credentials for an Amplify app. You must base64-encode the
|
|
1978
2273
|
* authorization credentials and provide them in the format
|
|
1979
2274
|
* <code>user:password</code>.</p>
|
|
1980
2275
|
*/
|
|
1981
2276
|
basicAuthCredentials?: string;
|
|
1982
2277
|
/**
|
|
2278
|
+
* @public
|
|
1983
2279
|
* <p> The custom redirect and rewrite rules for an Amplify app. </p>
|
|
1984
2280
|
*/
|
|
1985
2281
|
customRules?: CustomRule[];
|
|
1986
2282
|
/**
|
|
2283
|
+
* @public
|
|
1987
2284
|
* <p> The build specification (build spec) for an Amplify app. </p>
|
|
1988
2285
|
*/
|
|
1989
2286
|
buildSpec?: string;
|
|
1990
2287
|
/**
|
|
2288
|
+
* @public
|
|
1991
2289
|
* <p>The custom HTTP headers for an Amplify app.</p>
|
|
1992
2290
|
*/
|
|
1993
2291
|
customHeaders?: string;
|
|
1994
2292
|
/**
|
|
2293
|
+
* @public
|
|
1995
2294
|
* <p> Enables automated branch creation for an Amplify app. </p>
|
|
1996
2295
|
*/
|
|
1997
2296
|
enableAutoBranchCreation?: boolean;
|
|
1998
2297
|
/**
|
|
2298
|
+
* @public
|
|
1999
2299
|
* <p> Describes the automated branch creation glob patterns for an Amplify app. </p>
|
|
2000
2300
|
*/
|
|
2001
2301
|
autoBranchCreationPatterns?: string[];
|
|
2002
2302
|
/**
|
|
2303
|
+
* @public
|
|
2003
2304
|
* <p> The automated branch creation configuration for an Amplify app. </p>
|
|
2004
2305
|
*/
|
|
2005
2306
|
autoBranchCreationConfig?: AutoBranchCreationConfig;
|
|
2006
2307
|
/**
|
|
2308
|
+
* @public
|
|
2007
2309
|
* <p> The name of the repository for an Amplify app </p>
|
|
2008
2310
|
*/
|
|
2009
2311
|
repository?: string;
|
|
2010
2312
|
/**
|
|
2313
|
+
* @public
|
|
2011
2314
|
* <p>The OAuth token for a third-party source control system for an Amplify app. The OAuth
|
|
2012
2315
|
* token is used to create a webhook and a read-only deploy key using SSH cloning. The
|
|
2013
2316
|
* OAuth token is not stored.</p>
|
|
@@ -2024,6 +2327,7 @@ export interface UpdateAppRequest {
|
|
|
2024
2327
|
*/
|
|
2025
2328
|
oauthToken?: string;
|
|
2026
2329
|
/**
|
|
2330
|
+
* @public
|
|
2027
2331
|
* <p>The personal access token for a GitHub repository for an Amplify app. The personal
|
|
2028
2332
|
* access token is used to authorize access to a GitHub repository using the Amplify GitHub
|
|
2029
2333
|
* App. The token is not stored.</p>
|
|
@@ -2044,6 +2348,7 @@ export interface UpdateAppRequest {
|
|
|
2044
2348
|
*/
|
|
2045
2349
|
export interface UpdateAppResult {
|
|
2046
2350
|
/**
|
|
2351
|
+
* @public
|
|
2047
2352
|
* <p> Represents the updated Amplify app. </p>
|
|
2048
2353
|
*/
|
|
2049
2354
|
app: App | undefined;
|
|
@@ -2054,48 +2359,59 @@ export interface UpdateAppResult {
|
|
|
2054
2359
|
*/
|
|
2055
2360
|
export interface UpdateBranchRequest {
|
|
2056
2361
|
/**
|
|
2362
|
+
* @public
|
|
2057
2363
|
* <p> The unique ID for an Amplify app. </p>
|
|
2058
2364
|
*/
|
|
2059
2365
|
appId: string | undefined;
|
|
2060
2366
|
/**
|
|
2367
|
+
* @public
|
|
2061
2368
|
* <p> The name for the branch. </p>
|
|
2062
2369
|
*/
|
|
2063
2370
|
branchName: string | undefined;
|
|
2064
2371
|
/**
|
|
2372
|
+
* @public
|
|
2065
2373
|
* <p> The description for the branch. </p>
|
|
2066
2374
|
*/
|
|
2067
2375
|
description?: string;
|
|
2068
2376
|
/**
|
|
2377
|
+
* @public
|
|
2069
2378
|
* <p> The framework for the branch. </p>
|
|
2070
2379
|
*/
|
|
2071
2380
|
framework?: string;
|
|
2072
2381
|
/**
|
|
2382
|
+
* @public
|
|
2073
2383
|
* <p> Describes the current stage for the branch. </p>
|
|
2074
2384
|
*/
|
|
2075
2385
|
stage?: Stage | string;
|
|
2076
2386
|
/**
|
|
2387
|
+
* @public
|
|
2077
2388
|
* <p> Enables notifications for the branch. </p>
|
|
2078
2389
|
*/
|
|
2079
2390
|
enableNotification?: boolean;
|
|
2080
2391
|
/**
|
|
2392
|
+
* @public
|
|
2081
2393
|
* <p> Enables auto building for the branch. </p>
|
|
2082
2394
|
*/
|
|
2083
2395
|
enableAutoBuild?: boolean;
|
|
2084
2396
|
/**
|
|
2397
|
+
* @public
|
|
2085
2398
|
* <p> The environment variables for the branch. </p>
|
|
2086
2399
|
*/
|
|
2087
2400
|
environmentVariables?: Record<string, string>;
|
|
2088
2401
|
/**
|
|
2402
|
+
* @public
|
|
2089
2403
|
* <p> The basic authorization credentials for the branch. You must base64-encode the
|
|
2090
2404
|
* authorization credentials and provide them in the format
|
|
2091
2405
|
* <code>user:password</code>.</p>
|
|
2092
2406
|
*/
|
|
2093
2407
|
basicAuthCredentials?: string;
|
|
2094
2408
|
/**
|
|
2409
|
+
* @public
|
|
2095
2410
|
* <p> Enables basic authorization for the branch. </p>
|
|
2096
2411
|
*/
|
|
2097
2412
|
enableBasicAuth?: boolean;
|
|
2098
2413
|
/**
|
|
2414
|
+
* @public
|
|
2099
2415
|
* <p>Enables performance mode for the branch.</p>
|
|
2100
2416
|
* <p>Performance mode optimizes for faster hosting performance by keeping content cached at
|
|
2101
2417
|
* the edge for a longer interval. When performance mode is enabled, hosting configuration
|
|
@@ -2103,26 +2419,32 @@ export interface UpdateBranchRequest {
|
|
|
2103
2419
|
*/
|
|
2104
2420
|
enablePerformanceMode?: boolean;
|
|
2105
2421
|
/**
|
|
2422
|
+
* @public
|
|
2106
2423
|
* <p> The build specification (build spec) for the branch. </p>
|
|
2107
2424
|
*/
|
|
2108
2425
|
buildSpec?: string;
|
|
2109
2426
|
/**
|
|
2427
|
+
* @public
|
|
2110
2428
|
* <p> The content Time to Live (TTL) for the website in seconds. </p>
|
|
2111
2429
|
*/
|
|
2112
2430
|
ttl?: string;
|
|
2113
2431
|
/**
|
|
2432
|
+
* @public
|
|
2114
2433
|
* <p> The display name for a branch. This is used as the default domain prefix. </p>
|
|
2115
2434
|
*/
|
|
2116
2435
|
displayName?: string;
|
|
2117
2436
|
/**
|
|
2437
|
+
* @public
|
|
2118
2438
|
* <p> Enables pull request previews for this branch. </p>
|
|
2119
2439
|
*/
|
|
2120
2440
|
enablePullRequestPreview?: boolean;
|
|
2121
2441
|
/**
|
|
2442
|
+
* @public
|
|
2122
2443
|
* <p> The Amplify environment name for the pull request. </p>
|
|
2123
2444
|
*/
|
|
2124
2445
|
pullRequestEnvironmentName?: string;
|
|
2125
2446
|
/**
|
|
2447
|
+
* @public
|
|
2126
2448
|
* <p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify
|
|
2127
2449
|
* app. </p>
|
|
2128
2450
|
*/
|
|
@@ -2134,6 +2456,7 @@ export interface UpdateBranchRequest {
|
|
|
2134
2456
|
*/
|
|
2135
2457
|
export interface UpdateBranchResult {
|
|
2136
2458
|
/**
|
|
2459
|
+
* @public
|
|
2137
2460
|
* <p> The branch for an Amplify app, which maps to a third-party repository branch. </p>
|
|
2138
2461
|
*/
|
|
2139
2462
|
branch: Branch | undefined;
|
|
@@ -2144,26 +2467,32 @@ export interface UpdateBranchResult {
|
|
|
2144
2467
|
*/
|
|
2145
2468
|
export interface UpdateDomainAssociationRequest {
|
|
2146
2469
|
/**
|
|
2470
|
+
* @public
|
|
2147
2471
|
* <p> The unique ID for an Amplify app. </p>
|
|
2148
2472
|
*/
|
|
2149
2473
|
appId: string | undefined;
|
|
2150
2474
|
/**
|
|
2475
|
+
* @public
|
|
2151
2476
|
* <p> The name of the domain. </p>
|
|
2152
2477
|
*/
|
|
2153
2478
|
domainName: string | undefined;
|
|
2154
2479
|
/**
|
|
2480
|
+
* @public
|
|
2155
2481
|
* <p> Enables the automated creation of subdomains for branches. </p>
|
|
2156
2482
|
*/
|
|
2157
2483
|
enableAutoSubDomain?: boolean;
|
|
2158
2484
|
/**
|
|
2485
|
+
* @public
|
|
2159
2486
|
* <p> Describes the settings for the subdomain. </p>
|
|
2160
2487
|
*/
|
|
2161
2488
|
subDomainSettings?: SubDomainSetting[];
|
|
2162
2489
|
/**
|
|
2490
|
+
* @public
|
|
2163
2491
|
* <p> Sets the branch patterns for automatic subdomain creation. </p>
|
|
2164
2492
|
*/
|
|
2165
2493
|
autoSubDomainCreationPatterns?: string[];
|
|
2166
2494
|
/**
|
|
2495
|
+
* @public
|
|
2167
2496
|
* <p> The required AWS Identity and Access Management (IAM) service role for the Amazon
|
|
2168
2497
|
* Resource Name (ARN) for automatically creating subdomains. </p>
|
|
2169
2498
|
*/
|
|
@@ -2175,6 +2504,7 @@ export interface UpdateDomainAssociationRequest {
|
|
|
2175
2504
|
*/
|
|
2176
2505
|
export interface UpdateDomainAssociationResult {
|
|
2177
2506
|
/**
|
|
2507
|
+
* @public
|
|
2178
2508
|
* <p> Describes a domain association, which associates a custom domain with an Amplify app.
|
|
2179
2509
|
* </p>
|
|
2180
2510
|
*/
|
|
@@ -2186,14 +2516,17 @@ export interface UpdateDomainAssociationResult {
|
|
|
2186
2516
|
*/
|
|
2187
2517
|
export interface UpdateWebhookRequest {
|
|
2188
2518
|
/**
|
|
2519
|
+
* @public
|
|
2189
2520
|
* <p> The unique ID for a webhook. </p>
|
|
2190
2521
|
*/
|
|
2191
2522
|
webhookId: string | undefined;
|
|
2192
2523
|
/**
|
|
2524
|
+
* @public
|
|
2193
2525
|
* <p> The name for a branch that is part of an Amplify app. </p>
|
|
2194
2526
|
*/
|
|
2195
2527
|
branchName?: string;
|
|
2196
2528
|
/**
|
|
2529
|
+
* @public
|
|
2197
2530
|
* <p> The description for a webhook. </p>
|
|
2198
2531
|
*/
|
|
2199
2532
|
description?: string;
|
|
@@ -2204,6 +2537,7 @@ export interface UpdateWebhookRequest {
|
|
|
2204
2537
|
*/
|
|
2205
2538
|
export interface UpdateWebhookResult {
|
|
2206
2539
|
/**
|
|
2540
|
+
* @public
|
|
2207
2541
|
* <p> Describes a webhook that connects repository events to an Amplify app. </p>
|
|
2208
2542
|
*/
|
|
2209
2543
|
webhook: Webhook | undefined;
|