forked from aws/aws-sdk-go-v2
-
Notifications
You must be signed in to change notification settings - Fork 1
/
amplifyuibuilder.2021-08-11.json
2639 lines (2639 loc) · 115 KB
/
amplifyuibuilder.2021-08-11.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "1.0",
"shapes": {
"com.amazonaws.amplifyuibuilder#ActionParameters": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>. This value is required for a navigation action.</p>"
}
},
"url": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The URL to the location to open. Specify this value for a navigation action.</p>"
}
},
"anchor": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The HTML anchor link to the location to open. Specify this value for a navigation action.</p>"
}
},
"target": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The element within the same component to modify when the action occurs.</p>"
}
},
"global": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.</p>"
}
},
"model": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the data model. Use when the action performs an operation on an Amplify DataStore\n model.</p>"
}
},
"id": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the component that the <code>ActionParameters</code> apply to.</p>"
}
},
"fields": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperties",
"traits": {
"smithy.api#documentation": "<p>A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action\n performs an operation on an Amplify DataStore model.</p>"
}
},
"state": {
"target": "com.amazonaws.amplifyuibuilder#MutationActionSetStateParameter",
"traits": {
"smithy.api#documentation": "<p>A key-value pair that specifies the state property name and its initial value.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the event action configuration for an element of a <code>Component</code>\n or <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio\n that allows you to bind events and actions to components. <code>ActionParameters</code>\n defines the action that is performed when an event occurs on the component.</p>"
}
},
"com.amazonaws.amplifyuibuilder#AmplifyUIBuilder": {
"type": "service",
"traits": {
"aws.api#service": {
"sdkId": "AmplifyUIBuilder",
"arnNamespace": "amplifyuibuilder",
"cloudFormationName": "AmplifyUIBuilder",
"cloudTrailEventSource": "amplifyuibuilder.amazonaws.com"
},
"aws.auth#sigv4": {
"name": "amplifyuibuilder"
},
"aws.protocols#restJson1": {},
"smithy.api#cors": {},
"smithy.api#documentation": "<p>The Amplify UI Builder API provides a programmatic interface for creating\n and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's\n backend Amazon Web Services resources.</p>\n <p>You can also use the Amplify Studio visual designer to create UI components\n and model data for an app. For more information, see <a href=\"https://docs.amplify.aws/console/adminui/intro\">Introduction</a> in the\n <i>Amplify Docs</i>.</p>\n <p>The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and\n documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework</a>. For more information about\n deploying an Amplify application to Amazon Web Services, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify User Guide</a>.</p>",
"smithy.api#title": "AWS Amplify UI Builder"
},
"version": "2021-08-11",
"operations": [
{
"target": "com.amazonaws.amplifyuibuilder#ExchangeCodeForToken"
},
{
"target": "com.amazonaws.amplifyuibuilder#RefreshToken"
}
],
"resources": [
{
"target": "com.amazonaws.amplifyuibuilder#ComponentResource"
},
{
"target": "com.amazonaws.amplifyuibuilder#ThemeResource"
}
]
},
"com.amazonaws.amplifyuibuilder#Component": {
"type": "structure",
"members": {
"appId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the Amplify app associated with the component.</p>",
"smithy.api#required": {}
}
},
"environmentName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the backend environment that is a part of the Amplify\n app.</p>",
"smithy.api#required": {}
}
},
"sourceId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the component in its original source system, such as Figma.</p>"
}
},
"id": {
"target": "com.amazonaws.amplifyuibuilder#Uuid",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the component.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.amplifyuibuilder#ComponentName",
"traits": {
"smithy.api#documentation": "<p>The name of the component.</p>",
"smithy.api#required": {}
}
},
"componentType": {
"target": "com.amazonaws.amplifyuibuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The type of the component. This can be an Amplify custom UI component or\n another custom component.</p>",
"smithy.api#required": {}
}
},
"properties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperties",
"traits": {
"smithy.api#documentation": "<p>Describes the component's properties. You can't specify <code>tags</code> as a valid\n property for <code>properties</code>.</p>",
"smithy.api#required": {}
}
},
"children": {
"target": "com.amazonaws.amplifyuibuilder#ComponentChildList",
"traits": {
"smithy.api#documentation": "<p>A list of the component's <code>ComponentChild</code> instances.</p>"
}
},
"variants": {
"target": "com.amazonaws.amplifyuibuilder#ComponentVariants",
"traits": {
"smithy.api#documentation": "<p>A list of the component's variants. A variant is a unique style configuration of a main\n component.</p>",
"smithy.api#required": {}
}
},
"overrides": {
"target": "com.amazonaws.amplifyuibuilder#ComponentOverrides",
"traits": {
"smithy.api#documentation": "<p>Describes the component's properties that can be overriden in a customized instance of the\n component. You can't specify <code>tags</code> as a valid property for\n <code>overrides</code>.</p>",
"smithy.api#required": {}
}
},
"bindingProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentBindingProperties",
"traits": {
"smithy.api#documentation": "<p>The information to connect a component's properties to data at runtime. You can't specify\n <code>tags</code> as a valid property for <code>bindingProperties</code>.</p>\n <p/>",
"smithy.api#required": {}
}
},
"collectionProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties",
"traits": {
"smithy.api#documentation": "<p>The data binding configuration for the component's properties. Use this for a collection\n component. You can't specify <code>tags</code> as a valid property for\n <code>collectionProperties</code>.</p>"
}
},
"createdAt": {
"target": "smithy.api#Timestamp",
"traits": {
"aws.cloudformation#cfnExcludeProperty": {},
"smithy.api#documentation": "<p>The time that the component was created.</p>",
"smithy.api#required": {},
"smithy.api#timestampFormat": "date-time"
}
},
"modifiedAt": {
"target": "smithy.api#Timestamp",
"traits": {
"aws.cloudformation#cfnExcludeProperty": {},
"smithy.api#documentation": "<p>The time that the component was modified.</p>",
"smithy.api#timestampFormat": "date-time"
}
},
"tags": {
"target": "com.amazonaws.amplifyuibuilder#Tags",
"traits": {
"aws.cloudformation#cfnMutability": "create-and-read",
"smithy.api#documentation": "<p>One or more key-value pairs to use when tagging the component.</p>"
}
},
"events": {
"target": "com.amazonaws.amplifyuibuilder#ComponentEvents",
"traits": {
"smithy.api#documentation": "<p>Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.</p>"
}
},
"schemaVersion": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The schema version of the component when it was imported.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use\n <code>ComponentChild</code> to configure an instance of a <code>Component</code>. A\n <code>ComponentChild</code> instance inherits the configuration of the main\n <code>Component</code>.</p>",
"smithy.api#references": [
{
"resource": "com.amazonaws.amplifyuibuilder#ComponentResource"
}
]
}
},
"com.amazonaws.amplifyuibuilder#ComponentBindingProperties": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValue"
}
},
"com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValue": {
"type": "structure",
"members": {
"type": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The property type.</p>"
}
},
"bindingProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValueProperties",
"traits": {
"smithy.api#documentation": "<p>Describes the properties to customize with data at runtime.</p>"
}
},
"defaultValue": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The default value of the property.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the data binding configuration for a component at runtime. You can use\n <code>ComponentBindingPropertiesValue</code> to add exposed properties to a component to\n allow different values to be entered when a component is reused in different places in an\n app.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentBindingPropertiesValueProperties": {
"type": "structure",
"members": {
"model": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An Amplify DataStore model.</p>"
}
},
"field": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The field to bind the data to.</p>"
}
},
"predicates": {
"target": "com.amazonaws.amplifyuibuilder#PredicateList",
"traits": {
"smithy.api#documentation": "<p>A list of predicates for binding a component's properties to data.</p>"
}
},
"userAttribute": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An authenticated user attribute.</p>"
}
},
"bucket": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An Amazon S3 bucket.</p>"
}
},
"key": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The storage key for an Amazon S3 bucket.</p>"
}
},
"defaultValue": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The default value to assign to the property.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the data binding configuration for a specific property using data stored in\n Amazon Web Services. For Amazon Web Services connected properties, you can bind a property to\n data stored in an Amazon S3 bucket, an Amplify DataStore model or an\n authenticated user attribute.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentChild": {
"type": "structure",
"members": {
"componentType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The type of the child component. </p>",
"smithy.api#required": {}
}
},
"name": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the child component.</p>",
"smithy.api#required": {}
}
},
"properties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperties",
"traits": {
"smithy.api#documentation": "<p>Describes the properties of the child component. You can't specify <code>tags</code> as a\n valid property for <code>properties</code>.</p>",
"smithy.api#required": {}
}
},
"children": {
"target": "com.amazonaws.amplifyuibuilder#ComponentChildList",
"traits": {
"smithy.api#documentation": "<p>The list of <code>ComponentChild</code> instances for this component.</p>"
}
},
"events": {
"target": "com.amazonaws.amplifyuibuilder#ComponentEvents",
"traits": {
"smithy.api#documentation": "<p>Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to\n bind events and actions to components.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A nested UI configuration within a parent <code>Component</code>.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentChildList": {
"type": "list",
"member": {
"target": "com.amazonaws.amplifyuibuilder#ComponentChild"
}
},
"com.amazonaws.amplifyuibuilder#ComponentCollectionProperties": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.amplifyuibuilder#ComponentDataConfiguration"
}
},
"com.amazonaws.amplifyuibuilder#ComponentConditionProperty": {
"type": "structure",
"members": {
"property": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the conditional property.</p>"
}
},
"field": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of a field. Specify this when the property is a data model.</p>"
}
},
"operator": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The operator to use to perform the evaluation, such as <code>eq</code> to represent\n equals.</p>"
}
},
"operand": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The value of the property to evaluate.</p>"
}
},
"then": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The value to assign to the property if the condition is met.</p>"
}
},
"else": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty",
"traits": {
"smithy.api#documentation": "<p>The value to assign to the property if the condition is not met.</p>"
}
},
"operandType": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The type of the property to evaluate.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents a conditional expression to set a component property. Use\n <code>ComponentConditionProperty</code> to set a property to different values conditionally,\n based on the value of another property.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentDataConfiguration": {
"type": "structure",
"members": {
"model": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the data model to use to bind data to a component.</p>",
"smithy.api#required": {}
}
},
"sort": {
"target": "com.amazonaws.amplifyuibuilder#SortPropertyList",
"traits": {
"smithy.api#documentation": "<p>Describes how to sort the component's properties.</p>"
}
},
"predicate": {
"target": "com.amazonaws.amplifyuibuilder#Predicate",
"traits": {
"smithy.api#documentation": "<p>Represents the conditional logic to use when binding data to a component. Use this\n property to retrieve only a subset of the data in a collection.</p>"
}
},
"identifiers": {
"target": "com.amazonaws.amplifyuibuilder#IdentifierList",
"traits": {
"smithy.api#documentation": "<p>A list of IDs to use to bind data to a component. Use this property to bind specifically\n chosen data, rather than data retrieved from a query.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the configuration for binding a component's properties to data.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentEvent": {
"type": "structure",
"members": {
"action": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The action to perform when a specific event is raised.</p>"
}
},
"parameters": {
"target": "com.amazonaws.amplifyuibuilder#ActionParameters",
"traits": {
"smithy.api#documentation": "<p>Describes information about the action.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the configuration of an event. You can bind an event and a corresponding\n action to a <code>Component</code> or a <code>ComponentChild</code>. A button click\n is an example of an event. </p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentEvents": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.amplifyuibuilder#ComponentEvent"
}
},
"com.amazonaws.amplifyuibuilder#ComponentList": {
"type": "list",
"member": {
"target": "com.amazonaws.amplifyuibuilder#Component"
}
},
"com.amazonaws.amplifyuibuilder#ComponentName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
}
}
},
"com.amazonaws.amplifyuibuilder#ComponentOverrides": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.amplifyuibuilder#ComponentOverridesValue"
}
},
"com.amazonaws.amplifyuibuilder#ComponentOverridesValue": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "smithy.api#String"
}
},
"com.amazonaws.amplifyuibuilder#ComponentProperties": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty"
}
},
"com.amazonaws.amplifyuibuilder#ComponentProperty": {
"type": "structure",
"members": {
"value": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The value to assign to the component property.</p>"
}
},
"bindingProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentPropertyBindingProperties",
"traits": {
"smithy.api#documentation": "<p>The information to bind the component property to data at runtime.</p>"
}
},
"collectionBindingProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentPropertyBindingProperties",
"traits": {
"smithy.api#documentation": "<p>The information to bind the component property to data at runtime. Use this for collection\n components.</p>"
}
},
"defaultValue": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The default value to assign to the component property.</p>"
}
},
"model": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The data model to use to assign a value to the component property.</p>"
}
},
"bindings": {
"target": "com.amazonaws.amplifyuibuilder#FormBindings",
"traits": {
"smithy.api#documentation": "<p>The information to bind the component property to form data.</p>"
}
},
"event": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An event that occurs in your app. Use this for workflow data binding.</p>"
}
},
"userAttribute": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>An authenticated user attribute to use to assign a value to the component property.</p>"
}
},
"concat": {
"target": "com.amazonaws.amplifyuibuilder#ComponentPropertyList",
"traits": {
"smithy.api#documentation": "<p>A list of component properties to concatenate to create the value to assign to this\n component property.</p>"
}
},
"condition": {
"target": "com.amazonaws.amplifyuibuilder#ComponentConditionProperty",
"traits": {
"smithy.api#documentation": "<p>The conditional expression to use to assign a value to the component property.</p>"
}
},
"configured": {
"target": "smithy.api#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether the user configured the property in Amplify Studio after\n importing it.</p>"
}
},
"type": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The component type.</p>"
}
},
"importedValue": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The default value assigned to the property when the component is imported into an\n app.</p>"
}
},
"componentName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the component that is affected by an event.</p>"
}
},
"property": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the component's property that is affected by an event.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the configuration for all of a component's properties. Use\n <code>ComponentProperty</code> to specify the values to render or bind by default.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentPropertyBindingProperties": {
"type": "structure",
"members": {
"property": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The component property to bind to the data field.</p>",
"smithy.api#required": {}
}
},
"field": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The data field to bind the property to.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Associates a component property to a binding property. This enables exposed properties on\n the top level component to propagate data to the component's property values.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentPropertyList": {
"type": "list",
"member": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperty"
}
},
"com.amazonaws.amplifyuibuilder#ComponentResource": {
"type": "resource",
"identifiers": {
"id": {
"target": "com.amazonaws.amplifyuibuilder#Uuid"
},
"appId": {
"target": "smithy.api#String"
},
"environmentName": {
"target": "smithy.api#String"
}
},
"create": {
"target": "com.amazonaws.amplifyuibuilder#CreateComponent"
},
"read": {
"target": "com.amazonaws.amplifyuibuilder#GetComponent"
},
"update": {
"target": "com.amazonaws.amplifyuibuilder#UpdateComponent"
},
"delete": {
"target": "com.amazonaws.amplifyuibuilder#DeleteComponent"
},
"list": {
"target": "com.amazonaws.amplifyuibuilder#ListComponents"
},
"collectionOperations": [
{
"target": "com.amazonaws.amplifyuibuilder#ExportComponents"
}
],
"traits": {
"aws.api#arn": {
"template": "app/{appId}/environment/{environmentName}/components/{id}"
},
"aws.cloudformation#cfnResource": {
"name": "Component",
"additionalSchemas": [
"com.amazonaws.amplifyuibuilder#Component"
]
}
}
},
"com.amazonaws.amplifyuibuilder#ComponentSummary": {
"type": "structure",
"members": {
"appId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the Amplify app associated with the component.</p>",
"smithy.api#required": {}
}
},
"environmentName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the backend environment that is a part of the Amplify\n app.</p>",
"smithy.api#required": {}
}
},
"id": {
"target": "com.amazonaws.amplifyuibuilder#Uuid",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the component.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.amplifyuibuilder#ComponentName",
"traits": {
"smithy.api#documentation": "<p>The name of the component.</p>",
"smithy.api#required": {}
}
},
"componentType": {
"target": "com.amazonaws.amplifyuibuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The component type.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains a summary of a component. This is a read-only data type that is returned by\n <code>ListComponents</code>.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentSummaryList": {
"type": "list",
"member": {
"target": "com.amazonaws.amplifyuibuilder#ComponentSummary"
}
},
"com.amazonaws.amplifyuibuilder#ComponentType": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 255
}
}
},
"com.amazonaws.amplifyuibuilder#ComponentVariant": {
"type": "structure",
"members": {
"variantValues": {
"target": "com.amazonaws.amplifyuibuilder#ComponentVariantValues",
"traits": {
"smithy.api#documentation": "<p>The combination of variants that comprise this variant. You can't specify\n <code>tags</code> as a valid property for <code>variantValues</code>.</p>"
}
},
"overrides": {
"target": "com.amazonaws.amplifyuibuilder#ComponentOverrides",
"traits": {
"smithy.api#documentation": "<p>The properties of the component variant that can be overriden when customizing an instance\n of the component. You can't specify <code>tags</code> as a valid property for\n <code>overrides</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Describes the style configuration of a unique variation of a main component.</p>"
}
},
"com.amazonaws.amplifyuibuilder#ComponentVariantValues": {
"type": "map",
"key": {
"target": "smithy.api#String"
},
"value": {
"target": "smithy.api#String"
}
},
"com.amazonaws.amplifyuibuilder#ComponentVariants": {
"type": "list",
"member": {
"target": "com.amazonaws.amplifyuibuilder#ComponentVariant"
}
},
"com.amazonaws.amplifyuibuilder#CreateComponent": {
"type": "operation",
"input": {
"target": "com.amazonaws.amplifyuibuilder#CreateComponentRequest"
},
"output": {
"target": "com.amazonaws.amplifyuibuilder#CreateComponentResponse"
},
"errors": [
{
"target": "com.amazonaws.amplifyuibuilder#InternalServerException"
},
{
"target": "com.amazonaws.amplifyuibuilder#InvalidParameterException"
},
{
"target": "com.amazonaws.amplifyuibuilder#ResourceConflictException"
},
{
"target": "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException"
}
],
"traits": {
"aws.iam#requiredActions": [
"amplify:GetApp"
],
"smithy.api#documentation": "<p>Creates a new component for an Amplify app.</p>",
"smithy.api#http": {
"uri": "/app/{appId}/environment/{environmentName}/components",
"method": "POST"
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.amplifyuibuilder#CreateComponentData": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.amplifyuibuilder#ComponentName",
"traits": {
"smithy.api#documentation": "<p>The name of the component</p>",
"smithy.api#required": {}
}
},
"sourceId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the component in its original source system, such as Figma.</p>"
}
},
"componentType": {
"target": "com.amazonaws.amplifyuibuilder#ComponentType",
"traits": {
"smithy.api#documentation": "<p>The component type. This can be an Amplify custom UI component or another\n custom component.</p>",
"smithy.api#required": {}
}
},
"properties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentProperties",
"traits": {
"smithy.api#documentation": "<p>Describes the component's properties.</p>",
"smithy.api#required": {}
}
},
"children": {
"target": "com.amazonaws.amplifyuibuilder#ComponentChildList",
"traits": {
"smithy.api#documentation": "<p>A list of child components that are instances of the main component.</p>"
}
},
"variants": {
"target": "com.amazonaws.amplifyuibuilder#ComponentVariants",
"traits": {
"smithy.api#documentation": "<p>A list of the unique variants of this component.</p>",
"smithy.api#required": {}
}
},
"overrides": {
"target": "com.amazonaws.amplifyuibuilder#ComponentOverrides",
"traits": {
"smithy.api#documentation": "<p>Describes the component properties that can be overriden to customize an instance of the\n component.</p>",
"smithy.api#required": {}
}
},
"bindingProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentBindingProperties",
"traits": {
"smithy.api#documentation": "<p>The data binding information for the component's properties.</p>",
"smithy.api#required": {}
}
},
"collectionProperties": {
"target": "com.amazonaws.amplifyuibuilder#ComponentCollectionProperties",
"traits": {
"smithy.api#documentation": "<p>The data binding configuration for customizing a component's properties. Use this for a\n collection component.</p>"
}
},
"tags": {
"target": "com.amazonaws.amplifyuibuilder#Tags",
"traits": {
"smithy.api#documentation": "<p>One or more key-value pairs to use when tagging the component data.</p>"
}
},
"events": {
"target": "com.amazonaws.amplifyuibuilder#ComponentEvents",
"traits": {
"smithy.api#documentation": "<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>"
}
},
"schemaVersion": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The schema version of the component when it was imported.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents all of the information that is required to create a component.</p>"
}
},
"com.amazonaws.amplifyuibuilder#CreateComponentRequest": {
"type": "structure",
"members": {
"appId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The unique ID of the Amplify app to associate with the component.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"environmentName": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The name of the backend environment that is a part of the Amplify\n app.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
},
"clientToken": {
"target": "smithy.api#String",
"traits": {
"aws.cloudformation#cfnExcludeProperty": {},
"smithy.api#documentation": "<p>The unique client token.</p>",
"smithy.api#httpQuery": "clientToken",
"smithy.api#idempotencyToken": {}
}
},
"componentToCreate": {
"target": "com.amazonaws.amplifyuibuilder#CreateComponentData",
"traits": {
"aws.cloudformation#cfnExcludeProperty": {},
"smithy.api#documentation": "<p>Represents the configuration of the component to create.</p>",
"smithy.api#httpPayload": {},
"smithy.api#required": {}
}
}
}
},
"com.amazonaws.amplifyuibuilder#CreateComponentResponse": {
"type": "structure",
"members": {
"entity": {
"target": "com.amazonaws.amplifyuibuilder#Component",
"traits": {
"smithy.api#documentation": "<p>Describes the configuration of the new component.</p>",
"smithy.api#httpPayload": {}
}
}
}
},
"com.amazonaws.amplifyuibuilder#CreateTheme": {
"type": "operation",
"input": {
"target": "com.amazonaws.amplifyuibuilder#CreateThemeRequest"
},
"output": {
"target": "com.amazonaws.amplifyuibuilder#CreateThemeResponse"
},
"errors": [
{
"target": "com.amazonaws.amplifyuibuilder#InternalServerException"
},
{
"target": "com.amazonaws.amplifyuibuilder#InvalidParameterException"
},
{
"target": "com.amazonaws.amplifyuibuilder#ResourceConflictException"
},
{
"target": "com.amazonaws.amplifyuibuilder#ServiceQuotaExceededException"
}
],
"traits": {
"aws.iam#requiredActions": [
"amplify:GetApp"
],
"smithy.api#documentation": "<p>Creates a theme to apply to the components in an Amplify app.</p>",
"smithy.api#http": {
"uri": "/app/{appId}/environment/{environmentName}/themes",
"method": "POST"
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.amplifyuibuilder#CreateThemeData": {
"type": "structure",
"members": {
"name": {
"target": "com.amazonaws.amplifyuibuilder#ThemeName",
"traits": {
"smithy.api#documentation": "<p>The name of the theme.</p>",