@aws-sdk/client-amplifyuibuilder 3.381.0 → 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 +448 -0
- package/package.json +5 -5
|
@@ -7,10 +7,12 @@ import { AmplifyUIBuilderServiceException as __BaseException } from "./AmplifyUI
|
|
|
7
7
|
*/
|
|
8
8
|
export interface ComponentPropertyBindingProperties {
|
|
9
9
|
/**
|
|
10
|
+
* @public
|
|
10
11
|
* <p>The component property to bind to the data field.</p>
|
|
11
12
|
*/
|
|
12
13
|
property: string | undefined;
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>The data field to bind the property to.</p>
|
|
15
17
|
*/
|
|
16
18
|
field?: string;
|
|
@@ -21,10 +23,12 @@ export interface ComponentPropertyBindingProperties {
|
|
|
21
23
|
*/
|
|
22
24
|
export interface FormBindingElement {
|
|
23
25
|
/**
|
|
26
|
+
* @public
|
|
24
27
|
* <p>The name of the component to retrieve a value from.</p>
|
|
25
28
|
*/
|
|
26
29
|
element: string | undefined;
|
|
27
30
|
/**
|
|
31
|
+
* @public
|
|
28
32
|
* <p>The property to retrieve a value from.</p>
|
|
29
33
|
*/
|
|
30
34
|
property: string | undefined;
|
|
@@ -34,14 +38,17 @@ export interface FormBindingElement {
|
|
|
34
38
|
*/
|
|
35
39
|
export interface GetCodegenJobRequest {
|
|
36
40
|
/**
|
|
41
|
+
* @public
|
|
37
42
|
* <p>The unique ID of the Amplify app associated with the code generation job.</p>
|
|
38
43
|
*/
|
|
39
44
|
appId: string | undefined;
|
|
40
45
|
/**
|
|
46
|
+
* @public
|
|
41
47
|
* <p>The name of the backend environment that is a part of the Amplify app associated with the code generation job.</p>
|
|
42
48
|
*/
|
|
43
49
|
environmentName: string | undefined;
|
|
44
50
|
/**
|
|
51
|
+
* @public
|
|
45
52
|
* <p>The unique ID of the code generation job.</p>
|
|
46
53
|
*/
|
|
47
54
|
id: string | undefined;
|
|
@@ -52,6 +59,7 @@ export interface GetCodegenJobRequest {
|
|
|
52
59
|
*/
|
|
53
60
|
export interface CodegenJobAsset {
|
|
54
61
|
/**
|
|
62
|
+
* @public
|
|
55
63
|
* <p>The URL to use to access the asset.</p>
|
|
56
64
|
*/
|
|
57
65
|
downloadUrl?: string;
|
|
@@ -62,10 +70,12 @@ export interface CodegenJobAsset {
|
|
|
62
70
|
*/
|
|
63
71
|
export interface CodegenFeatureFlags {
|
|
64
72
|
/**
|
|
73
|
+
* @public
|
|
65
74
|
* <p>Specifes whether a code generation job supports data relationships.</p>
|
|
66
75
|
*/
|
|
67
76
|
isRelationshipSupported?: boolean;
|
|
68
77
|
/**
|
|
78
|
+
* @public
|
|
69
79
|
* <p>Specifies whether a code generation job supports non models.</p>
|
|
70
80
|
*/
|
|
71
81
|
isNonModelSupported?: boolean;
|
|
@@ -87,6 +97,7 @@ export type CodegenJobGenericDataSourceType = (typeof CodegenJobGenericDataSourc
|
|
|
87
97
|
*/
|
|
88
98
|
export interface CodegenGenericDataEnum {
|
|
89
99
|
/**
|
|
100
|
+
* @public
|
|
90
101
|
* <p>The list of enum values in the generic data schema.</p>
|
|
91
102
|
*/
|
|
92
103
|
values: string[] | undefined;
|
|
@@ -137,38 +148,47 @@ export type GenericDataRelationshipType = (typeof GenericDataRelationshipType)[k
|
|
|
137
148
|
*/
|
|
138
149
|
export interface CodegenGenericDataRelationshipType {
|
|
139
150
|
/**
|
|
151
|
+
* @public
|
|
140
152
|
* <p>The data relationship type.</p>
|
|
141
153
|
*/
|
|
142
154
|
type: GenericDataRelationshipType | string | undefined;
|
|
143
155
|
/**
|
|
156
|
+
* @public
|
|
144
157
|
* <p>The name of the related model in the data relationship.</p>
|
|
145
158
|
*/
|
|
146
159
|
relatedModelName: string | undefined;
|
|
147
160
|
/**
|
|
161
|
+
* @public
|
|
148
162
|
* <p>The related model fields in the data relationship.</p>
|
|
149
163
|
*/
|
|
150
164
|
relatedModelFields?: string[];
|
|
151
165
|
/**
|
|
166
|
+
* @public
|
|
152
167
|
* <p>Specifies whether the relationship can unlink the associated model.</p>
|
|
153
168
|
*/
|
|
154
169
|
canUnlinkAssociatedModel?: boolean;
|
|
155
170
|
/**
|
|
171
|
+
* @public
|
|
156
172
|
* <p>The name of the related join field in the data relationship.</p>
|
|
157
173
|
*/
|
|
158
174
|
relatedJoinFieldName?: string;
|
|
159
175
|
/**
|
|
176
|
+
* @public
|
|
160
177
|
* <p>The name of the related join table in the data relationship.</p>
|
|
161
178
|
*/
|
|
162
179
|
relatedJoinTableName?: string;
|
|
163
180
|
/**
|
|
181
|
+
* @public
|
|
164
182
|
* <p>The value of the <code>belongsTo</code> field on the related data model. </p>
|
|
165
183
|
*/
|
|
166
184
|
belongsToFieldOnRelatedModel?: string;
|
|
167
185
|
/**
|
|
186
|
+
* @public
|
|
168
187
|
* <p>The associated fields of the data relationship.</p>
|
|
169
188
|
*/
|
|
170
189
|
associatedFields?: string[];
|
|
171
190
|
/**
|
|
191
|
+
* @public
|
|
172
192
|
* <p>Specifies whether the <code>@index</code> directive is supported for a <code>hasMany</code> data relationship.</p>
|
|
173
193
|
*/
|
|
174
194
|
isHasManyIndex?: boolean;
|
|
@@ -179,26 +199,32 @@ export interface CodegenGenericDataRelationshipType {
|
|
|
179
199
|
*/
|
|
180
200
|
export interface CodegenGenericDataField {
|
|
181
201
|
/**
|
|
202
|
+
* @public
|
|
182
203
|
* <p>The data type for the generic data field.</p>
|
|
183
204
|
*/
|
|
184
205
|
dataType: CodegenGenericDataFieldDataType | string | undefined;
|
|
185
206
|
/**
|
|
207
|
+
* @public
|
|
186
208
|
* <p>The value of the data type for the generic data field.</p>
|
|
187
209
|
*/
|
|
188
210
|
dataTypeValue: string | undefined;
|
|
189
211
|
/**
|
|
212
|
+
* @public
|
|
190
213
|
* <p>Specifies whether the generic data field is required.</p>
|
|
191
214
|
*/
|
|
192
215
|
required: boolean | undefined;
|
|
193
216
|
/**
|
|
217
|
+
* @public
|
|
194
218
|
* <p>Specifies whether the generic data field is read-only.</p>
|
|
195
219
|
*/
|
|
196
220
|
readOnly: boolean | undefined;
|
|
197
221
|
/**
|
|
222
|
+
* @public
|
|
198
223
|
* <p>Specifies whether the generic data field is an array.</p>
|
|
199
224
|
*/
|
|
200
225
|
isArray: boolean | undefined;
|
|
201
226
|
/**
|
|
227
|
+
* @public
|
|
202
228
|
* <p>The relationship of the generic data schema.</p>
|
|
203
229
|
*/
|
|
204
230
|
relationship?: CodegenGenericDataRelationshipType;
|
|
@@ -209,14 +235,17 @@ export interface CodegenGenericDataField {
|
|
|
209
235
|
*/
|
|
210
236
|
export interface CodegenGenericDataModel {
|
|
211
237
|
/**
|
|
238
|
+
* @public
|
|
212
239
|
* <p>The fields in the generic data model.</p>
|
|
213
240
|
*/
|
|
214
241
|
fields: Record<string, CodegenGenericDataField> | undefined;
|
|
215
242
|
/**
|
|
243
|
+
* @public
|
|
216
244
|
* <p>Specifies whether the generic data model is a join table.</p>
|
|
217
245
|
*/
|
|
218
246
|
isJoinTable?: boolean;
|
|
219
247
|
/**
|
|
248
|
+
* @public
|
|
220
249
|
* <p>The primary keys of the generic data model.</p>
|
|
221
250
|
*/
|
|
222
251
|
primaryKeys: string[] | undefined;
|
|
@@ -227,6 +256,7 @@ export interface CodegenGenericDataModel {
|
|
|
227
256
|
*/
|
|
228
257
|
export interface CodegenGenericDataNonModel {
|
|
229
258
|
/**
|
|
259
|
+
* @public
|
|
230
260
|
* <p>The fields in a generic data schema non model.</p>
|
|
231
261
|
*/
|
|
232
262
|
fields: Record<string, CodegenGenericDataField> | undefined;
|
|
@@ -237,18 +267,22 @@ export interface CodegenGenericDataNonModel {
|
|
|
237
267
|
*/
|
|
238
268
|
export interface CodegenJobGenericDataSchema {
|
|
239
269
|
/**
|
|
270
|
+
* @public
|
|
240
271
|
* <p>The type of the data source for the schema. Currently, the only valid value is an Amplify <code>DataStore</code>.</p>
|
|
241
272
|
*/
|
|
242
273
|
dataSourceType: CodegenJobGenericDataSourceType | string | undefined;
|
|
243
274
|
/**
|
|
275
|
+
* @public
|
|
244
276
|
* <p>The name of a <code>CodegenGenericDataModel</code>.</p>
|
|
245
277
|
*/
|
|
246
278
|
models: Record<string, CodegenGenericDataModel> | undefined;
|
|
247
279
|
/**
|
|
280
|
+
* @public
|
|
248
281
|
* <p>The name of a <code>CodegenGenericDataEnum</code>.</p>
|
|
249
282
|
*/
|
|
250
283
|
enums: Record<string, CodegenGenericDataEnum> | undefined;
|
|
251
284
|
/**
|
|
285
|
+
* @public
|
|
252
286
|
* <p>The name of a <code>CodegenGenericDataNonModel</code>.</p>
|
|
253
287
|
*/
|
|
254
288
|
nonModels: Record<string, CodegenGenericDataNonModel> | undefined;
|
|
@@ -265,22 +299,27 @@ export interface DataStoreRenderConfig {
|
|
|
265
299
|
*/
|
|
266
300
|
export interface GraphQLRenderConfig {
|
|
267
301
|
/**
|
|
302
|
+
* @public
|
|
268
303
|
* <p>The path to the GraphQL types file, relative to the component output directory.</p>
|
|
269
304
|
*/
|
|
270
305
|
typesFilePath: string | undefined;
|
|
271
306
|
/**
|
|
307
|
+
* @public
|
|
272
308
|
* <p>The path to the GraphQL queries file, relative to the component output directory.</p>
|
|
273
309
|
*/
|
|
274
310
|
queriesFilePath: string | undefined;
|
|
275
311
|
/**
|
|
312
|
+
* @public
|
|
276
313
|
* <p>The path to the GraphQL mutations file, relative to the component output directory.</p>
|
|
277
314
|
*/
|
|
278
315
|
mutationsFilePath: string | undefined;
|
|
279
316
|
/**
|
|
317
|
+
* @public
|
|
280
318
|
* <p>The path to the GraphQL subscriptions file, relative to the component output directory.</p>
|
|
281
319
|
*/
|
|
282
320
|
subscriptionsFilePath: string | undefined;
|
|
283
321
|
/**
|
|
322
|
+
* @public
|
|
284
323
|
* <p>The path to the GraphQL fragments file, relative to the component output directory.</p>
|
|
285
324
|
*/
|
|
286
325
|
fragmentsFilePath: string | undefined;
|
|
@@ -301,6 +340,7 @@ export type ApiConfiguration = ApiConfiguration.DataStoreConfigMember | ApiConfi
|
|
|
301
340
|
*/
|
|
302
341
|
export declare namespace ApiConfiguration {
|
|
303
342
|
/**
|
|
343
|
+
* @public
|
|
304
344
|
* <p>The configuration for an application using GraphQL APIs.</p>
|
|
305
345
|
*/
|
|
306
346
|
interface GraphQLConfigMember {
|
|
@@ -310,6 +350,7 @@ export declare namespace ApiConfiguration {
|
|
|
310
350
|
$unknown?: never;
|
|
311
351
|
}
|
|
312
352
|
/**
|
|
353
|
+
* @public
|
|
313
354
|
* <p>The configuration for an application using DataStore APIs.</p>
|
|
314
355
|
*/
|
|
315
356
|
interface DataStoreConfigMember {
|
|
@@ -319,6 +360,7 @@ export declare namespace ApiConfiguration {
|
|
|
319
360
|
$unknown?: never;
|
|
320
361
|
}
|
|
321
362
|
/**
|
|
363
|
+
* @public
|
|
322
364
|
* <p>The configuration for an application with no API being used.</p>
|
|
323
365
|
*/
|
|
324
366
|
interface NoApiConfigMember {
|
|
@@ -327,6 +369,9 @@ export declare namespace ApiConfiguration {
|
|
|
327
369
|
noApiConfig: NoApiRenderConfig;
|
|
328
370
|
$unknown?: never;
|
|
329
371
|
}
|
|
372
|
+
/**
|
|
373
|
+
* @public
|
|
374
|
+
*/
|
|
330
375
|
interface $UnknownMember {
|
|
331
376
|
graphQLConfig?: never;
|
|
332
377
|
dataStoreConfig?: never;
|
|
@@ -384,26 +429,32 @@ export type JSTarget = (typeof JSTarget)[keyof typeof JSTarget];
|
|
|
384
429
|
*/
|
|
385
430
|
export interface ReactStartCodegenJobData {
|
|
386
431
|
/**
|
|
432
|
+
* @public
|
|
387
433
|
* <p>The JavaScript module type.</p>
|
|
388
434
|
*/
|
|
389
435
|
module?: JSModule | string;
|
|
390
436
|
/**
|
|
437
|
+
* @public
|
|
391
438
|
* <p>The ECMAScript specification to use.</p>
|
|
392
439
|
*/
|
|
393
440
|
target?: JSTarget | string;
|
|
394
441
|
/**
|
|
442
|
+
* @public
|
|
395
443
|
* <p>The file type to use for a JavaScript project.</p>
|
|
396
444
|
*/
|
|
397
445
|
script?: JSScript | string;
|
|
398
446
|
/**
|
|
447
|
+
* @public
|
|
399
448
|
* <p>Specifies whether the code generation job should render type declaration files.</p>
|
|
400
449
|
*/
|
|
401
450
|
renderTypeDeclarations?: boolean;
|
|
402
451
|
/**
|
|
452
|
+
* @public
|
|
403
453
|
* <p>Specifies whether the code generation job should render inline source maps.</p>
|
|
404
454
|
*/
|
|
405
455
|
inlineSourceMap?: boolean;
|
|
406
456
|
/**
|
|
457
|
+
* @public
|
|
407
458
|
* <p>The API configuration for the code generation job.</p>
|
|
408
459
|
*/
|
|
409
460
|
apiConfiguration?: ApiConfiguration;
|
|
@@ -418,12 +469,16 @@ export type CodegenJobRenderConfig = CodegenJobRenderConfig.ReactMember | Codege
|
|
|
418
469
|
*/
|
|
419
470
|
export declare namespace CodegenJobRenderConfig {
|
|
420
471
|
/**
|
|
472
|
+
* @public
|
|
421
473
|
* <p>The name of the <code>ReactStartCodegenJobData</code> object.</p>
|
|
422
474
|
*/
|
|
423
475
|
interface ReactMember {
|
|
424
476
|
react: ReactStartCodegenJobData;
|
|
425
477
|
$unknown?: never;
|
|
426
478
|
}
|
|
479
|
+
/**
|
|
480
|
+
* @public
|
|
481
|
+
*/
|
|
427
482
|
interface $UnknownMember {
|
|
428
483
|
react?: never;
|
|
429
484
|
$unknown: [string, any];
|
|
@@ -453,54 +508,67 @@ export type CodegenJobStatus = (typeof CodegenJobStatus)[keyof typeof CodegenJob
|
|
|
453
508
|
*/
|
|
454
509
|
export interface CodegenJob {
|
|
455
510
|
/**
|
|
511
|
+
* @public
|
|
456
512
|
* <p>The unique ID for the code generation job.</p>
|
|
457
513
|
*/
|
|
458
514
|
id: string | undefined;
|
|
459
515
|
/**
|
|
516
|
+
* @public
|
|
460
517
|
* <p>The ID of the Amplify app associated with the code generation job.</p>
|
|
461
518
|
*/
|
|
462
519
|
appId: string | undefined;
|
|
463
520
|
/**
|
|
521
|
+
* @public
|
|
464
522
|
* <p>The name of the backend environment associated with the code generation job.</p>
|
|
465
523
|
*/
|
|
466
524
|
environmentName: string | undefined;
|
|
467
525
|
/**
|
|
526
|
+
* @public
|
|
468
527
|
* <p>Describes the configuration information for rendering the UI component associated with the code generation job.</p>
|
|
469
528
|
*/
|
|
470
529
|
renderConfig?: CodegenJobRenderConfig;
|
|
471
530
|
/**
|
|
531
|
+
* @public
|
|
472
532
|
* <p>Describes the data schema for a code generation job.</p>
|
|
473
533
|
*/
|
|
474
534
|
genericDataSchema?: CodegenJobGenericDataSchema;
|
|
475
535
|
/**
|
|
536
|
+
* @public
|
|
476
537
|
* <p>Specifies whether to autogenerate forms in the code generation job.</p>
|
|
477
538
|
*/
|
|
478
539
|
autoGenerateForms?: boolean;
|
|
479
540
|
/**
|
|
541
|
+
* @public
|
|
480
542
|
* <p>Describes the feature flags that you can specify for a code generation job.</p>
|
|
481
543
|
*/
|
|
482
544
|
features?: CodegenFeatureFlags;
|
|
483
545
|
/**
|
|
546
|
+
* @public
|
|
484
547
|
* <p>The status of the code generation job.</p>
|
|
485
548
|
*/
|
|
486
549
|
status?: CodegenJobStatus | string;
|
|
487
550
|
/**
|
|
551
|
+
* @public
|
|
488
552
|
* <p>The customized status message for the code generation job.</p>
|
|
489
553
|
*/
|
|
490
554
|
statusMessage?: string;
|
|
491
555
|
/**
|
|
556
|
+
* @public
|
|
492
557
|
* <p>The <code>CodegenJobAsset</code> to use for the code generation job.</p>
|
|
493
558
|
*/
|
|
494
559
|
asset?: CodegenJobAsset;
|
|
495
560
|
/**
|
|
561
|
+
* @public
|
|
496
562
|
* <p>One or more key-value pairs to use when tagging the code generation job.</p>
|
|
497
563
|
*/
|
|
498
564
|
tags?: Record<string, string>;
|
|
499
565
|
/**
|
|
566
|
+
* @public
|
|
500
567
|
* <p>The time that the code generation job was created.</p>
|
|
501
568
|
*/
|
|
502
569
|
createdAt?: Date;
|
|
503
570
|
/**
|
|
571
|
+
* @public
|
|
504
572
|
* <p>The time that the code generation job was modified.</p>
|
|
505
573
|
*/
|
|
506
574
|
modifiedAt?: Date;
|
|
@@ -510,6 +578,7 @@ export interface CodegenJob {
|
|
|
510
578
|
*/
|
|
511
579
|
export interface GetCodegenJobResponse {
|
|
512
580
|
/**
|
|
581
|
+
* @public
|
|
513
582
|
* <p>The configuration settings for the code generation job.</p>
|
|
514
583
|
*/
|
|
515
584
|
job?: CodegenJob;
|
|
@@ -567,18 +636,22 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
567
636
|
*/
|
|
568
637
|
export interface ListCodegenJobsRequest {
|
|
569
638
|
/**
|
|
639
|
+
* @public
|
|
570
640
|
* <p>The unique ID for the Amplify app.</p>
|
|
571
641
|
*/
|
|
572
642
|
appId: string | undefined;
|
|
573
643
|
/**
|
|
644
|
+
* @public
|
|
574
645
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
575
646
|
*/
|
|
576
647
|
environmentName: string | undefined;
|
|
577
648
|
/**
|
|
649
|
+
* @public
|
|
578
650
|
* <p>The token to request the next page of results.</p>
|
|
579
651
|
*/
|
|
580
652
|
nextToken?: string;
|
|
581
653
|
/**
|
|
654
|
+
* @public
|
|
582
655
|
* <p>The maximum number of jobs to retrieve.</p>
|
|
583
656
|
*/
|
|
584
657
|
maxResults?: number;
|
|
@@ -589,22 +662,27 @@ export interface ListCodegenJobsRequest {
|
|
|
589
662
|
*/
|
|
590
663
|
export interface CodegenJobSummary {
|
|
591
664
|
/**
|
|
665
|
+
* @public
|
|
592
666
|
* <p>The unique ID of the Amplify app associated with the code generation job.</p>
|
|
593
667
|
*/
|
|
594
668
|
appId: string | undefined;
|
|
595
669
|
/**
|
|
670
|
+
* @public
|
|
596
671
|
* <p>The name of the backend environment associated with the code generation job.</p>
|
|
597
672
|
*/
|
|
598
673
|
environmentName: string | undefined;
|
|
599
674
|
/**
|
|
675
|
+
* @public
|
|
600
676
|
* <p>The unique ID for the code generation job summary.</p>
|
|
601
677
|
*/
|
|
602
678
|
id: string | undefined;
|
|
603
679
|
/**
|
|
680
|
+
* @public
|
|
604
681
|
* <p>The time that the code generation job summary was created.</p>
|
|
605
682
|
*/
|
|
606
683
|
createdAt?: Date;
|
|
607
684
|
/**
|
|
685
|
+
* @public
|
|
608
686
|
* <p>The time that the code generation job summary was modified.</p>
|
|
609
687
|
*/
|
|
610
688
|
modifiedAt?: Date;
|
|
@@ -614,10 +692,12 @@ export interface CodegenJobSummary {
|
|
|
614
692
|
*/
|
|
615
693
|
export interface ListCodegenJobsResponse {
|
|
616
694
|
/**
|
|
695
|
+
* @public
|
|
617
696
|
* <p>The list of code generation jobs for the Amplify app.</p>
|
|
618
697
|
*/
|
|
619
698
|
entities: CodegenJobSummary[] | undefined;
|
|
620
699
|
/**
|
|
700
|
+
* @public
|
|
621
701
|
* <p>The pagination token that's included if more results are available.</p>
|
|
622
702
|
*/
|
|
623
703
|
nextToken?: string;
|
|
@@ -628,22 +708,27 @@ export interface ListCodegenJobsResponse {
|
|
|
628
708
|
*/
|
|
629
709
|
export interface StartCodegenJobData {
|
|
630
710
|
/**
|
|
711
|
+
* @public
|
|
631
712
|
* <p>The code generation configuration for the codegen job.</p>
|
|
632
713
|
*/
|
|
633
714
|
renderConfig: CodegenJobRenderConfig | undefined;
|
|
634
715
|
/**
|
|
716
|
+
* @public
|
|
635
717
|
* <p>The data schema to use for a code generation job.</p>
|
|
636
718
|
*/
|
|
637
719
|
genericDataSchema?: CodegenJobGenericDataSchema;
|
|
638
720
|
/**
|
|
721
|
+
* @public
|
|
639
722
|
* <p>Specifies whether to autogenerate forms in the code generation job.</p>
|
|
640
723
|
*/
|
|
641
724
|
autoGenerateForms?: boolean;
|
|
642
725
|
/**
|
|
726
|
+
* @public
|
|
643
727
|
* <p>The feature flags for a code generation job.</p>
|
|
644
728
|
*/
|
|
645
729
|
features?: CodegenFeatureFlags;
|
|
646
730
|
/**
|
|
731
|
+
* @public
|
|
647
732
|
* <p>One or more key-value pairs to use when tagging the code generation job data.</p>
|
|
648
733
|
*/
|
|
649
734
|
tags?: Record<string, string>;
|
|
@@ -653,18 +738,22 @@ export interface StartCodegenJobData {
|
|
|
653
738
|
*/
|
|
654
739
|
export interface StartCodegenJobRequest {
|
|
655
740
|
/**
|
|
741
|
+
* @public
|
|
656
742
|
* <p>The unique ID for the Amplify app.</p>
|
|
657
743
|
*/
|
|
658
744
|
appId: string | undefined;
|
|
659
745
|
/**
|
|
746
|
+
* @public
|
|
660
747
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
661
748
|
*/
|
|
662
749
|
environmentName: string | undefined;
|
|
663
750
|
/**
|
|
751
|
+
* @public
|
|
664
752
|
* <p>The idempotency token used to ensure that the code generation job request completes only once.</p>
|
|
665
753
|
*/
|
|
666
754
|
clientToken?: string;
|
|
667
755
|
/**
|
|
756
|
+
* @public
|
|
668
757
|
* <p>The code generation job resource configuration.</p>
|
|
669
758
|
*/
|
|
670
759
|
codegenJobToCreate: StartCodegenJobData | undefined;
|
|
@@ -674,6 +763,7 @@ export interface StartCodegenJobRequest {
|
|
|
674
763
|
*/
|
|
675
764
|
export interface StartCodegenJobResponse {
|
|
676
765
|
/**
|
|
766
|
+
* @public
|
|
677
767
|
* <p>The code generation job for a UI component that is associated with an Amplify app.</p>
|
|
678
768
|
*/
|
|
679
769
|
entity?: CodegenJob;
|
|
@@ -688,10 +778,12 @@ export type SortDirection = "ASC" | "DESC";
|
|
|
688
778
|
*/
|
|
689
779
|
export interface SortProperty {
|
|
690
780
|
/**
|
|
781
|
+
* @public
|
|
691
782
|
* <p>The field to perform the sort on.</p>
|
|
692
783
|
*/
|
|
693
784
|
field: string | undefined;
|
|
694
785
|
/**
|
|
786
|
+
* @public
|
|
695
787
|
* <p>The direction of the sort, either ascending or descending.</p>
|
|
696
788
|
*/
|
|
697
789
|
direction: SortDirection | string | undefined;
|
|
@@ -702,11 +794,13 @@ export interface SortProperty {
|
|
|
702
794
|
*/
|
|
703
795
|
export interface ComponentVariant {
|
|
704
796
|
/**
|
|
797
|
+
* @public
|
|
705
798
|
* <p>The combination of variants that comprise this variant. You can't specify
|
|
706
799
|
* <code>tags</code> as a valid property for <code>variantValues</code>.</p>
|
|
707
800
|
*/
|
|
708
801
|
variantValues?: Record<string, string>;
|
|
709
802
|
/**
|
|
803
|
+
* @public
|
|
710
804
|
* <p>The properties of the component variant that can be overriden when customizing an instance
|
|
711
805
|
* of the component. You can't specify <code>tags</code> as a valid property for
|
|
712
806
|
* <code>overrides</code>.</p>
|
|
@@ -743,16 +837,19 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
743
837
|
*/
|
|
744
838
|
export interface DeleteComponentRequest {
|
|
745
839
|
/**
|
|
840
|
+
* @public
|
|
746
841
|
* <p>The unique ID of the Amplify app associated with the component to
|
|
747
842
|
* delete.</p>
|
|
748
843
|
*/
|
|
749
844
|
appId: string | undefined;
|
|
750
845
|
/**
|
|
846
|
+
* @public
|
|
751
847
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
752
848
|
* app.</p>
|
|
753
849
|
*/
|
|
754
850
|
environmentName: string | undefined;
|
|
755
851
|
/**
|
|
852
|
+
* @public
|
|
756
853
|
* <p>The unique ID of the component to delete.</p>
|
|
757
854
|
*/
|
|
758
855
|
id: string | undefined;
|
|
@@ -762,15 +859,18 @@ export interface DeleteComponentRequest {
|
|
|
762
859
|
*/
|
|
763
860
|
export interface ExportComponentsRequest {
|
|
764
861
|
/**
|
|
862
|
+
* @public
|
|
765
863
|
* <p>The unique ID of the Amplify app to export components to.</p>
|
|
766
864
|
*/
|
|
767
865
|
appId: string | undefined;
|
|
768
866
|
/**
|
|
867
|
+
* @public
|
|
769
868
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
770
869
|
* app.</p>
|
|
771
870
|
*/
|
|
772
871
|
environmentName: string | undefined;
|
|
773
872
|
/**
|
|
873
|
+
* @public
|
|
774
874
|
* <p>The token to request the next page of results.</p>
|
|
775
875
|
*/
|
|
776
876
|
nextToken?: string;
|
|
@@ -780,14 +880,17 @@ export interface ExportComponentsRequest {
|
|
|
780
880
|
*/
|
|
781
881
|
export interface GetComponentRequest {
|
|
782
882
|
/**
|
|
883
|
+
* @public
|
|
783
884
|
* <p>The unique ID of the Amplify app.</p>
|
|
784
885
|
*/
|
|
785
886
|
appId: string | undefined;
|
|
786
887
|
/**
|
|
888
|
+
* @public
|
|
787
889
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
788
890
|
*/
|
|
789
891
|
environmentName: string | undefined;
|
|
790
892
|
/**
|
|
893
|
+
* @public
|
|
791
894
|
* <p>The unique ID of the component.</p>
|
|
792
895
|
*/
|
|
793
896
|
id: string | undefined;
|
|
@@ -797,19 +900,23 @@ export interface GetComponentRequest {
|
|
|
797
900
|
*/
|
|
798
901
|
export interface ListComponentsRequest {
|
|
799
902
|
/**
|
|
903
|
+
* @public
|
|
800
904
|
* <p>The unique ID for the Amplify app.</p>
|
|
801
905
|
*/
|
|
802
906
|
appId: string | undefined;
|
|
803
907
|
/**
|
|
908
|
+
* @public
|
|
804
909
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
805
910
|
* app.</p>
|
|
806
911
|
*/
|
|
807
912
|
environmentName: string | undefined;
|
|
808
913
|
/**
|
|
914
|
+
* @public
|
|
809
915
|
* <p>The token to request the next page of results.</p>
|
|
810
916
|
*/
|
|
811
917
|
nextToken?: string;
|
|
812
918
|
/**
|
|
919
|
+
* @public
|
|
813
920
|
* <p>The maximum number of components to retrieve.</p>
|
|
814
921
|
*/
|
|
815
922
|
maxResults?: number;
|
|
@@ -821,23 +928,28 @@ export interface ListComponentsRequest {
|
|
|
821
928
|
*/
|
|
822
929
|
export interface ComponentSummary {
|
|
823
930
|
/**
|
|
931
|
+
* @public
|
|
824
932
|
* <p>The unique ID of the Amplify app associated with the component.</p>
|
|
825
933
|
*/
|
|
826
934
|
appId: string | undefined;
|
|
827
935
|
/**
|
|
936
|
+
* @public
|
|
828
937
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
829
938
|
* app.</p>
|
|
830
939
|
*/
|
|
831
940
|
environmentName: string | undefined;
|
|
832
941
|
/**
|
|
942
|
+
* @public
|
|
833
943
|
* <p>The unique ID of the component.</p>
|
|
834
944
|
*/
|
|
835
945
|
id: string | undefined;
|
|
836
946
|
/**
|
|
947
|
+
* @public
|
|
837
948
|
* <p>The name of the component.</p>
|
|
838
949
|
*/
|
|
839
950
|
name: string | undefined;
|
|
840
951
|
/**
|
|
952
|
+
* @public
|
|
841
953
|
* <p>The component type.</p>
|
|
842
954
|
*/
|
|
843
955
|
componentType: string | undefined;
|
|
@@ -847,10 +959,12 @@ export interface ComponentSummary {
|
|
|
847
959
|
*/
|
|
848
960
|
export interface ListComponentsResponse {
|
|
849
961
|
/**
|
|
962
|
+
* @public
|
|
850
963
|
* <p>The list of components for the Amplify app.</p>
|
|
851
964
|
*/
|
|
852
965
|
entities: ComponentSummary[] | undefined;
|
|
853
966
|
/**
|
|
967
|
+
* @public
|
|
854
968
|
* <p>The pagination token that's included if more results are available.</p>
|
|
855
969
|
*/
|
|
856
970
|
nextToken?: string;
|
|
@@ -875,14 +989,17 @@ export type TokenProviders = (typeof TokenProviders)[keyof typeof TokenProviders
|
|
|
875
989
|
*/
|
|
876
990
|
export interface ExchangeCodeForTokenRequestBody {
|
|
877
991
|
/**
|
|
992
|
+
* @public
|
|
878
993
|
* <p>The access code to send in the request.</p>
|
|
879
994
|
*/
|
|
880
995
|
code: string | undefined;
|
|
881
996
|
/**
|
|
997
|
+
* @public
|
|
882
998
|
* <p>The location of the application that will receive the access code.</p>
|
|
883
999
|
*/
|
|
884
1000
|
redirectUri: string | undefined;
|
|
885
1001
|
/**
|
|
1002
|
+
* @public
|
|
886
1003
|
* <p>The ID of the client to request the token from.</p>
|
|
887
1004
|
*/
|
|
888
1005
|
clientId?: string;
|
|
@@ -892,10 +1009,12 @@ export interface ExchangeCodeForTokenRequestBody {
|
|
|
892
1009
|
*/
|
|
893
1010
|
export interface ExchangeCodeForTokenRequest {
|
|
894
1011
|
/**
|
|
1012
|
+
* @public
|
|
895
1013
|
* <p>The third-party provider for the token. The only valid value is <code>figma</code>.</p>
|
|
896
1014
|
*/
|
|
897
1015
|
provider: TokenProviders | string | undefined;
|
|
898
1016
|
/**
|
|
1017
|
+
* @public
|
|
899
1018
|
* <p>Describes the configuration of the request.</p>
|
|
900
1019
|
*/
|
|
901
1020
|
request: ExchangeCodeForTokenRequestBody | undefined;
|
|
@@ -905,14 +1024,17 @@ export interface ExchangeCodeForTokenRequest {
|
|
|
905
1024
|
*/
|
|
906
1025
|
export interface ExchangeCodeForTokenResponse {
|
|
907
1026
|
/**
|
|
1027
|
+
* @public
|
|
908
1028
|
* <p>The access token.</p>
|
|
909
1029
|
*/
|
|
910
1030
|
accessToken: string | undefined;
|
|
911
1031
|
/**
|
|
1032
|
+
* @public
|
|
912
1033
|
* <p>The date and time when the new access token expires.</p>
|
|
913
1034
|
*/
|
|
914
1035
|
expiresIn: number | undefined;
|
|
915
1036
|
/**
|
|
1037
|
+
* @public
|
|
916
1038
|
* <p>The token to use to refresh a previously issued access token that might have
|
|
917
1039
|
* expired.</p>
|
|
918
1040
|
*/
|
|
@@ -939,6 +1061,7 @@ export type FieldPosition = FieldPosition.BelowMember | FieldPosition.FixedMembe
|
|
|
939
1061
|
*/
|
|
940
1062
|
export declare namespace FieldPosition {
|
|
941
1063
|
/**
|
|
1064
|
+
* @public
|
|
942
1065
|
* <p>The field position is fixed and doesn't change in relation to other fields.</p>
|
|
943
1066
|
*/
|
|
944
1067
|
interface FixedMember {
|
|
@@ -948,6 +1071,7 @@ export declare namespace FieldPosition {
|
|
|
948
1071
|
$unknown?: never;
|
|
949
1072
|
}
|
|
950
1073
|
/**
|
|
1074
|
+
* @public
|
|
951
1075
|
* <p>The field position is to the right of the field specified by the string.</p>
|
|
952
1076
|
*/
|
|
953
1077
|
interface RightOfMember {
|
|
@@ -957,6 +1081,7 @@ export declare namespace FieldPosition {
|
|
|
957
1081
|
$unknown?: never;
|
|
958
1082
|
}
|
|
959
1083
|
/**
|
|
1084
|
+
* @public
|
|
960
1085
|
* <p>The field position is below the field specified by the string.</p>
|
|
961
1086
|
*/
|
|
962
1087
|
interface BelowMember {
|
|
@@ -965,6 +1090,9 @@ export declare namespace FieldPosition {
|
|
|
965
1090
|
below: string;
|
|
966
1091
|
$unknown?: never;
|
|
967
1092
|
}
|
|
1093
|
+
/**
|
|
1094
|
+
* @public
|
|
1095
|
+
*/
|
|
968
1096
|
interface $UnknownMember {
|
|
969
1097
|
fixed?: never;
|
|
970
1098
|
rightOf?: never;
|
|
@@ -985,14 +1113,17 @@ export declare namespace FieldPosition {
|
|
|
985
1113
|
*/
|
|
986
1114
|
export interface FormButton {
|
|
987
1115
|
/**
|
|
1116
|
+
* @public
|
|
988
1117
|
* <p>Specifies whether the button is visible on the form.</p>
|
|
989
1118
|
*/
|
|
990
1119
|
excluded?: boolean;
|
|
991
1120
|
/**
|
|
1121
|
+
* @public
|
|
992
1122
|
* <p>Describes the button's properties.</p>
|
|
993
1123
|
*/
|
|
994
1124
|
children?: string;
|
|
995
1125
|
/**
|
|
1126
|
+
* @public
|
|
996
1127
|
* <p>The position of the button.</p>
|
|
997
1128
|
*/
|
|
998
1129
|
position?: FieldPosition;
|
|
@@ -1016,18 +1147,22 @@ export type FormButtonsPosition = (typeof FormButtonsPosition)[keyof typeof Form
|
|
|
1016
1147
|
*/
|
|
1017
1148
|
export interface FormCTA {
|
|
1018
1149
|
/**
|
|
1150
|
+
* @public
|
|
1019
1151
|
* <p>The position of the button.</p>
|
|
1020
1152
|
*/
|
|
1021
1153
|
position?: FormButtonsPosition | string;
|
|
1022
1154
|
/**
|
|
1155
|
+
* @public
|
|
1023
1156
|
* <p>Displays a clear button.</p>
|
|
1024
1157
|
*/
|
|
1025
1158
|
clear?: FormButton;
|
|
1026
1159
|
/**
|
|
1160
|
+
* @public
|
|
1027
1161
|
* <p>Displays a cancel button.</p>
|
|
1028
1162
|
*/
|
|
1029
1163
|
cancel?: FormButton;
|
|
1030
1164
|
/**
|
|
1165
|
+
* @public
|
|
1031
1166
|
* <p>Displays a submit button.</p>
|
|
1032
1167
|
*/
|
|
1033
1168
|
submit?: FormButton;
|
|
@@ -1056,10 +1191,12 @@ export type FormDataSourceType = (typeof FormDataSourceType)[keyof typeof FormDa
|
|
|
1056
1191
|
*/
|
|
1057
1192
|
export interface FormDataTypeConfig {
|
|
1058
1193
|
/**
|
|
1194
|
+
* @public
|
|
1059
1195
|
* <p>The data source type, either an Amplify DataStore model or a custom data type.</p>
|
|
1060
1196
|
*/
|
|
1061
1197
|
dataSourceType: FormDataSourceType | string | undefined;
|
|
1062
1198
|
/**
|
|
1199
|
+
* @public
|
|
1063
1200
|
* <p>The unique name of the data type you are using as the data source for the form.</p>
|
|
1064
1201
|
*/
|
|
1065
1202
|
dataTypeName: string | undefined;
|
|
@@ -1083,6 +1220,7 @@ export type StorageAccessLevel = (typeof StorageAccessLevel)[keyof typeof Storag
|
|
|
1083
1220
|
*/
|
|
1084
1221
|
export interface FileUploaderFieldConfig {
|
|
1085
1222
|
/**
|
|
1223
|
+
* @public
|
|
1086
1224
|
* <p>The access level to assign to the uploaded files in the Amazon S3 bucket where
|
|
1087
1225
|
* they are stored. The valid values for this property are <code>private</code>,
|
|
1088
1226
|
* <code>protected</code>, or <code>public</code>. For detailed information about the
|
|
@@ -1091,16 +1229,19 @@ export interface FileUploaderFieldConfig {
|
|
|
1091
1229
|
*/
|
|
1092
1230
|
accessLevel: StorageAccessLevel | string | undefined;
|
|
1093
1231
|
/**
|
|
1232
|
+
* @public
|
|
1094
1233
|
* <p>The file types that are allowed to be uploaded by the file uploader. Provide this
|
|
1095
1234
|
* information in an array of strings specifying the valid file extensions.</p>
|
|
1096
1235
|
*/
|
|
1097
1236
|
acceptedFileTypes: string[] | undefined;
|
|
1098
1237
|
/**
|
|
1238
|
+
* @public
|
|
1099
1239
|
* <p>Specifies whether to display or hide the image preview after selecting a file for upload.
|
|
1100
1240
|
* The default value is <code>true</code> to display the image preview.</p>
|
|
1101
1241
|
*/
|
|
1102
1242
|
showThumbnails?: boolean;
|
|
1103
1243
|
/**
|
|
1244
|
+
* @public
|
|
1104
1245
|
* <p>Allows the file upload operation to be paused and resumed. The default value is
|
|
1105
1246
|
* <code>false</code>.</p>
|
|
1106
1247
|
* <p>When <code>isResumable</code> is set to <code>true</code>, the file uploader uses a
|
|
@@ -1109,11 +1250,13 @@ export interface FileUploaderFieldConfig {
|
|
|
1109
1250
|
*/
|
|
1110
1251
|
isResumable?: boolean;
|
|
1111
1252
|
/**
|
|
1253
|
+
* @public
|
|
1112
1254
|
* <p>Specifies the maximum number of files that can be selected to upload. The default value is
|
|
1113
1255
|
* an unlimited number of files.</p>
|
|
1114
1256
|
*/
|
|
1115
1257
|
maxFileCount?: number;
|
|
1116
1258
|
/**
|
|
1259
|
+
* @public
|
|
1117
1260
|
* <p>The maximum file size in bytes that the file uploader will accept. The default value is an
|
|
1118
1261
|
* unlimited file size.</p>
|
|
1119
1262
|
*/
|
|
@@ -1127,6 +1270,7 @@ export interface FileUploaderFieldConfig {
|
|
|
1127
1270
|
*/
|
|
1128
1271
|
export interface FormInputBindingPropertiesValueProperties {
|
|
1129
1272
|
/**
|
|
1273
|
+
* @public
|
|
1130
1274
|
* <p>An Amplify DataStore model.</p>
|
|
1131
1275
|
*/
|
|
1132
1276
|
model?: string;
|
|
@@ -1139,10 +1283,12 @@ export interface FormInputBindingPropertiesValueProperties {
|
|
|
1139
1283
|
*/
|
|
1140
1284
|
export interface FormInputBindingPropertiesValue {
|
|
1141
1285
|
/**
|
|
1286
|
+
* @public
|
|
1142
1287
|
* <p>The property type.</p>
|
|
1143
1288
|
*/
|
|
1144
1289
|
type?: string;
|
|
1145
1290
|
/**
|
|
1291
|
+
* @public
|
|
1146
1292
|
* <p>Describes the properties to customize with data at runtime.</p>
|
|
1147
1293
|
*/
|
|
1148
1294
|
bindingProperties?: FormInputBindingPropertiesValueProperties;
|
|
@@ -1154,10 +1300,12 @@ export interface FormInputBindingPropertiesValue {
|
|
|
1154
1300
|
*/
|
|
1155
1301
|
export interface FormInputValuePropertyBindingProperties {
|
|
1156
1302
|
/**
|
|
1303
|
+
* @public
|
|
1157
1304
|
* <p>The form property to bind to the data field.</p>
|
|
1158
1305
|
*/
|
|
1159
1306
|
property: string | undefined;
|
|
1160
1307
|
/**
|
|
1308
|
+
* @public
|
|
1161
1309
|
* <p>The data field to bind the property to.</p>
|
|
1162
1310
|
*/
|
|
1163
1311
|
field?: string;
|
|
@@ -1168,19 +1316,23 @@ export interface FormInputValuePropertyBindingProperties {
|
|
|
1168
1316
|
*/
|
|
1169
1317
|
export interface FieldValidationConfiguration {
|
|
1170
1318
|
/**
|
|
1319
|
+
* @public
|
|
1171
1320
|
* <p>The validation to perform on an object type.<code/>
|
|
1172
1321
|
* </p>
|
|
1173
1322
|
*/
|
|
1174
1323
|
type: string | undefined;
|
|
1175
1324
|
/**
|
|
1325
|
+
* @public
|
|
1176
1326
|
* <p>The validation to perform on a string value.</p>
|
|
1177
1327
|
*/
|
|
1178
1328
|
strValues?: string[];
|
|
1179
1329
|
/**
|
|
1330
|
+
* @public
|
|
1180
1331
|
* <p>The validation to perform on a number value.</p>
|
|
1181
1332
|
*/
|
|
1182
1333
|
numValues?: number[];
|
|
1183
1334
|
/**
|
|
1335
|
+
* @public
|
|
1184
1336
|
* <p>The validation message to display.</p>
|
|
1185
1337
|
*/
|
|
1186
1338
|
validationMessage?: string;
|
|
@@ -1218,30 +1370,36 @@ export type LabelDecorator = (typeof LabelDecorator)[keyof typeof LabelDecorator
|
|
|
1218
1370
|
*/
|
|
1219
1371
|
export interface SectionalElement {
|
|
1220
1372
|
/**
|
|
1373
|
+
* @public
|
|
1221
1374
|
* <p>The type of sectional element. Valid values are <code>Heading</code>, <code>Text</code>,
|
|
1222
1375
|
* and <code>Divider</code>.</p>
|
|
1223
1376
|
*/
|
|
1224
1377
|
type: string | undefined;
|
|
1225
1378
|
/**
|
|
1379
|
+
* @public
|
|
1226
1380
|
* <p>Specifies the position of the text in a field for a <code>Text</code> sectional
|
|
1227
1381
|
* element.</p>
|
|
1228
1382
|
*/
|
|
1229
1383
|
position?: FieldPosition;
|
|
1230
1384
|
/**
|
|
1385
|
+
* @public
|
|
1231
1386
|
* <p>The text for a <code>Text</code> sectional element.</p>
|
|
1232
1387
|
*/
|
|
1233
1388
|
text?: string;
|
|
1234
1389
|
/**
|
|
1390
|
+
* @public
|
|
1235
1391
|
* <p>Specifies the size of the font for a <code>Heading</code> sectional element. Valid values
|
|
1236
1392
|
* are <code>1 | 2 | 3 | 4 | 5 | 6</code>.</p>
|
|
1237
1393
|
*/
|
|
1238
1394
|
level?: number;
|
|
1239
1395
|
/**
|
|
1396
|
+
* @public
|
|
1240
1397
|
* <p>Specifies the orientation for a <code>Divider</code> sectional element. Valid values are
|
|
1241
1398
|
* <code>horizontal</code> or <code>vertical</code>.</p>
|
|
1242
1399
|
*/
|
|
1243
1400
|
orientation?: string;
|
|
1244
1401
|
/**
|
|
1402
|
+
* @public
|
|
1245
1403
|
* <p>Excludes a sectional element that was generated by default for a specified data
|
|
1246
1404
|
* model.</p>
|
|
1247
1405
|
*/
|
|
@@ -1257,6 +1415,7 @@ export type FormStyleConfig = FormStyleConfig.TokenReferenceMember | FormStyleCo
|
|
|
1257
1415
|
*/
|
|
1258
1416
|
export declare namespace FormStyleConfig {
|
|
1259
1417
|
/**
|
|
1418
|
+
* @public
|
|
1260
1419
|
* <p>A reference to a design token to use to bind the form's style properties to an existing
|
|
1261
1420
|
* theme.</p>
|
|
1262
1421
|
*/
|
|
@@ -1266,6 +1425,7 @@ export declare namespace FormStyleConfig {
|
|
|
1266
1425
|
$unknown?: never;
|
|
1267
1426
|
}
|
|
1268
1427
|
/**
|
|
1428
|
+
* @public
|
|
1269
1429
|
* <p>The value of the style setting.</p>
|
|
1270
1430
|
*/
|
|
1271
1431
|
interface ValueMember {
|
|
@@ -1273,6 +1433,9 @@ export declare namespace FormStyleConfig {
|
|
|
1273
1433
|
value: string;
|
|
1274
1434
|
$unknown?: never;
|
|
1275
1435
|
}
|
|
1436
|
+
/**
|
|
1437
|
+
* @public
|
|
1438
|
+
*/
|
|
1276
1439
|
interface $UnknownMember {
|
|
1277
1440
|
tokenReference?: never;
|
|
1278
1441
|
value?: never;
|
|
@@ -1291,14 +1454,17 @@ export declare namespace FormStyleConfig {
|
|
|
1291
1454
|
*/
|
|
1292
1455
|
export interface FormStyle {
|
|
1293
1456
|
/**
|
|
1457
|
+
* @public
|
|
1294
1458
|
* <p>The spacing for the horizontal gap.</p>
|
|
1295
1459
|
*/
|
|
1296
1460
|
horizontalGap?: FormStyleConfig;
|
|
1297
1461
|
/**
|
|
1462
|
+
* @public
|
|
1298
1463
|
* <p>The spacing for the vertical gap.</p>
|
|
1299
1464
|
*/
|
|
1300
1465
|
verticalGap?: FormStyleConfig;
|
|
1301
1466
|
/**
|
|
1467
|
+
* @public
|
|
1302
1468
|
* <p>The size of the outer padding for the form.</p>
|
|
1303
1469
|
*/
|
|
1304
1470
|
outerPadding?: FormStyleConfig;
|
|
@@ -1308,14 +1474,17 @@ export interface FormStyle {
|
|
|
1308
1474
|
*/
|
|
1309
1475
|
export interface DeleteFormRequest {
|
|
1310
1476
|
/**
|
|
1477
|
+
* @public
|
|
1311
1478
|
* <p>The unique ID of the Amplify app associated with the form to delete.</p>
|
|
1312
1479
|
*/
|
|
1313
1480
|
appId: string | undefined;
|
|
1314
1481
|
/**
|
|
1482
|
+
* @public
|
|
1315
1483
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
1316
1484
|
*/
|
|
1317
1485
|
environmentName: string | undefined;
|
|
1318
1486
|
/**
|
|
1487
|
+
* @public
|
|
1319
1488
|
* <p>The unique ID of the form to delete.</p>
|
|
1320
1489
|
*/
|
|
1321
1490
|
id: string | undefined;
|
|
@@ -1325,14 +1494,17 @@ export interface DeleteFormRequest {
|
|
|
1325
1494
|
*/
|
|
1326
1495
|
export interface ExportFormsRequest {
|
|
1327
1496
|
/**
|
|
1497
|
+
* @public
|
|
1328
1498
|
* <p>The unique ID of the Amplify app to export forms to.</p>
|
|
1329
1499
|
*/
|
|
1330
1500
|
appId: string | undefined;
|
|
1331
1501
|
/**
|
|
1502
|
+
* @public
|
|
1332
1503
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
1333
1504
|
*/
|
|
1334
1505
|
environmentName: string | undefined;
|
|
1335
1506
|
/**
|
|
1507
|
+
* @public
|
|
1336
1508
|
* <p>The token to request the next page of results.</p>
|
|
1337
1509
|
*/
|
|
1338
1510
|
nextToken?: string;
|
|
@@ -1342,14 +1514,17 @@ export interface ExportFormsRequest {
|
|
|
1342
1514
|
*/
|
|
1343
1515
|
export interface GetFormRequest {
|
|
1344
1516
|
/**
|
|
1517
|
+
* @public
|
|
1345
1518
|
* <p>The unique ID of the Amplify app.</p>
|
|
1346
1519
|
*/
|
|
1347
1520
|
appId: string | undefined;
|
|
1348
1521
|
/**
|
|
1522
|
+
* @public
|
|
1349
1523
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1350
1524
|
*/
|
|
1351
1525
|
environmentName: string | undefined;
|
|
1352
1526
|
/**
|
|
1527
|
+
* @public
|
|
1353
1528
|
* <p>The unique ID of the form.</p>
|
|
1354
1529
|
*/
|
|
1355
1530
|
id: string | undefined;
|
|
@@ -1359,18 +1534,22 @@ export interface GetFormRequest {
|
|
|
1359
1534
|
*/
|
|
1360
1535
|
export interface ListFormsRequest {
|
|
1361
1536
|
/**
|
|
1537
|
+
* @public
|
|
1362
1538
|
* <p>The unique ID for the Amplify app.</p>
|
|
1363
1539
|
*/
|
|
1364
1540
|
appId: string | undefined;
|
|
1365
1541
|
/**
|
|
1542
|
+
* @public
|
|
1366
1543
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
1367
1544
|
*/
|
|
1368
1545
|
environmentName: string | undefined;
|
|
1369
1546
|
/**
|
|
1547
|
+
* @public
|
|
1370
1548
|
* <p>The token to request the next page of results.</p>
|
|
1371
1549
|
*/
|
|
1372
1550
|
nextToken?: string;
|
|
1373
1551
|
/**
|
|
1552
|
+
* @public
|
|
1374
1553
|
* <p>The maximum number of forms to retrieve.</p>
|
|
1375
1554
|
*/
|
|
1376
1555
|
maxResults?: number;
|
|
@@ -1381,26 +1560,32 @@ export interface ListFormsRequest {
|
|
|
1381
1560
|
*/
|
|
1382
1561
|
export interface FormSummary {
|
|
1383
1562
|
/**
|
|
1563
|
+
* @public
|
|
1384
1564
|
* <p>The unique ID for the app associated with the form summary.</p>
|
|
1385
1565
|
*/
|
|
1386
1566
|
appId: string | undefined;
|
|
1387
1567
|
/**
|
|
1568
|
+
* @public
|
|
1388
1569
|
* <p>The form's data source type.</p>
|
|
1389
1570
|
*/
|
|
1390
1571
|
dataType: FormDataTypeConfig | undefined;
|
|
1391
1572
|
/**
|
|
1573
|
+
* @public
|
|
1392
1574
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1393
1575
|
*/
|
|
1394
1576
|
environmentName: string | undefined;
|
|
1395
1577
|
/**
|
|
1578
|
+
* @public
|
|
1396
1579
|
* <p>The type of operation to perform on the form.</p>
|
|
1397
1580
|
*/
|
|
1398
1581
|
formActionType: FormActionType | string | undefined;
|
|
1399
1582
|
/**
|
|
1583
|
+
* @public
|
|
1400
1584
|
* <p>The ID of the form.</p>
|
|
1401
1585
|
*/
|
|
1402
1586
|
id: string | undefined;
|
|
1403
1587
|
/**
|
|
1588
|
+
* @public
|
|
1404
1589
|
* <p>The name of the form.</p>
|
|
1405
1590
|
*/
|
|
1406
1591
|
name: string | undefined;
|
|
@@ -1410,10 +1595,12 @@ export interface FormSummary {
|
|
|
1410
1595
|
*/
|
|
1411
1596
|
export interface ListFormsResponse {
|
|
1412
1597
|
/**
|
|
1598
|
+
* @public
|
|
1413
1599
|
* <p>The list of forms for the Amplify app.</p>
|
|
1414
1600
|
*/
|
|
1415
1601
|
entities: FormSummary[] | undefined;
|
|
1416
1602
|
/**
|
|
1603
|
+
* @public
|
|
1417
1604
|
* <p>The pagination token that's included if more results are available.</p>
|
|
1418
1605
|
*/
|
|
1419
1606
|
nextToken?: string;
|
|
@@ -1423,10 +1610,12 @@ export interface ListFormsResponse {
|
|
|
1423
1610
|
*/
|
|
1424
1611
|
export interface GetMetadataRequest {
|
|
1425
1612
|
/**
|
|
1613
|
+
* @public
|
|
1426
1614
|
* <p>The unique ID of the Amplify app.</p>
|
|
1427
1615
|
*/
|
|
1428
1616
|
appId: string | undefined;
|
|
1429
1617
|
/**
|
|
1618
|
+
* @public
|
|
1430
1619
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1431
1620
|
*/
|
|
1432
1621
|
environmentName: string | undefined;
|
|
@@ -1436,6 +1625,7 @@ export interface GetMetadataRequest {
|
|
|
1436
1625
|
*/
|
|
1437
1626
|
export interface GetMetadataResponse {
|
|
1438
1627
|
/**
|
|
1628
|
+
* @public
|
|
1439
1629
|
* <p>Represents the configuration settings for the features metadata.</p>
|
|
1440
1630
|
*/
|
|
1441
1631
|
features: Record<string, string> | undefined;
|
|
@@ -1458,6 +1648,7 @@ export declare class UnauthorizedException extends __BaseException {
|
|
|
1458
1648
|
*/
|
|
1459
1649
|
export interface PutMetadataFlagBody {
|
|
1460
1650
|
/**
|
|
1651
|
+
* @public
|
|
1461
1652
|
* <p>The new information to store.</p>
|
|
1462
1653
|
*/
|
|
1463
1654
|
newValue: string | undefined;
|
|
@@ -1467,18 +1658,22 @@ export interface PutMetadataFlagBody {
|
|
|
1467
1658
|
*/
|
|
1468
1659
|
export interface PutMetadataFlagRequest {
|
|
1469
1660
|
/**
|
|
1661
|
+
* @public
|
|
1470
1662
|
* <p>The unique ID for the Amplify app.</p>
|
|
1471
1663
|
*/
|
|
1472
1664
|
appId: string | undefined;
|
|
1473
1665
|
/**
|
|
1666
|
+
* @public
|
|
1474
1667
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1475
1668
|
*/
|
|
1476
1669
|
environmentName: string | undefined;
|
|
1477
1670
|
/**
|
|
1671
|
+
* @public
|
|
1478
1672
|
* <p>The name of the feature associated with the metadata.</p>
|
|
1479
1673
|
*/
|
|
1480
1674
|
featureName: string | undefined;
|
|
1481
1675
|
/**
|
|
1676
|
+
* @public
|
|
1482
1677
|
* <p>The metadata information to store.</p>
|
|
1483
1678
|
*/
|
|
1484
1679
|
body: PutMetadataFlagBody | undefined;
|
|
@@ -1489,11 +1684,13 @@ export interface PutMetadataFlagRequest {
|
|
|
1489
1684
|
*/
|
|
1490
1685
|
export interface RefreshTokenRequestBody {
|
|
1491
1686
|
/**
|
|
1687
|
+
* @public
|
|
1492
1688
|
* <p>The token to use to refresh a previously issued access token that might have
|
|
1493
1689
|
* expired.</p>
|
|
1494
1690
|
*/
|
|
1495
1691
|
token: string | undefined;
|
|
1496
1692
|
/**
|
|
1693
|
+
* @public
|
|
1497
1694
|
* <p>The ID of the client to request the token from.</p>
|
|
1498
1695
|
*/
|
|
1499
1696
|
clientId?: string;
|
|
@@ -1503,10 +1700,12 @@ export interface RefreshTokenRequestBody {
|
|
|
1503
1700
|
*/
|
|
1504
1701
|
export interface RefreshTokenRequest {
|
|
1505
1702
|
/**
|
|
1703
|
+
* @public
|
|
1506
1704
|
* <p>The third-party provider for the token. The only valid value is <code>figma</code>.</p>
|
|
1507
1705
|
*/
|
|
1508
1706
|
provider: TokenProviders | string | undefined;
|
|
1509
1707
|
/**
|
|
1708
|
+
* @public
|
|
1510
1709
|
* <p>Information about the refresh token request.</p>
|
|
1511
1710
|
*/
|
|
1512
1711
|
refreshTokenBody: RefreshTokenRequestBody | undefined;
|
|
@@ -1516,10 +1715,12 @@ export interface RefreshTokenRequest {
|
|
|
1516
1715
|
*/
|
|
1517
1716
|
export interface RefreshTokenResponse {
|
|
1518
1717
|
/**
|
|
1718
|
+
* @public
|
|
1519
1719
|
* <p>The access token.</p>
|
|
1520
1720
|
*/
|
|
1521
1721
|
accessToken: string | undefined;
|
|
1522
1722
|
/**
|
|
1723
|
+
* @public
|
|
1523
1724
|
* <p>The date and time when the new access token expires.</p>
|
|
1524
1725
|
*/
|
|
1525
1726
|
expiresIn: number | undefined;
|
|
@@ -1529,16 +1730,19 @@ export interface RefreshTokenResponse {
|
|
|
1529
1730
|
*/
|
|
1530
1731
|
export interface DeleteThemeRequest {
|
|
1531
1732
|
/**
|
|
1733
|
+
* @public
|
|
1532
1734
|
* <p>The unique ID of the Amplify app associated with the theme to
|
|
1533
1735
|
* delete.</p>
|
|
1534
1736
|
*/
|
|
1535
1737
|
appId: string | undefined;
|
|
1536
1738
|
/**
|
|
1739
|
+
* @public
|
|
1537
1740
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
1538
1741
|
* app.</p>
|
|
1539
1742
|
*/
|
|
1540
1743
|
environmentName: string | undefined;
|
|
1541
1744
|
/**
|
|
1745
|
+
* @public
|
|
1542
1746
|
* <p>The unique ID of the theme to delete.</p>
|
|
1543
1747
|
*/
|
|
1544
1748
|
id: string | undefined;
|
|
@@ -1548,14 +1752,17 @@ export interface DeleteThemeRequest {
|
|
|
1548
1752
|
*/
|
|
1549
1753
|
export interface ExportThemesRequest {
|
|
1550
1754
|
/**
|
|
1755
|
+
* @public
|
|
1551
1756
|
* <p>The unique ID of the Amplify app to export the themes to.</p>
|
|
1552
1757
|
*/
|
|
1553
1758
|
appId: string | undefined;
|
|
1554
1759
|
/**
|
|
1760
|
+
* @public
|
|
1555
1761
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1556
1762
|
*/
|
|
1557
1763
|
environmentName: string | undefined;
|
|
1558
1764
|
/**
|
|
1765
|
+
* @public
|
|
1559
1766
|
* <p>The token to request the next page of results.</p>
|
|
1560
1767
|
*/
|
|
1561
1768
|
nextToken?: string;
|
|
@@ -1565,14 +1772,17 @@ export interface ExportThemesRequest {
|
|
|
1565
1772
|
*/
|
|
1566
1773
|
export interface GetThemeRequest {
|
|
1567
1774
|
/**
|
|
1775
|
+
* @public
|
|
1568
1776
|
* <p>The unique ID of the Amplify app.</p>
|
|
1569
1777
|
*/
|
|
1570
1778
|
appId: string | undefined;
|
|
1571
1779
|
/**
|
|
1780
|
+
* @public
|
|
1572
1781
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1573
1782
|
*/
|
|
1574
1783
|
environmentName: string | undefined;
|
|
1575
1784
|
/**
|
|
1785
|
+
* @public
|
|
1576
1786
|
* <p>The unique ID for the theme.</p>
|
|
1577
1787
|
*/
|
|
1578
1788
|
id: string | undefined;
|
|
@@ -1582,19 +1792,23 @@ export interface GetThemeRequest {
|
|
|
1582
1792
|
*/
|
|
1583
1793
|
export interface ListThemesRequest {
|
|
1584
1794
|
/**
|
|
1795
|
+
* @public
|
|
1585
1796
|
* <p>The unique ID for the Amplify app.</p>
|
|
1586
1797
|
*/
|
|
1587
1798
|
appId: string | undefined;
|
|
1588
1799
|
/**
|
|
1800
|
+
* @public
|
|
1589
1801
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
1590
1802
|
* app.</p>
|
|
1591
1803
|
*/
|
|
1592
1804
|
environmentName: string | undefined;
|
|
1593
1805
|
/**
|
|
1806
|
+
* @public
|
|
1594
1807
|
* <p>The token to request the next page of results.</p>
|
|
1595
1808
|
*/
|
|
1596
1809
|
nextToken?: string;
|
|
1597
1810
|
/**
|
|
1811
|
+
* @public
|
|
1598
1812
|
* <p>The maximum number of theme results to return in the response.</p>
|
|
1599
1813
|
*/
|
|
1600
1814
|
maxResults?: number;
|
|
@@ -1605,18 +1819,22 @@ export interface ListThemesRequest {
|
|
|
1605
1819
|
*/
|
|
1606
1820
|
export interface ThemeSummary {
|
|
1607
1821
|
/**
|
|
1822
|
+
* @public
|
|
1608
1823
|
* <p>The unique ID for the app associated with the theme summary.</p>
|
|
1609
1824
|
*/
|
|
1610
1825
|
appId: string | undefined;
|
|
1611
1826
|
/**
|
|
1827
|
+
* @public
|
|
1612
1828
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
1613
1829
|
*/
|
|
1614
1830
|
environmentName: string | undefined;
|
|
1615
1831
|
/**
|
|
1832
|
+
* @public
|
|
1616
1833
|
* <p>The ID of the theme.</p>
|
|
1617
1834
|
*/
|
|
1618
1835
|
id: string | undefined;
|
|
1619
1836
|
/**
|
|
1837
|
+
* @public
|
|
1620
1838
|
* <p>The name of the theme.</p>
|
|
1621
1839
|
*/
|
|
1622
1840
|
name: string | undefined;
|
|
@@ -1626,10 +1844,12 @@ export interface ThemeSummary {
|
|
|
1626
1844
|
*/
|
|
1627
1845
|
export interface ListThemesResponse {
|
|
1628
1846
|
/**
|
|
1847
|
+
* @public
|
|
1629
1848
|
* <p>The list of themes for the Amplify app.</p>
|
|
1630
1849
|
*/
|
|
1631
1850
|
entities: ThemeSummary[] | undefined;
|
|
1632
1851
|
/**
|
|
1852
|
+
* @public
|
|
1633
1853
|
* <p>The pagination token that's returned if more results are available.</p>
|
|
1634
1854
|
*/
|
|
1635
1855
|
nextToken?: string;
|
|
@@ -1642,14 +1862,17 @@ export interface ListThemesResponse {
|
|
|
1642
1862
|
*/
|
|
1643
1863
|
export interface FormInputValueProperty {
|
|
1644
1864
|
/**
|
|
1865
|
+
* @public
|
|
1645
1866
|
* <p>The value to assign to the input field.</p>
|
|
1646
1867
|
*/
|
|
1647
1868
|
value?: string;
|
|
1648
1869
|
/**
|
|
1870
|
+
* @public
|
|
1649
1871
|
* <p>The information to bind fields to data at runtime.</p>
|
|
1650
1872
|
*/
|
|
1651
1873
|
bindingProperties?: FormInputValuePropertyBindingProperties;
|
|
1652
1874
|
/**
|
|
1875
|
+
* @public
|
|
1653
1876
|
* <p>A list of form properties to concatenate to create the value to assign to this field
|
|
1654
1877
|
* property.</p>
|
|
1655
1878
|
*/
|
|
@@ -1661,10 +1884,12 @@ export interface FormInputValueProperty {
|
|
|
1661
1884
|
*/
|
|
1662
1885
|
export interface ThemeValue {
|
|
1663
1886
|
/**
|
|
1887
|
+
* @public
|
|
1664
1888
|
* <p>The value of a theme property.</p>
|
|
1665
1889
|
*/
|
|
1666
1890
|
value?: string;
|
|
1667
1891
|
/**
|
|
1892
|
+
* @public
|
|
1668
1893
|
* <p>A list of key-value pairs that define the theme's properties.</p>
|
|
1669
1894
|
*/
|
|
1670
1895
|
children?: ThemeValues[];
|
|
@@ -1675,10 +1900,12 @@ export interface ThemeValue {
|
|
|
1675
1900
|
*/
|
|
1676
1901
|
export interface ThemeValues {
|
|
1677
1902
|
/**
|
|
1903
|
+
* @public
|
|
1678
1904
|
* <p>The name of the property.</p>
|
|
1679
1905
|
*/
|
|
1680
1906
|
key?: string;
|
|
1681
1907
|
/**
|
|
1908
|
+
* @public
|
|
1682
1909
|
* <p>The value of the property.</p>
|
|
1683
1910
|
*/
|
|
1684
1911
|
value?: ThemeValue;
|
|
@@ -1690,26 +1917,32 @@ export interface ThemeValues {
|
|
|
1690
1917
|
*/
|
|
1691
1918
|
export interface Predicate {
|
|
1692
1919
|
/**
|
|
1920
|
+
* @public
|
|
1693
1921
|
* <p>A list of predicates to combine logically.</p>
|
|
1694
1922
|
*/
|
|
1695
1923
|
or?: Predicate[];
|
|
1696
1924
|
/**
|
|
1925
|
+
* @public
|
|
1697
1926
|
* <p>A list of predicates to combine logically.</p>
|
|
1698
1927
|
*/
|
|
1699
1928
|
and?: Predicate[];
|
|
1700
1929
|
/**
|
|
1930
|
+
* @public
|
|
1701
1931
|
* <p>The field to query.</p>
|
|
1702
1932
|
*/
|
|
1703
1933
|
field?: string;
|
|
1704
1934
|
/**
|
|
1935
|
+
* @public
|
|
1705
1936
|
* <p>The operator to use to perform the evaluation.</p>
|
|
1706
1937
|
*/
|
|
1707
1938
|
operator?: string;
|
|
1708
1939
|
/**
|
|
1940
|
+
* @public
|
|
1709
1941
|
* <p>The value to use when performing the evaluation.</p>
|
|
1710
1942
|
*/
|
|
1711
1943
|
operand?: string;
|
|
1712
1944
|
/**
|
|
1945
|
+
* @public
|
|
1713
1946
|
* <p>The type of value to use when performing the evaluation.</p>
|
|
1714
1947
|
*/
|
|
1715
1948
|
operandType?: string;
|
|
@@ -1723,34 +1956,42 @@ export interface Predicate {
|
|
|
1723
1956
|
*/
|
|
1724
1957
|
export interface ComponentBindingPropertiesValueProperties {
|
|
1725
1958
|
/**
|
|
1959
|
+
* @public
|
|
1726
1960
|
* <p>An Amplify DataStore model.</p>
|
|
1727
1961
|
*/
|
|
1728
1962
|
model?: string;
|
|
1729
1963
|
/**
|
|
1964
|
+
* @public
|
|
1730
1965
|
* <p>The field to bind the data to.</p>
|
|
1731
1966
|
*/
|
|
1732
1967
|
field?: string;
|
|
1733
1968
|
/**
|
|
1969
|
+
* @public
|
|
1734
1970
|
* <p>A list of predicates for binding a component's properties to data.</p>
|
|
1735
1971
|
*/
|
|
1736
1972
|
predicates?: Predicate[];
|
|
1737
1973
|
/**
|
|
1974
|
+
* @public
|
|
1738
1975
|
* <p>An authenticated user attribute.</p>
|
|
1739
1976
|
*/
|
|
1740
1977
|
userAttribute?: string;
|
|
1741
1978
|
/**
|
|
1979
|
+
* @public
|
|
1742
1980
|
* <p>An Amazon S3 bucket.</p>
|
|
1743
1981
|
*/
|
|
1744
1982
|
bucket?: string;
|
|
1745
1983
|
/**
|
|
1984
|
+
* @public
|
|
1746
1985
|
* <p>The storage key for an Amazon S3 bucket.</p>
|
|
1747
1986
|
*/
|
|
1748
1987
|
key?: string;
|
|
1749
1988
|
/**
|
|
1989
|
+
* @public
|
|
1750
1990
|
* <p>The default value to assign to the property.</p>
|
|
1751
1991
|
*/
|
|
1752
1992
|
defaultValue?: string;
|
|
1753
1993
|
/**
|
|
1994
|
+
* @public
|
|
1754
1995
|
* <p>The name of a component slot.</p>
|
|
1755
1996
|
*/
|
|
1756
1997
|
slotName?: string;
|
|
@@ -1761,19 +2002,23 @@ export interface ComponentBindingPropertiesValueProperties {
|
|
|
1761
2002
|
*/
|
|
1762
2003
|
export interface ComponentDataConfiguration {
|
|
1763
2004
|
/**
|
|
2005
|
+
* @public
|
|
1764
2006
|
* <p>The name of the data model to use to bind data to a component.</p>
|
|
1765
2007
|
*/
|
|
1766
2008
|
model: string | undefined;
|
|
1767
2009
|
/**
|
|
2010
|
+
* @public
|
|
1768
2011
|
* <p>Describes how to sort the component's properties.</p>
|
|
1769
2012
|
*/
|
|
1770
2013
|
sort?: SortProperty[];
|
|
1771
2014
|
/**
|
|
2015
|
+
* @public
|
|
1772
2016
|
* <p>Represents the conditional logic to use when binding data to a component. Use this
|
|
1773
2017
|
* property to retrieve only a subset of the data in a collection.</p>
|
|
1774
2018
|
*/
|
|
1775
2019
|
predicate?: Predicate;
|
|
1776
2020
|
/**
|
|
2021
|
+
* @public
|
|
1777
2022
|
* <p>A list of IDs to use to bind data to a component. Use this property to bind specifically
|
|
1778
2023
|
* chosen data, rather than data retrieved from a query.</p>
|
|
1779
2024
|
*/
|
|
@@ -1786,66 +2031,81 @@ export interface ComponentDataConfiguration {
|
|
|
1786
2031
|
*/
|
|
1787
2032
|
export interface ComponentProperty {
|
|
1788
2033
|
/**
|
|
2034
|
+
* @public
|
|
1789
2035
|
* <p>The value to assign to the component property.</p>
|
|
1790
2036
|
*/
|
|
1791
2037
|
value?: string;
|
|
1792
2038
|
/**
|
|
2039
|
+
* @public
|
|
1793
2040
|
* <p>The information to bind the component property to data at runtime.</p>
|
|
1794
2041
|
*/
|
|
1795
2042
|
bindingProperties?: ComponentPropertyBindingProperties;
|
|
1796
2043
|
/**
|
|
2044
|
+
* @public
|
|
1797
2045
|
* <p>The information to bind the component property to data at runtime. Use this for collection
|
|
1798
2046
|
* components.</p>
|
|
1799
2047
|
*/
|
|
1800
2048
|
collectionBindingProperties?: ComponentPropertyBindingProperties;
|
|
1801
2049
|
/**
|
|
2050
|
+
* @public
|
|
1802
2051
|
* <p>The default value to assign to the component property.</p>
|
|
1803
2052
|
*/
|
|
1804
2053
|
defaultValue?: string;
|
|
1805
2054
|
/**
|
|
2055
|
+
* @public
|
|
1806
2056
|
* <p>The data model to use to assign a value to the component property.</p>
|
|
1807
2057
|
*/
|
|
1808
2058
|
model?: string;
|
|
1809
2059
|
/**
|
|
2060
|
+
* @public
|
|
1810
2061
|
* <p>The information to bind the component property to form data.</p>
|
|
1811
2062
|
*/
|
|
1812
2063
|
bindings?: Record<string, FormBindingElement>;
|
|
1813
2064
|
/**
|
|
2065
|
+
* @public
|
|
1814
2066
|
* <p>An event that occurs in your app. Use this for workflow data binding.</p>
|
|
1815
2067
|
*/
|
|
1816
2068
|
event?: string;
|
|
1817
2069
|
/**
|
|
2070
|
+
* @public
|
|
1818
2071
|
* <p>An authenticated user attribute to use to assign a value to the component property.</p>
|
|
1819
2072
|
*/
|
|
1820
2073
|
userAttribute?: string;
|
|
1821
2074
|
/**
|
|
2075
|
+
* @public
|
|
1822
2076
|
* <p>A list of component properties to concatenate to create the value to assign to this
|
|
1823
2077
|
* component property.</p>
|
|
1824
2078
|
*/
|
|
1825
2079
|
concat?: ComponentProperty[];
|
|
1826
2080
|
/**
|
|
2081
|
+
* @public
|
|
1827
2082
|
* <p>The conditional expression to use to assign a value to the component property.</p>
|
|
1828
2083
|
*/
|
|
1829
2084
|
condition?: ComponentConditionProperty;
|
|
1830
2085
|
/**
|
|
2086
|
+
* @public
|
|
1831
2087
|
* <p>Specifies whether the user configured the property in Amplify Studio after
|
|
1832
2088
|
* importing it.</p>
|
|
1833
2089
|
*/
|
|
1834
2090
|
configured?: boolean;
|
|
1835
2091
|
/**
|
|
2092
|
+
* @public
|
|
1836
2093
|
* <p>The component type.</p>
|
|
1837
2094
|
*/
|
|
1838
2095
|
type?: string;
|
|
1839
2096
|
/**
|
|
2097
|
+
* @public
|
|
1840
2098
|
* <p>The default value assigned to the property when the component is imported into an
|
|
1841
2099
|
* app.</p>
|
|
1842
2100
|
*/
|
|
1843
2101
|
importedValue?: string;
|
|
1844
2102
|
/**
|
|
2103
|
+
* @public
|
|
1845
2104
|
* <p>The name of the component that is affected by an event.</p>
|
|
1846
2105
|
*/
|
|
1847
2106
|
componentName?: string;
|
|
1848
2107
|
/**
|
|
2108
|
+
* @public
|
|
1849
2109
|
* <p>The name of the component's property that is affected by an event.</p>
|
|
1850
2110
|
*/
|
|
1851
2111
|
property?: string;
|
|
@@ -1857,10 +2117,12 @@ export interface ComponentProperty {
|
|
|
1857
2117
|
*/
|
|
1858
2118
|
export interface ValueMapping {
|
|
1859
2119
|
/**
|
|
2120
|
+
* @public
|
|
1860
2121
|
* <p>The value to display for the complex object.</p>
|
|
1861
2122
|
*/
|
|
1862
2123
|
displayValue?: FormInputValueProperty;
|
|
1863
2124
|
/**
|
|
2125
|
+
* @public
|
|
1864
2126
|
* <p>The complex object.</p>
|
|
1865
2127
|
*/
|
|
1866
2128
|
value: FormInputValueProperty | undefined;
|
|
@@ -1874,14 +2136,17 @@ export interface ValueMapping {
|
|
|
1874
2136
|
*/
|
|
1875
2137
|
export interface ComponentBindingPropertiesValue {
|
|
1876
2138
|
/**
|
|
2139
|
+
* @public
|
|
1877
2140
|
* <p>The property type.</p>
|
|
1878
2141
|
*/
|
|
1879
2142
|
type?: string;
|
|
1880
2143
|
/**
|
|
2144
|
+
* @public
|
|
1881
2145
|
* <p>Describes the properties to customize with data at runtime.</p>
|
|
1882
2146
|
*/
|
|
1883
2147
|
bindingProperties?: ComponentBindingPropertiesValueProperties;
|
|
1884
2148
|
/**
|
|
2149
|
+
* @public
|
|
1885
2150
|
* <p>The default value of the property.</p>
|
|
1886
2151
|
*/
|
|
1887
2152
|
defaultValue?: string;
|
|
@@ -1892,19 +2157,23 @@ export interface ComponentBindingPropertiesValue {
|
|
|
1892
2157
|
*/
|
|
1893
2158
|
export interface CreateThemeData {
|
|
1894
2159
|
/**
|
|
2160
|
+
* @public
|
|
1895
2161
|
* <p>The name of the theme.</p>
|
|
1896
2162
|
*/
|
|
1897
2163
|
name: string | undefined;
|
|
1898
2164
|
/**
|
|
2165
|
+
* @public
|
|
1899
2166
|
* <p>A list of key-value pairs that defines the properties of the theme.</p>
|
|
1900
2167
|
*/
|
|
1901
2168
|
values: ThemeValues[] | undefined;
|
|
1902
2169
|
/**
|
|
2170
|
+
* @public
|
|
1903
2171
|
* <p>Describes the properties that can be overriden to customize an instance of the
|
|
1904
2172
|
* theme.</p>
|
|
1905
2173
|
*/
|
|
1906
2174
|
overrides?: ThemeValues[];
|
|
1907
2175
|
/**
|
|
2176
|
+
* @public
|
|
1908
2177
|
* <p>One or more key-value pairs to use when tagging the theme data.</p>
|
|
1909
2178
|
*/
|
|
1910
2179
|
tags?: Record<string, string>;
|
|
@@ -1916,39 +2185,48 @@ export interface CreateThemeData {
|
|
|
1916
2185
|
*/
|
|
1917
2186
|
export interface Theme {
|
|
1918
2187
|
/**
|
|
2188
|
+
* @public
|
|
1919
2189
|
* <p>The unique ID for the Amplify app associated with the theme.</p>
|
|
1920
2190
|
*/
|
|
1921
2191
|
appId: string | undefined;
|
|
1922
2192
|
/**
|
|
2193
|
+
* @public
|
|
1923
2194
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
1924
2195
|
* app.</p>
|
|
1925
2196
|
*/
|
|
1926
2197
|
environmentName: string | undefined;
|
|
1927
2198
|
/**
|
|
2199
|
+
* @public
|
|
1928
2200
|
* <p>The ID for the theme.</p>
|
|
1929
2201
|
*/
|
|
1930
2202
|
id: string | undefined;
|
|
1931
2203
|
/**
|
|
2204
|
+
* @public
|
|
1932
2205
|
* <p>The name of the theme.</p>
|
|
1933
2206
|
*/
|
|
1934
2207
|
name: string | undefined;
|
|
1935
2208
|
/**
|
|
2209
|
+
* @public
|
|
1936
2210
|
* <p>The time that the theme was created.</p>
|
|
1937
2211
|
*/
|
|
1938
2212
|
createdAt: Date | undefined;
|
|
1939
2213
|
/**
|
|
2214
|
+
* @public
|
|
1940
2215
|
* <p>The time that the theme was modified.</p>
|
|
1941
2216
|
*/
|
|
1942
2217
|
modifiedAt?: Date;
|
|
1943
2218
|
/**
|
|
2219
|
+
* @public
|
|
1944
2220
|
* <p>A list of key-value pairs that defines the properties of the theme.</p>
|
|
1945
2221
|
*/
|
|
1946
2222
|
values: ThemeValues[] | undefined;
|
|
1947
2223
|
/**
|
|
2224
|
+
* @public
|
|
1948
2225
|
* <p>Describes the properties that can be overriden to customize a theme.</p>
|
|
1949
2226
|
*/
|
|
1950
2227
|
overrides?: ThemeValues[];
|
|
1951
2228
|
/**
|
|
2229
|
+
* @public
|
|
1952
2230
|
* <p>One or more key-value pairs to use when tagging the theme.</p>
|
|
1953
2231
|
*/
|
|
1954
2232
|
tags?: Record<string, string>;
|
|
@@ -1959,18 +2237,22 @@ export interface Theme {
|
|
|
1959
2237
|
*/
|
|
1960
2238
|
export interface UpdateThemeData {
|
|
1961
2239
|
/**
|
|
2240
|
+
* @public
|
|
1962
2241
|
* <p>The unique ID of the theme to update.</p>
|
|
1963
2242
|
*/
|
|
1964
2243
|
id?: string;
|
|
1965
2244
|
/**
|
|
2245
|
+
* @public
|
|
1966
2246
|
* <p>The name of the theme to update.</p>
|
|
1967
2247
|
*/
|
|
1968
2248
|
name?: string;
|
|
1969
2249
|
/**
|
|
2250
|
+
* @public
|
|
1970
2251
|
* <p>A list of key-value pairs that define the theme's properties.</p>
|
|
1971
2252
|
*/
|
|
1972
2253
|
values: ThemeValues[] | undefined;
|
|
1973
2254
|
/**
|
|
2255
|
+
* @public
|
|
1974
2256
|
* <p>Describes the properties that can be overriden to customize the theme.</p>
|
|
1975
2257
|
*/
|
|
1976
2258
|
overrides?: ThemeValues[];
|
|
@@ -1982,14 +2264,17 @@ export interface UpdateThemeData {
|
|
|
1982
2264
|
*/
|
|
1983
2265
|
export interface MutationActionSetStateParameter {
|
|
1984
2266
|
/**
|
|
2267
|
+
* @public
|
|
1985
2268
|
* <p>The name of the component that is being modified.</p>
|
|
1986
2269
|
*/
|
|
1987
2270
|
componentName: string | undefined;
|
|
1988
2271
|
/**
|
|
2272
|
+
* @public
|
|
1989
2273
|
* <p>The name of the component property to apply the state configuration to.</p>
|
|
1990
2274
|
*/
|
|
1991
2275
|
property: string | undefined;
|
|
1992
2276
|
/**
|
|
2277
|
+
* @public
|
|
1993
2278
|
* <p>The state configuration to assign to the property.</p>
|
|
1994
2279
|
*/
|
|
1995
2280
|
set: ComponentProperty | undefined;
|
|
@@ -2002,31 +2287,38 @@ export interface MutationActionSetStateParameter {
|
|
|
2002
2287
|
*/
|
|
2003
2288
|
export interface ComponentConditionProperty {
|
|
2004
2289
|
/**
|
|
2290
|
+
* @public
|
|
2005
2291
|
* <p>The name of the conditional property.</p>
|
|
2006
2292
|
*/
|
|
2007
2293
|
property?: string;
|
|
2008
2294
|
/**
|
|
2295
|
+
* @public
|
|
2009
2296
|
* <p>The name of a field. Specify this when the property is a data model.</p>
|
|
2010
2297
|
*/
|
|
2011
2298
|
field?: string;
|
|
2012
2299
|
/**
|
|
2300
|
+
* @public
|
|
2013
2301
|
* <p>The operator to use to perform the evaluation, such as <code>eq</code> to represent
|
|
2014
2302
|
* equals.</p>
|
|
2015
2303
|
*/
|
|
2016
2304
|
operator?: string;
|
|
2017
2305
|
/**
|
|
2306
|
+
* @public
|
|
2018
2307
|
* <p>The value of the property to evaluate.</p>
|
|
2019
2308
|
*/
|
|
2020
2309
|
operand?: string;
|
|
2021
2310
|
/**
|
|
2311
|
+
* @public
|
|
2022
2312
|
* <p>The value to assign to the property if the condition is met.</p>
|
|
2023
2313
|
*/
|
|
2024
2314
|
then?: ComponentProperty;
|
|
2025
2315
|
/**
|
|
2316
|
+
* @public
|
|
2026
2317
|
* <p>The value to assign to the property if the condition is not met.</p>
|
|
2027
2318
|
*/
|
|
2028
2319
|
else?: ComponentProperty;
|
|
2029
2320
|
/**
|
|
2321
|
+
* @public
|
|
2030
2322
|
* <p>The type of the property to evaluate.</p>
|
|
2031
2323
|
*/
|
|
2032
2324
|
operandType?: string;
|
|
@@ -2036,19 +2328,23 @@ export interface ComponentConditionProperty {
|
|
|
2036
2328
|
*/
|
|
2037
2329
|
export interface CreateThemeRequest {
|
|
2038
2330
|
/**
|
|
2331
|
+
* @public
|
|
2039
2332
|
* <p>The unique ID of the Amplify app associated with the theme.</p>
|
|
2040
2333
|
*/
|
|
2041
2334
|
appId: string | undefined;
|
|
2042
2335
|
/**
|
|
2336
|
+
* @public
|
|
2043
2337
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
2044
2338
|
* app.</p>
|
|
2045
2339
|
*/
|
|
2046
2340
|
environmentName: string | undefined;
|
|
2047
2341
|
/**
|
|
2342
|
+
* @public
|
|
2048
2343
|
* <p>The unique client token.</p>
|
|
2049
2344
|
*/
|
|
2050
2345
|
clientToken?: string;
|
|
2051
2346
|
/**
|
|
2347
|
+
* @public
|
|
2052
2348
|
* <p>Represents the configuration of the theme to create.</p>
|
|
2053
2349
|
*/
|
|
2054
2350
|
themeToCreate: CreateThemeData | undefined;
|
|
@@ -2058,6 +2354,7 @@ export interface CreateThemeRequest {
|
|
|
2058
2354
|
*/
|
|
2059
2355
|
export interface CreateThemeResponse {
|
|
2060
2356
|
/**
|
|
2357
|
+
* @public
|
|
2061
2358
|
* <p>Describes the configuration of the new theme.</p>
|
|
2062
2359
|
*/
|
|
2063
2360
|
entity?: Theme;
|
|
@@ -2067,6 +2364,7 @@ export interface CreateThemeResponse {
|
|
|
2067
2364
|
*/
|
|
2068
2365
|
export interface GetThemeResponse {
|
|
2069
2366
|
/**
|
|
2367
|
+
* @public
|
|
2070
2368
|
* <p>Represents the configuration settings for the theme.</p>
|
|
2071
2369
|
*/
|
|
2072
2370
|
theme?: Theme;
|
|
@@ -2076,22 +2374,27 @@ export interface GetThemeResponse {
|
|
|
2076
2374
|
*/
|
|
2077
2375
|
export interface UpdateThemeRequest {
|
|
2078
2376
|
/**
|
|
2377
|
+
* @public
|
|
2079
2378
|
* <p>The unique ID for the Amplify app.</p>
|
|
2080
2379
|
*/
|
|
2081
2380
|
appId: string | undefined;
|
|
2082
2381
|
/**
|
|
2382
|
+
* @public
|
|
2083
2383
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
2084
2384
|
*/
|
|
2085
2385
|
environmentName: string | undefined;
|
|
2086
2386
|
/**
|
|
2387
|
+
* @public
|
|
2087
2388
|
* <p>The unique ID for the theme.</p>
|
|
2088
2389
|
*/
|
|
2089
2390
|
id: string | undefined;
|
|
2090
2391
|
/**
|
|
2392
|
+
* @public
|
|
2091
2393
|
* <p>The unique client token.</p>
|
|
2092
2394
|
*/
|
|
2093
2395
|
clientToken?: string;
|
|
2094
2396
|
/**
|
|
2397
|
+
* @public
|
|
2095
2398
|
* <p>The configuration of the updated theme.</p>
|
|
2096
2399
|
*/
|
|
2097
2400
|
updatedTheme: UpdateThemeData | undefined;
|
|
@@ -2101,6 +2404,7 @@ export interface UpdateThemeRequest {
|
|
|
2101
2404
|
*/
|
|
2102
2405
|
export interface UpdateThemeResponse {
|
|
2103
2406
|
/**
|
|
2407
|
+
* @public
|
|
2104
2408
|
* <p>Describes the configuration of the updated theme.</p>
|
|
2105
2409
|
*/
|
|
2106
2410
|
entity?: Theme;
|
|
@@ -2111,10 +2415,12 @@ export interface UpdateThemeResponse {
|
|
|
2111
2415
|
*/
|
|
2112
2416
|
export interface ValueMappings {
|
|
2113
2417
|
/**
|
|
2418
|
+
* @public
|
|
2114
2419
|
* <p>The value and display value pairs.</p>
|
|
2115
2420
|
*/
|
|
2116
2421
|
values: ValueMapping[] | undefined;
|
|
2117
2422
|
/**
|
|
2423
|
+
* @public
|
|
2118
2424
|
* <p>The information to bind fields to data at runtime.</p>
|
|
2119
2425
|
*/
|
|
2120
2426
|
bindingProperties?: Record<string, FormInputBindingPropertiesValue>;
|
|
@@ -2124,10 +2430,12 @@ export interface ValueMappings {
|
|
|
2124
2430
|
*/
|
|
2125
2431
|
export interface ExportThemesResponse {
|
|
2126
2432
|
/**
|
|
2433
|
+
* @public
|
|
2127
2434
|
* <p>Represents the configuration of the exported themes.</p>
|
|
2128
2435
|
*/
|
|
2129
2436
|
entities: Theme[] | undefined;
|
|
2130
2437
|
/**
|
|
2438
|
+
* @public
|
|
2131
2439
|
* <p>The pagination token that's included if more results are available.</p>
|
|
2132
2440
|
*/
|
|
2133
2441
|
nextToken?: string;
|
|
@@ -2138,67 +2446,83 @@ export interface ExportThemesResponse {
|
|
|
2138
2446
|
*/
|
|
2139
2447
|
export interface FieldInputConfig {
|
|
2140
2448
|
/**
|
|
2449
|
+
* @public
|
|
2141
2450
|
* <p>The input type for the field. </p>
|
|
2142
2451
|
*/
|
|
2143
2452
|
type: string | undefined;
|
|
2144
2453
|
/**
|
|
2454
|
+
* @public
|
|
2145
2455
|
* <p>Specifies a field that requires input.</p>
|
|
2146
2456
|
*/
|
|
2147
2457
|
required?: boolean;
|
|
2148
2458
|
/**
|
|
2459
|
+
* @public
|
|
2149
2460
|
* <p>Specifies a read only field.</p>
|
|
2150
2461
|
*/
|
|
2151
2462
|
readOnly?: boolean;
|
|
2152
2463
|
/**
|
|
2464
|
+
* @public
|
|
2153
2465
|
* <p>The text to display as a placeholder for the field.</p>
|
|
2154
2466
|
*/
|
|
2155
2467
|
placeholder?: string;
|
|
2156
2468
|
/**
|
|
2469
|
+
* @public
|
|
2157
2470
|
* <p>The default value for the field.</p>
|
|
2158
2471
|
*/
|
|
2159
2472
|
defaultValue?: string;
|
|
2160
2473
|
/**
|
|
2474
|
+
* @public
|
|
2161
2475
|
* <p>The text to display to describe the field.</p>
|
|
2162
2476
|
*/
|
|
2163
2477
|
descriptiveText?: string;
|
|
2164
2478
|
/**
|
|
2479
|
+
* @public
|
|
2165
2480
|
* <p>Specifies whether a field has a default value.</p>
|
|
2166
2481
|
*/
|
|
2167
2482
|
defaultChecked?: boolean;
|
|
2168
2483
|
/**
|
|
2484
|
+
* @public
|
|
2169
2485
|
* <p>The default country code for a phone number.</p>
|
|
2170
2486
|
*/
|
|
2171
2487
|
defaultCountryCode?: string;
|
|
2172
2488
|
/**
|
|
2489
|
+
* @public
|
|
2173
2490
|
* <p>The information to use to customize the input fields with data at runtime.</p>
|
|
2174
2491
|
*/
|
|
2175
2492
|
valueMappings?: ValueMappings;
|
|
2176
2493
|
/**
|
|
2494
|
+
* @public
|
|
2177
2495
|
* <p>The name of the field.</p>
|
|
2178
2496
|
*/
|
|
2179
2497
|
name?: string;
|
|
2180
2498
|
/**
|
|
2499
|
+
* @public
|
|
2181
2500
|
* <p>The minimum value to display for the field.</p>
|
|
2182
2501
|
*/
|
|
2183
2502
|
minValue?: number;
|
|
2184
2503
|
/**
|
|
2504
|
+
* @public
|
|
2185
2505
|
* <p>The maximum value to display for the field.</p>
|
|
2186
2506
|
*/
|
|
2187
2507
|
maxValue?: number;
|
|
2188
2508
|
/**
|
|
2509
|
+
* @public
|
|
2189
2510
|
* <p>The stepping increment for a numeric value in a field.</p>
|
|
2190
2511
|
*/
|
|
2191
2512
|
step?: number;
|
|
2192
2513
|
/**
|
|
2514
|
+
* @public
|
|
2193
2515
|
* <p>The value for the field.</p>
|
|
2194
2516
|
*/
|
|
2195
2517
|
value?: string;
|
|
2196
2518
|
/**
|
|
2519
|
+
* @public
|
|
2197
2520
|
* <p>Specifies whether to render the field as an array. This property is ignored if the
|
|
2198
2521
|
* <code>dataSourceType</code> for the form is a Data Store.</p>
|
|
2199
2522
|
*/
|
|
2200
2523
|
isArray?: boolean;
|
|
2201
2524
|
/**
|
|
2525
|
+
* @public
|
|
2202
2526
|
* <p>The configuration for the file uploader field.</p>
|
|
2203
2527
|
*/
|
|
2204
2528
|
fileUploaderConfig?: FileUploaderFieldConfig;
|
|
@@ -2209,22 +2533,27 @@ export interface FieldInputConfig {
|
|
|
2209
2533
|
*/
|
|
2210
2534
|
export interface FieldConfig {
|
|
2211
2535
|
/**
|
|
2536
|
+
* @public
|
|
2212
2537
|
* <p>The label for the field.</p>
|
|
2213
2538
|
*/
|
|
2214
2539
|
label?: string;
|
|
2215
2540
|
/**
|
|
2541
|
+
* @public
|
|
2216
2542
|
* <p>Specifies the field position.</p>
|
|
2217
2543
|
*/
|
|
2218
2544
|
position?: FieldPosition;
|
|
2219
2545
|
/**
|
|
2546
|
+
* @public
|
|
2220
2547
|
* <p>Specifies whether to hide a field.</p>
|
|
2221
2548
|
*/
|
|
2222
2549
|
excluded?: boolean;
|
|
2223
2550
|
/**
|
|
2551
|
+
* @public
|
|
2224
2552
|
* <p>Describes the configuration for the default input value to display for a field.</p>
|
|
2225
2553
|
*/
|
|
2226
2554
|
inputType?: FieldInputConfig;
|
|
2227
2555
|
/**
|
|
2556
|
+
* @public
|
|
2228
2557
|
* <p>The validations to perform on the value in the field.</p>
|
|
2229
2558
|
*/
|
|
2230
2559
|
validations?: FieldValidationConfiguration[];
|
|
@@ -2235,44 +2564,54 @@ export interface FieldConfig {
|
|
|
2235
2564
|
*/
|
|
2236
2565
|
export interface CreateFormData {
|
|
2237
2566
|
/**
|
|
2567
|
+
* @public
|
|
2238
2568
|
* <p>The name of the form.</p>
|
|
2239
2569
|
*/
|
|
2240
2570
|
name: string | undefined;
|
|
2241
2571
|
/**
|
|
2572
|
+
* @public
|
|
2242
2573
|
* <p>The type of data source to use to create the form.</p>
|
|
2243
2574
|
*/
|
|
2244
2575
|
dataType: FormDataTypeConfig | undefined;
|
|
2245
2576
|
/**
|
|
2577
|
+
* @public
|
|
2246
2578
|
* <p>Specifies whether to perform a create or update action on the form.</p>
|
|
2247
2579
|
*/
|
|
2248
2580
|
formActionType: FormActionType | string | undefined;
|
|
2249
2581
|
/**
|
|
2582
|
+
* @public
|
|
2250
2583
|
* <p>The configuration information for the form's fields.</p>
|
|
2251
2584
|
*/
|
|
2252
2585
|
fields: Record<string, FieldConfig> | undefined;
|
|
2253
2586
|
/**
|
|
2587
|
+
* @public
|
|
2254
2588
|
* <p>The configuration for the form's style.</p>
|
|
2255
2589
|
*/
|
|
2256
2590
|
style: FormStyle | undefined;
|
|
2257
2591
|
/**
|
|
2592
|
+
* @public
|
|
2258
2593
|
* <p>The configuration information for the visual helper elements for the form. These elements
|
|
2259
2594
|
* are not associated with any data.</p>
|
|
2260
2595
|
*/
|
|
2261
2596
|
sectionalElements: Record<string, SectionalElement> | undefined;
|
|
2262
2597
|
/**
|
|
2598
|
+
* @public
|
|
2263
2599
|
* <p>The schema version of the form.</p>
|
|
2264
2600
|
*/
|
|
2265
2601
|
schemaVersion: string | undefined;
|
|
2266
2602
|
/**
|
|
2603
|
+
* @public
|
|
2267
2604
|
* <p>The <code>FormCTA</code> object that stores the call to action configuration for the
|
|
2268
2605
|
* form.</p>
|
|
2269
2606
|
*/
|
|
2270
2607
|
cta?: FormCTA;
|
|
2271
2608
|
/**
|
|
2609
|
+
* @public
|
|
2272
2610
|
* <p>One or more key-value pairs to use when tagging the form data.</p>
|
|
2273
2611
|
*/
|
|
2274
2612
|
tags?: Record<string, string>;
|
|
2275
2613
|
/**
|
|
2614
|
+
* @public
|
|
2276
2615
|
* <p>Specifies an icon or decoration to display on the form.</p>
|
|
2277
2616
|
*/
|
|
2278
2617
|
labelDecorator?: LabelDecorator | string;
|
|
@@ -2285,55 +2624,68 @@ export interface CreateFormData {
|
|
|
2285
2624
|
*/
|
|
2286
2625
|
export interface Form {
|
|
2287
2626
|
/**
|
|
2627
|
+
* @public
|
|
2288
2628
|
* <p>The unique ID of the Amplify app associated with the form.</p>
|
|
2289
2629
|
*/
|
|
2290
2630
|
appId: string | undefined;
|
|
2291
2631
|
/**
|
|
2632
|
+
* @public
|
|
2292
2633
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
2293
2634
|
*/
|
|
2294
2635
|
environmentName: string | undefined;
|
|
2295
2636
|
/**
|
|
2637
|
+
* @public
|
|
2296
2638
|
* <p>The unique ID of the form.</p>
|
|
2297
2639
|
*/
|
|
2298
2640
|
id: string | undefined;
|
|
2299
2641
|
/**
|
|
2642
|
+
* @public
|
|
2300
2643
|
* <p>The name of the form.</p>
|
|
2301
2644
|
*/
|
|
2302
2645
|
name: string | undefined;
|
|
2303
2646
|
/**
|
|
2647
|
+
* @public
|
|
2304
2648
|
* <p>The operation to perform on the specified form.</p>
|
|
2305
2649
|
*/
|
|
2306
2650
|
formActionType: FormActionType | string | undefined;
|
|
2307
2651
|
/**
|
|
2652
|
+
* @public
|
|
2308
2653
|
* <p>Stores the configuration for the form's style.</p>
|
|
2309
2654
|
*/
|
|
2310
2655
|
style: FormStyle | undefined;
|
|
2311
2656
|
/**
|
|
2657
|
+
* @public
|
|
2312
2658
|
* <p>The type of data source to use to create the form.</p>
|
|
2313
2659
|
*/
|
|
2314
2660
|
dataType: FormDataTypeConfig | undefined;
|
|
2315
2661
|
/**
|
|
2662
|
+
* @public
|
|
2316
2663
|
* <p>Stores the information about the form's fields.</p>
|
|
2317
2664
|
*/
|
|
2318
2665
|
fields: Record<string, FieldConfig> | undefined;
|
|
2319
2666
|
/**
|
|
2667
|
+
* @public
|
|
2320
2668
|
* <p>Stores the visual helper elements for the form that are not associated with any
|
|
2321
2669
|
* data.</p>
|
|
2322
2670
|
*/
|
|
2323
2671
|
sectionalElements: Record<string, SectionalElement> | undefined;
|
|
2324
2672
|
/**
|
|
2673
|
+
* @public
|
|
2325
2674
|
* <p>The schema version of the form when it was imported.</p>
|
|
2326
2675
|
*/
|
|
2327
2676
|
schemaVersion: string | undefined;
|
|
2328
2677
|
/**
|
|
2678
|
+
* @public
|
|
2329
2679
|
* <p>One or more key-value pairs to use when tagging the form.</p>
|
|
2330
2680
|
*/
|
|
2331
2681
|
tags?: Record<string, string>;
|
|
2332
2682
|
/**
|
|
2683
|
+
* @public
|
|
2333
2684
|
* <p>Stores the call to action configuration for the form.</p>
|
|
2334
2685
|
*/
|
|
2335
2686
|
cta?: FormCTA;
|
|
2336
2687
|
/**
|
|
2688
|
+
* @public
|
|
2337
2689
|
* <p>Specifies an icon or decoration to display on the form.</p>
|
|
2338
2690
|
*/
|
|
2339
2691
|
labelDecorator?: LabelDecorator | string;
|
|
@@ -2344,40 +2696,49 @@ export interface Form {
|
|
|
2344
2696
|
*/
|
|
2345
2697
|
export interface UpdateFormData {
|
|
2346
2698
|
/**
|
|
2699
|
+
* @public
|
|
2347
2700
|
* <p>The name of the form.</p>
|
|
2348
2701
|
*/
|
|
2349
2702
|
name?: string;
|
|
2350
2703
|
/**
|
|
2704
|
+
* @public
|
|
2351
2705
|
* <p>The type of data source to use to create the form.</p>
|
|
2352
2706
|
*/
|
|
2353
2707
|
dataType?: FormDataTypeConfig;
|
|
2354
2708
|
/**
|
|
2709
|
+
* @public
|
|
2355
2710
|
* <p>Specifies whether to perform a create or update action on the form.</p>
|
|
2356
2711
|
*/
|
|
2357
2712
|
formActionType?: FormActionType | string;
|
|
2358
2713
|
/**
|
|
2714
|
+
* @public
|
|
2359
2715
|
* <p>The configuration information for the form's fields.</p>
|
|
2360
2716
|
*/
|
|
2361
2717
|
fields?: Record<string, FieldConfig>;
|
|
2362
2718
|
/**
|
|
2719
|
+
* @public
|
|
2363
2720
|
* <p>The configuration for the form's style.</p>
|
|
2364
2721
|
*/
|
|
2365
2722
|
style?: FormStyle;
|
|
2366
2723
|
/**
|
|
2724
|
+
* @public
|
|
2367
2725
|
* <p>The configuration information for the visual helper elements for the form. These elements
|
|
2368
2726
|
* are not associated with any data.</p>
|
|
2369
2727
|
*/
|
|
2370
2728
|
sectionalElements?: Record<string, SectionalElement>;
|
|
2371
2729
|
/**
|
|
2730
|
+
* @public
|
|
2372
2731
|
* <p>The schema version of the form.</p>
|
|
2373
2732
|
*/
|
|
2374
2733
|
schemaVersion?: string;
|
|
2375
2734
|
/**
|
|
2735
|
+
* @public
|
|
2376
2736
|
* <p>The <code>FormCTA</code> object that stores the call to action configuration for the
|
|
2377
2737
|
* form.</p>
|
|
2378
2738
|
*/
|
|
2379
2739
|
cta?: FormCTA;
|
|
2380
2740
|
/**
|
|
2741
|
+
* @public
|
|
2381
2742
|
* <p>Specifies an icon or decoration to display on the form.</p>
|
|
2382
2743
|
*/
|
|
2383
2744
|
labelDecorator?: LabelDecorator | string;
|
|
@@ -2387,18 +2748,22 @@ export interface UpdateFormData {
|
|
|
2387
2748
|
*/
|
|
2388
2749
|
export interface CreateFormRequest {
|
|
2389
2750
|
/**
|
|
2751
|
+
* @public
|
|
2390
2752
|
* <p>The unique ID of the Amplify app to associate with the form.</p>
|
|
2391
2753
|
*/
|
|
2392
2754
|
appId: string | undefined;
|
|
2393
2755
|
/**
|
|
2756
|
+
* @public
|
|
2394
2757
|
* <p>The name of the backend environment that is a part of the Amplify app.</p>
|
|
2395
2758
|
*/
|
|
2396
2759
|
environmentName: string | undefined;
|
|
2397
2760
|
/**
|
|
2761
|
+
* @public
|
|
2398
2762
|
* <p>The unique client token.</p>
|
|
2399
2763
|
*/
|
|
2400
2764
|
clientToken?: string;
|
|
2401
2765
|
/**
|
|
2766
|
+
* @public
|
|
2402
2767
|
* <p>Represents the configuration of the form to create.</p>
|
|
2403
2768
|
*/
|
|
2404
2769
|
formToCreate: CreateFormData | undefined;
|
|
@@ -2408,6 +2773,7 @@ export interface CreateFormRequest {
|
|
|
2408
2773
|
*/
|
|
2409
2774
|
export interface CreateFormResponse {
|
|
2410
2775
|
/**
|
|
2776
|
+
* @public
|
|
2411
2777
|
* <p>Describes the configuration of the new form.</p>
|
|
2412
2778
|
*/
|
|
2413
2779
|
entity?: Form;
|
|
@@ -2417,6 +2783,7 @@ export interface CreateFormResponse {
|
|
|
2417
2783
|
*/
|
|
2418
2784
|
export interface GetFormResponse {
|
|
2419
2785
|
/**
|
|
2786
|
+
* @public
|
|
2420
2787
|
* <p>Represents the configuration settings for the form.</p>
|
|
2421
2788
|
*/
|
|
2422
2789
|
form?: Form;
|
|
@@ -2426,22 +2793,27 @@ export interface GetFormResponse {
|
|
|
2426
2793
|
*/
|
|
2427
2794
|
export interface UpdateFormRequest {
|
|
2428
2795
|
/**
|
|
2796
|
+
* @public
|
|
2429
2797
|
* <p>The unique ID for the Amplify app.</p>
|
|
2430
2798
|
*/
|
|
2431
2799
|
appId: string | undefined;
|
|
2432
2800
|
/**
|
|
2801
|
+
* @public
|
|
2433
2802
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
2434
2803
|
*/
|
|
2435
2804
|
environmentName: string | undefined;
|
|
2436
2805
|
/**
|
|
2806
|
+
* @public
|
|
2437
2807
|
* <p>The unique ID for the form.</p>
|
|
2438
2808
|
*/
|
|
2439
2809
|
id: string | undefined;
|
|
2440
2810
|
/**
|
|
2811
|
+
* @public
|
|
2441
2812
|
* <p>The unique client token.</p>
|
|
2442
2813
|
*/
|
|
2443
2814
|
clientToken?: string;
|
|
2444
2815
|
/**
|
|
2816
|
+
* @public
|
|
2445
2817
|
* <p>The request accepts the following data in JSON format.</p>
|
|
2446
2818
|
*/
|
|
2447
2819
|
updatedForm: UpdateFormData | undefined;
|
|
@@ -2451,6 +2823,7 @@ export interface UpdateFormRequest {
|
|
|
2451
2823
|
*/
|
|
2452
2824
|
export interface UpdateFormResponse {
|
|
2453
2825
|
/**
|
|
2826
|
+
* @public
|
|
2454
2827
|
* <p>Describes the configuration of the updated form.</p>
|
|
2455
2828
|
*/
|
|
2456
2829
|
entity?: Form;
|
|
@@ -2460,10 +2833,12 @@ export interface UpdateFormResponse {
|
|
|
2460
2833
|
*/
|
|
2461
2834
|
export interface ExportFormsResponse {
|
|
2462
2835
|
/**
|
|
2836
|
+
* @public
|
|
2463
2837
|
* <p>Represents the configuration of the exported forms.</p>
|
|
2464
2838
|
*/
|
|
2465
2839
|
entities: Form[] | undefined;
|
|
2466
2840
|
/**
|
|
2841
|
+
* @public
|
|
2467
2842
|
* <p>The pagination token that's included if more results are available.</p>
|
|
2468
2843
|
*/
|
|
2469
2844
|
nextToken?: string;
|
|
@@ -2477,43 +2852,52 @@ export interface ExportFormsResponse {
|
|
|
2477
2852
|
*/
|
|
2478
2853
|
export interface ActionParameters {
|
|
2479
2854
|
/**
|
|
2855
|
+
* @public
|
|
2480
2856
|
* <p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>.
|
|
2481
2857
|
* This value is required for a navigation action.</p>
|
|
2482
2858
|
*/
|
|
2483
2859
|
type?: ComponentProperty;
|
|
2484
2860
|
/**
|
|
2861
|
+
* @public
|
|
2485
2862
|
* <p>The URL to the location to open. Specify this value for a navigation action.</p>
|
|
2486
2863
|
*/
|
|
2487
2864
|
url?: ComponentProperty;
|
|
2488
2865
|
/**
|
|
2866
|
+
* @public
|
|
2489
2867
|
* <p>The HTML anchor link to the location to open. Specify this value for a navigation
|
|
2490
2868
|
* action.</p>
|
|
2491
2869
|
*/
|
|
2492
2870
|
anchor?: ComponentProperty;
|
|
2493
2871
|
/**
|
|
2872
|
+
* @public
|
|
2494
2873
|
* <p>The element within the same component to modify when the action occurs.</p>
|
|
2495
2874
|
*/
|
|
2496
2875
|
target?: ComponentProperty;
|
|
2497
2876
|
/**
|
|
2877
|
+
* @public
|
|
2498
2878
|
* <p>Specifies whether the user should be signed out globally. Specify this value for an auth
|
|
2499
2879
|
* sign out action.</p>
|
|
2500
2880
|
*/
|
|
2501
2881
|
global?: ComponentProperty;
|
|
2502
2882
|
/**
|
|
2883
|
+
* @public
|
|
2503
2884
|
* <p>The name of the data model. Use when the action performs an operation on an Amplify DataStore model.</p>
|
|
2504
2885
|
*/
|
|
2505
2886
|
model?: string;
|
|
2506
2887
|
/**
|
|
2888
|
+
* @public
|
|
2507
2889
|
* <p>The unique ID of the component that the <code>ActionParameters</code> apply to.</p>
|
|
2508
2890
|
*/
|
|
2509
2891
|
id?: ComponentProperty;
|
|
2510
2892
|
/**
|
|
2893
|
+
* @public
|
|
2511
2894
|
* <p>A dictionary of key-value pairs mapping Amplify Studio properties to fields
|
|
2512
2895
|
* in a data model. Use when the action performs an operation on an Amplify
|
|
2513
2896
|
* DataStore model.</p>
|
|
2514
2897
|
*/
|
|
2515
2898
|
fields?: Record<string, ComponentProperty>;
|
|
2516
2899
|
/**
|
|
2900
|
+
* @public
|
|
2517
2901
|
* <p>A key-value pair that specifies the state property name and its initial value.</p>
|
|
2518
2902
|
*/
|
|
2519
2903
|
state?: MutationActionSetStateParameter;
|
|
@@ -2526,14 +2910,17 @@ export interface ActionParameters {
|
|
|
2526
2910
|
*/
|
|
2527
2911
|
export interface ComponentEvent {
|
|
2528
2912
|
/**
|
|
2913
|
+
* @public
|
|
2529
2914
|
* <p>The action to perform when a specific event is raised.</p>
|
|
2530
2915
|
*/
|
|
2531
2916
|
action?: string;
|
|
2532
2917
|
/**
|
|
2918
|
+
* @public
|
|
2533
2919
|
* <p>Describes information about the action.</p>
|
|
2534
2920
|
*/
|
|
2535
2921
|
parameters?: ActionParameters;
|
|
2536
2922
|
/**
|
|
2923
|
+
* @public
|
|
2537
2924
|
* <p>Binds an event to an action on a component. When you specify a <code>bindingEvent</code>,
|
|
2538
2925
|
* the event is called when the action is performed.</p>
|
|
2539
2926
|
*/
|
|
@@ -2545,29 +2932,35 @@ export interface ComponentEvent {
|
|
|
2545
2932
|
*/
|
|
2546
2933
|
export interface ComponentChild {
|
|
2547
2934
|
/**
|
|
2935
|
+
* @public
|
|
2548
2936
|
* <p>The type of the child component. </p>
|
|
2549
2937
|
*/
|
|
2550
2938
|
componentType: string | undefined;
|
|
2551
2939
|
/**
|
|
2940
|
+
* @public
|
|
2552
2941
|
* <p>The name of the child component.</p>
|
|
2553
2942
|
*/
|
|
2554
2943
|
name: string | undefined;
|
|
2555
2944
|
/**
|
|
2945
|
+
* @public
|
|
2556
2946
|
* <p>Describes the properties of the child component. You can't specify <code>tags</code> as a
|
|
2557
2947
|
* valid property for <code>properties</code>.</p>
|
|
2558
2948
|
*/
|
|
2559
2949
|
properties: Record<string, ComponentProperty> | undefined;
|
|
2560
2950
|
/**
|
|
2951
|
+
* @public
|
|
2561
2952
|
* <p>The list of <code>ComponentChild</code> instances for this component.</p>
|
|
2562
2953
|
*/
|
|
2563
2954
|
children?: ComponentChild[];
|
|
2564
2955
|
/**
|
|
2956
|
+
* @public
|
|
2565
2957
|
* <p>Describes the events that can be raised on the child component. Use for the workflow
|
|
2566
2958
|
* feature in Amplify Studio that allows you to bind events and actions to
|
|
2567
2959
|
* components.</p>
|
|
2568
2960
|
*/
|
|
2569
2961
|
events?: Record<string, ComponentEvent>;
|
|
2570
2962
|
/**
|
|
2963
|
+
* @public
|
|
2571
2964
|
* <p>The unique ID of the child component in its original source system, such as Figma.</p>
|
|
2572
2965
|
*/
|
|
2573
2966
|
sourceId?: string;
|
|
@@ -2581,82 +2974,99 @@ export interface ComponentChild {
|
|
|
2581
2974
|
*/
|
|
2582
2975
|
export interface Component {
|
|
2583
2976
|
/**
|
|
2977
|
+
* @public
|
|
2584
2978
|
* <p>The unique ID of the Amplify app associated with the component.</p>
|
|
2585
2979
|
*/
|
|
2586
2980
|
appId: string | undefined;
|
|
2587
2981
|
/**
|
|
2982
|
+
* @public
|
|
2588
2983
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
2589
2984
|
* app.</p>
|
|
2590
2985
|
*/
|
|
2591
2986
|
environmentName: string | undefined;
|
|
2592
2987
|
/**
|
|
2988
|
+
* @public
|
|
2593
2989
|
* <p>The unique ID of the component in its original source system, such as Figma.</p>
|
|
2594
2990
|
*/
|
|
2595
2991
|
sourceId?: string;
|
|
2596
2992
|
/**
|
|
2993
|
+
* @public
|
|
2597
2994
|
* <p>The unique ID of the component.</p>
|
|
2598
2995
|
*/
|
|
2599
2996
|
id: string | undefined;
|
|
2600
2997
|
/**
|
|
2998
|
+
* @public
|
|
2601
2999
|
* <p>The name of the component.</p>
|
|
2602
3000
|
*/
|
|
2603
3001
|
name: string | undefined;
|
|
2604
3002
|
/**
|
|
3003
|
+
* @public
|
|
2605
3004
|
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
2606
3005
|
* another custom component.</p>
|
|
2607
3006
|
*/
|
|
2608
3007
|
componentType: string | undefined;
|
|
2609
3008
|
/**
|
|
3009
|
+
* @public
|
|
2610
3010
|
* <p>Describes the component's properties. You can't specify <code>tags</code> as a valid
|
|
2611
3011
|
* property for <code>properties</code>.</p>
|
|
2612
3012
|
*/
|
|
2613
3013
|
properties: Record<string, ComponentProperty> | undefined;
|
|
2614
3014
|
/**
|
|
3015
|
+
* @public
|
|
2615
3016
|
* <p>A list of the component's <code>ComponentChild</code> instances.</p>
|
|
2616
3017
|
*/
|
|
2617
3018
|
children?: ComponentChild[];
|
|
2618
3019
|
/**
|
|
3020
|
+
* @public
|
|
2619
3021
|
* <p>A list of the component's variants. A variant is a unique style configuration of a main
|
|
2620
3022
|
* component.</p>
|
|
2621
3023
|
*/
|
|
2622
3024
|
variants: ComponentVariant[] | undefined;
|
|
2623
3025
|
/**
|
|
3026
|
+
* @public
|
|
2624
3027
|
* <p>Describes the component's properties that can be overriden in a customized instance of the
|
|
2625
3028
|
* component. You can't specify <code>tags</code> as a valid property for
|
|
2626
3029
|
* <code>overrides</code>.</p>
|
|
2627
3030
|
*/
|
|
2628
3031
|
overrides: Record<string, Record<string, string>> | undefined;
|
|
2629
3032
|
/**
|
|
3033
|
+
* @public
|
|
2630
3034
|
* <p>The information to connect a component's properties to data at runtime. You can't specify
|
|
2631
3035
|
* <code>tags</code> as a valid property for <code>bindingProperties</code>.</p>
|
|
2632
3036
|
* <p/>
|
|
2633
3037
|
*/
|
|
2634
3038
|
bindingProperties: Record<string, ComponentBindingPropertiesValue> | undefined;
|
|
2635
3039
|
/**
|
|
3040
|
+
* @public
|
|
2636
3041
|
* <p>The data binding configuration for the component's properties. Use this for a collection
|
|
2637
3042
|
* component. You can't specify <code>tags</code> as a valid property for
|
|
2638
3043
|
* <code>collectionProperties</code>.</p>
|
|
2639
3044
|
*/
|
|
2640
3045
|
collectionProperties?: Record<string, ComponentDataConfiguration>;
|
|
2641
3046
|
/**
|
|
3047
|
+
* @public
|
|
2642
3048
|
* <p>The time that the component was created.</p>
|
|
2643
3049
|
*/
|
|
2644
3050
|
createdAt: Date | undefined;
|
|
2645
3051
|
/**
|
|
3052
|
+
* @public
|
|
2646
3053
|
* <p>The time that the component was modified.</p>
|
|
2647
3054
|
*/
|
|
2648
3055
|
modifiedAt?: Date;
|
|
2649
3056
|
/**
|
|
3057
|
+
* @public
|
|
2650
3058
|
* <p>One or more key-value pairs to use when tagging the component.</p>
|
|
2651
3059
|
*/
|
|
2652
3060
|
tags?: Record<string, string>;
|
|
2653
3061
|
/**
|
|
3062
|
+
* @public
|
|
2654
3063
|
* <p>Describes the events that can be raised on the component. Use for the workflow feature in
|
|
2655
3064
|
* Amplify Studio that allows you to bind events and actions to
|
|
2656
3065
|
* components.</p>
|
|
2657
3066
|
*/
|
|
2658
3067
|
events?: Record<string, ComponentEvent>;
|
|
2659
3068
|
/**
|
|
3069
|
+
* @public
|
|
2660
3070
|
* <p>The schema version of the component when it was imported.</p>
|
|
2661
3071
|
*/
|
|
2662
3072
|
schemaVersion?: string;
|
|
@@ -2667,53 +3077,65 @@ export interface Component {
|
|
|
2667
3077
|
*/
|
|
2668
3078
|
export interface CreateComponentData {
|
|
2669
3079
|
/**
|
|
3080
|
+
* @public
|
|
2670
3081
|
* <p>The name of the component</p>
|
|
2671
3082
|
*/
|
|
2672
3083
|
name: string | undefined;
|
|
2673
3084
|
/**
|
|
3085
|
+
* @public
|
|
2674
3086
|
* <p>The unique ID of the component in its original source system, such as Figma.</p>
|
|
2675
3087
|
*/
|
|
2676
3088
|
sourceId?: string;
|
|
2677
3089
|
/**
|
|
3090
|
+
* @public
|
|
2678
3091
|
* <p>The component type. This can be an Amplify custom UI component or another
|
|
2679
3092
|
* custom component.</p>
|
|
2680
3093
|
*/
|
|
2681
3094
|
componentType: string | undefined;
|
|
2682
3095
|
/**
|
|
3096
|
+
* @public
|
|
2683
3097
|
* <p>Describes the component's properties.</p>
|
|
2684
3098
|
*/
|
|
2685
3099
|
properties: Record<string, ComponentProperty> | undefined;
|
|
2686
3100
|
/**
|
|
3101
|
+
* @public
|
|
2687
3102
|
* <p>A list of child components that are instances of the main component.</p>
|
|
2688
3103
|
*/
|
|
2689
3104
|
children?: ComponentChild[];
|
|
2690
3105
|
/**
|
|
3106
|
+
* @public
|
|
2691
3107
|
* <p>A list of the unique variants of this component.</p>
|
|
2692
3108
|
*/
|
|
2693
3109
|
variants: ComponentVariant[] | undefined;
|
|
2694
3110
|
/**
|
|
3111
|
+
* @public
|
|
2695
3112
|
* <p>Describes the component properties that can be overriden to customize an instance of the
|
|
2696
3113
|
* component.</p>
|
|
2697
3114
|
*/
|
|
2698
3115
|
overrides: Record<string, Record<string, string>> | undefined;
|
|
2699
3116
|
/**
|
|
3117
|
+
* @public
|
|
2700
3118
|
* <p>The data binding information for the component's properties.</p>
|
|
2701
3119
|
*/
|
|
2702
3120
|
bindingProperties: Record<string, ComponentBindingPropertiesValue> | undefined;
|
|
2703
3121
|
/**
|
|
3122
|
+
* @public
|
|
2704
3123
|
* <p>The data binding configuration for customizing a component's properties. Use this for a
|
|
2705
3124
|
* collection component.</p>
|
|
2706
3125
|
*/
|
|
2707
3126
|
collectionProperties?: Record<string, ComponentDataConfiguration>;
|
|
2708
3127
|
/**
|
|
3128
|
+
* @public
|
|
2709
3129
|
* <p>One or more key-value pairs to use when tagging the component data.</p>
|
|
2710
3130
|
*/
|
|
2711
3131
|
tags?: Record<string, string>;
|
|
2712
3132
|
/**
|
|
3133
|
+
* @public
|
|
2713
3134
|
* <p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>
|
|
2714
3135
|
*/
|
|
2715
3136
|
events?: Record<string, ComponentEvent>;
|
|
2716
3137
|
/**
|
|
3138
|
+
* @public
|
|
2717
3139
|
* <p>The schema version of the component when it was imported.</p>
|
|
2718
3140
|
*/
|
|
2719
3141
|
schemaVersion?: string;
|
|
@@ -2724,52 +3146,64 @@ export interface CreateComponentData {
|
|
|
2724
3146
|
*/
|
|
2725
3147
|
export interface UpdateComponentData {
|
|
2726
3148
|
/**
|
|
3149
|
+
* @public
|
|
2727
3150
|
* <p>The unique ID of the component to update.</p>
|
|
2728
3151
|
*/
|
|
2729
3152
|
id?: string;
|
|
2730
3153
|
/**
|
|
3154
|
+
* @public
|
|
2731
3155
|
* <p>The name of the component to update.</p>
|
|
2732
3156
|
*/
|
|
2733
3157
|
name?: string;
|
|
2734
3158
|
/**
|
|
3159
|
+
* @public
|
|
2735
3160
|
* <p>The unique ID of the component in its original source system, such as Figma.</p>
|
|
2736
3161
|
*/
|
|
2737
3162
|
sourceId?: string;
|
|
2738
3163
|
/**
|
|
3164
|
+
* @public
|
|
2739
3165
|
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
2740
3166
|
* another custom component.</p>
|
|
2741
3167
|
*/
|
|
2742
3168
|
componentType?: string;
|
|
2743
3169
|
/**
|
|
3170
|
+
* @public
|
|
2744
3171
|
* <p>Describes the component's properties.</p>
|
|
2745
3172
|
*/
|
|
2746
3173
|
properties?: Record<string, ComponentProperty>;
|
|
2747
3174
|
/**
|
|
3175
|
+
* @public
|
|
2748
3176
|
* <p>The components that are instances of the main component.</p>
|
|
2749
3177
|
*/
|
|
2750
3178
|
children?: ComponentChild[];
|
|
2751
3179
|
/**
|
|
3180
|
+
* @public
|
|
2752
3181
|
* <p>A list of the unique variants of the main component being updated.</p>
|
|
2753
3182
|
*/
|
|
2754
3183
|
variants?: ComponentVariant[];
|
|
2755
3184
|
/**
|
|
3185
|
+
* @public
|
|
2756
3186
|
* <p>Describes the properties that can be overriden to customize the component.</p>
|
|
2757
3187
|
*/
|
|
2758
3188
|
overrides?: Record<string, Record<string, string>>;
|
|
2759
3189
|
/**
|
|
3190
|
+
* @public
|
|
2760
3191
|
* <p>The data binding information for the component's properties.</p>
|
|
2761
3192
|
*/
|
|
2762
3193
|
bindingProperties?: Record<string, ComponentBindingPropertiesValue>;
|
|
2763
3194
|
/**
|
|
3195
|
+
* @public
|
|
2764
3196
|
* <p>The configuration for binding a component's properties to a data model. Use this for a
|
|
2765
3197
|
* collection component.</p>
|
|
2766
3198
|
*/
|
|
2767
3199
|
collectionProperties?: Record<string, ComponentDataConfiguration>;
|
|
2768
3200
|
/**
|
|
3201
|
+
* @public
|
|
2769
3202
|
* <p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>
|
|
2770
3203
|
*/
|
|
2771
3204
|
events?: Record<string, ComponentEvent>;
|
|
2772
3205
|
/**
|
|
3206
|
+
* @public
|
|
2773
3207
|
* <p>The schema version of the component when it was imported.</p>
|
|
2774
3208
|
*/
|
|
2775
3209
|
schemaVersion?: string;
|
|
@@ -2779,19 +3213,23 @@ export interface UpdateComponentData {
|
|
|
2779
3213
|
*/
|
|
2780
3214
|
export interface CreateComponentRequest {
|
|
2781
3215
|
/**
|
|
3216
|
+
* @public
|
|
2782
3217
|
* <p>The unique ID of the Amplify app to associate with the component.</p>
|
|
2783
3218
|
*/
|
|
2784
3219
|
appId: string | undefined;
|
|
2785
3220
|
/**
|
|
3221
|
+
* @public
|
|
2786
3222
|
* <p>The name of the backend environment that is a part of the Amplify
|
|
2787
3223
|
* app.</p>
|
|
2788
3224
|
*/
|
|
2789
3225
|
environmentName: string | undefined;
|
|
2790
3226
|
/**
|
|
3227
|
+
* @public
|
|
2791
3228
|
* <p>The unique client token.</p>
|
|
2792
3229
|
*/
|
|
2793
3230
|
clientToken?: string;
|
|
2794
3231
|
/**
|
|
3232
|
+
* @public
|
|
2795
3233
|
* <p>Represents the configuration of the component to create.</p>
|
|
2796
3234
|
*/
|
|
2797
3235
|
componentToCreate: CreateComponentData | undefined;
|
|
@@ -2801,6 +3239,7 @@ export interface CreateComponentRequest {
|
|
|
2801
3239
|
*/
|
|
2802
3240
|
export interface CreateComponentResponse {
|
|
2803
3241
|
/**
|
|
3242
|
+
* @public
|
|
2804
3243
|
* <p>Describes the configuration of the new component.</p>
|
|
2805
3244
|
*/
|
|
2806
3245
|
entity?: Component;
|
|
@@ -2810,6 +3249,7 @@ export interface CreateComponentResponse {
|
|
|
2810
3249
|
*/
|
|
2811
3250
|
export interface GetComponentResponse {
|
|
2812
3251
|
/**
|
|
3252
|
+
* @public
|
|
2813
3253
|
* <p>Represents the configuration settings for the component.</p>
|
|
2814
3254
|
*/
|
|
2815
3255
|
component?: Component;
|
|
@@ -2819,22 +3259,27 @@ export interface GetComponentResponse {
|
|
|
2819
3259
|
*/
|
|
2820
3260
|
export interface UpdateComponentRequest {
|
|
2821
3261
|
/**
|
|
3262
|
+
* @public
|
|
2822
3263
|
* <p>The unique ID for the Amplify app.</p>
|
|
2823
3264
|
*/
|
|
2824
3265
|
appId: string | undefined;
|
|
2825
3266
|
/**
|
|
3267
|
+
* @public
|
|
2826
3268
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
2827
3269
|
*/
|
|
2828
3270
|
environmentName: string | undefined;
|
|
2829
3271
|
/**
|
|
3272
|
+
* @public
|
|
2830
3273
|
* <p>The unique ID for the component.</p>
|
|
2831
3274
|
*/
|
|
2832
3275
|
id: string | undefined;
|
|
2833
3276
|
/**
|
|
3277
|
+
* @public
|
|
2834
3278
|
* <p>The unique client token.</p>
|
|
2835
3279
|
*/
|
|
2836
3280
|
clientToken?: string;
|
|
2837
3281
|
/**
|
|
3282
|
+
* @public
|
|
2838
3283
|
* <p>The configuration of the updated component.</p>
|
|
2839
3284
|
*/
|
|
2840
3285
|
updatedComponent: UpdateComponentData | undefined;
|
|
@@ -2844,6 +3289,7 @@ export interface UpdateComponentRequest {
|
|
|
2844
3289
|
*/
|
|
2845
3290
|
export interface UpdateComponentResponse {
|
|
2846
3291
|
/**
|
|
3292
|
+
* @public
|
|
2847
3293
|
* <p>Describes the configuration of the updated component.</p>
|
|
2848
3294
|
*/
|
|
2849
3295
|
entity?: Component;
|
|
@@ -2853,10 +3299,12 @@ export interface UpdateComponentResponse {
|
|
|
2853
3299
|
*/
|
|
2854
3300
|
export interface ExportComponentsResponse {
|
|
2855
3301
|
/**
|
|
3302
|
+
* @public
|
|
2856
3303
|
* <p>Represents the configuration of the exported components.</p>
|
|
2857
3304
|
*/
|
|
2858
3305
|
entities: Component[] | undefined;
|
|
2859
3306
|
/**
|
|
3307
|
+
* @public
|
|
2860
3308
|
* <p>The pagination token that's included if more results are available.</p>
|
|
2861
3309
|
*/
|
|
2862
3310
|
nextToken?: string;
|