@aws-sdk/client-amplifyuibuilder 3.379.1 → 3.382.0

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