@aws-sdk/client-amplifyuibuilder 3.170.0 → 3.171.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 (83) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/AmplifyUIBuilder.js +120 -0
  3. package/dist-cjs/commands/CreateFormCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteFormCommand.js +36 -0
  5. package/dist-cjs/commands/ExportFormsCommand.js +36 -0
  6. package/dist-cjs/commands/GetFormCommand.js +36 -0
  7. package/dist-cjs/commands/GetMetadataCommand.js +36 -0
  8. package/dist-cjs/commands/ListFormsCommand.js +36 -0
  9. package/dist-cjs/commands/PutMetadataFlagCommand.js +36 -0
  10. package/dist-cjs/commands/UpdateFormCommand.js +36 -0
  11. package/dist-cjs/commands/index.js +8 -0
  12. package/dist-cjs/models/models_0.js +254 -2
  13. package/dist-cjs/pagination/ExportFormsPaginator.js +35 -0
  14. package/dist-cjs/pagination/ListFormsPaginator.js +36 -0
  15. package/dist-cjs/pagination/index.js +2 -0
  16. package/dist-cjs/protocols/Aws_restJson1.js +979 -11
  17. package/dist-es/AmplifyUIBuilder.js +120 -0
  18. package/dist-es/commands/CreateFormCommand.js +39 -0
  19. package/dist-es/commands/DeleteFormCommand.js +39 -0
  20. package/dist-es/commands/ExportFormsCommand.js +39 -0
  21. package/dist-es/commands/GetFormCommand.js +39 -0
  22. package/dist-es/commands/GetMetadataCommand.js +39 -0
  23. package/dist-es/commands/ListFormsCommand.js +39 -0
  24. package/dist-es/commands/PutMetadataFlagCommand.js +39 -0
  25. package/dist-es/commands/UpdateFormCommand.js +39 -0
  26. package/dist-es/commands/index.js +8 -0
  27. package/dist-es/models/models_0.js +141 -1
  28. package/dist-es/pagination/ExportFormsPaginator.js +74 -0
  29. package/dist-es/pagination/ListFormsPaginator.js +75 -0
  30. package/dist-es/pagination/index.js +2 -0
  31. package/dist-es/protocols/Aws_restJson1.js +1142 -34
  32. package/dist-types/AmplifyUIBuilder.d.ts +56 -0
  33. package/dist-types/AmplifyUIBuilderClient.d.ts +10 -2
  34. package/dist-types/commands/CreateFormCommand.d.ts +35 -0
  35. package/dist-types/commands/DeleteFormCommand.d.ts +35 -0
  36. package/dist-types/commands/ExportFormsCommand.d.ts +35 -0
  37. package/dist-types/commands/GetFormCommand.d.ts +35 -0
  38. package/dist-types/commands/GetMetadataCommand.d.ts +35 -0
  39. package/dist-types/commands/ListFormsCommand.d.ts +35 -0
  40. package/dist-types/commands/PutMetadataFlagCommand.d.ts +35 -0
  41. package/dist-types/commands/UpdateFormCommand.d.ts +35 -0
  42. package/dist-types/commands/index.d.ts +8 -0
  43. package/dist-types/models/models_0.d.ts +854 -24
  44. package/dist-types/pagination/ExportFormsPaginator.d.ts +4 -0
  45. package/dist-types/pagination/ListFormsPaginator.d.ts +4 -0
  46. package/dist-types/pagination/index.d.ts +2 -0
  47. package/dist-types/protocols/Aws_restJson1.d.ts +24 -0
  48. package/dist-types/ts3.4/AmplifyUIBuilder.d.ts +136 -14
  49. package/dist-types/ts3.4/AmplifyUIBuilderClient.d.ts +48 -25
  50. package/dist-types/ts3.4/commands/CreateComponentCommand.d.ts +0 -2
  51. package/dist-types/ts3.4/commands/CreateFormCommand.d.ts +32 -0
  52. package/dist-types/ts3.4/commands/CreateThemeCommand.d.ts +0 -2
  53. package/dist-types/ts3.4/commands/DeleteComponentCommand.d.ts +0 -2
  54. package/dist-types/ts3.4/commands/DeleteFormCommand.d.ts +30 -0
  55. package/dist-types/ts3.4/commands/DeleteThemeCommand.d.ts +0 -2
  56. package/dist-types/ts3.4/commands/ExchangeCodeForTokenCommand.d.ts +0 -2
  57. package/dist-types/ts3.4/commands/ExportComponentsCommand.d.ts +0 -2
  58. package/dist-types/ts3.4/commands/ExportFormsCommand.d.ts +32 -0
  59. package/dist-types/ts3.4/commands/ExportThemesCommand.d.ts +0 -2
  60. package/dist-types/ts3.4/commands/GetComponentCommand.d.ts +0 -2
  61. package/dist-types/ts3.4/commands/GetFormCommand.d.ts +32 -0
  62. package/dist-types/ts3.4/commands/GetMetadataCommand.d.ts +32 -0
  63. package/dist-types/ts3.4/commands/GetThemeCommand.d.ts +0 -2
  64. package/dist-types/ts3.4/commands/ListComponentsCommand.d.ts +0 -2
  65. package/dist-types/ts3.4/commands/ListFormsCommand.d.ts +32 -0
  66. package/dist-types/ts3.4/commands/ListThemesCommand.d.ts +0 -2
  67. package/dist-types/ts3.4/commands/PutMetadataFlagCommand.d.ts +30 -0
  68. package/dist-types/ts3.4/commands/RefreshTokenCommand.d.ts +0 -2
  69. package/dist-types/ts3.4/commands/UpdateComponentCommand.d.ts +0 -2
  70. package/dist-types/ts3.4/commands/UpdateFormCommand.d.ts +32 -0
  71. package/dist-types/ts3.4/commands/UpdateThemeCommand.d.ts +0 -2
  72. package/dist-types/ts3.4/commands/index.d.ts +8 -0
  73. package/dist-types/ts3.4/models/AmplifyUIBuilderServiceException.d.ts +0 -1
  74. package/dist-types/ts3.4/models/models_0.d.ts +347 -247
  75. package/dist-types/ts3.4/pagination/ExportFormsPaginator.d.ts +11 -0
  76. package/dist-types/ts3.4/pagination/ListFormsPaginator.d.ts +11 -0
  77. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  78. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +96 -0
  79. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +0 -1
  80. package/dist-types/ts3.4/runtimeConfig.d.ts +0 -1
  81. package/dist-types/ts3.4/runtimeConfig.native.d.ts +0 -1
  82. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +0 -1
  83. package/package.json +26 -26
@@ -258,6 +258,708 @@ export interface ExchangeCodeForTokenResponse {
258
258
  */
259
259
  refreshToken: string | undefined;
260
260
  }
261
+ export declare enum FixedPosition {
262
+ FIRST = "first"
263
+ }
264
+ /**
265
+ * <p>Describes the field position.</p>
266
+ */
267
+ export declare type FieldPosition = FieldPosition.BelowMember | FieldPosition.FixedMember | FieldPosition.RightOfMember | FieldPosition.$UnknownMember;
268
+ export declare namespace FieldPosition {
269
+ /**
270
+ * <p>The field position is fixed and doesn't change in relation to other fields.</p>
271
+ */
272
+ interface FixedMember {
273
+ fixed: FixedPosition | string;
274
+ rightOf?: never;
275
+ below?: never;
276
+ $unknown?: never;
277
+ }
278
+ /**
279
+ * <p>The field position is to the right of the field specified by the string.</p>
280
+ */
281
+ interface RightOfMember {
282
+ fixed?: never;
283
+ rightOf: string;
284
+ below?: never;
285
+ $unknown?: never;
286
+ }
287
+ /**
288
+ * <p>The field position is below the field specified by the string.</p>
289
+ */
290
+ interface BelowMember {
291
+ fixed?: never;
292
+ rightOf?: never;
293
+ below: string;
294
+ $unknown?: never;
295
+ }
296
+ interface $UnknownMember {
297
+ fixed?: never;
298
+ rightOf?: never;
299
+ below?: never;
300
+ $unknown: [string, any];
301
+ }
302
+ interface Visitor<T> {
303
+ fixed: (value: FixedPosition | string) => T;
304
+ rightOf: (value: string) => T;
305
+ below: (value: string) => T;
306
+ _: (name: string, value: any) => T;
307
+ }
308
+ const visit: <T>(value: FieldPosition, visitor: Visitor<T>) => T;
309
+ }
310
+ /**
311
+ * <p>Describes the configuration for a button UI element that is a part of a form.</p>
312
+ */
313
+ export interface FormButton {
314
+ /**
315
+ * <p>Specifies whether the button is visible on the form.</p>
316
+ */
317
+ excluded?: boolean;
318
+ /**
319
+ * <p>Describes the button's properties.</p>
320
+ */
321
+ children?: string;
322
+ /**
323
+ * <p>The position of the button.</p>
324
+ */
325
+ position?: FieldPosition;
326
+ }
327
+ export declare enum FormButtonsPosition {
328
+ BOTTOM = "bottom",
329
+ TOP = "top",
330
+ TOP_AND_BOTTOM = "top_and_bottom"
331
+ }
332
+ /**
333
+ * <p>Describes the call to action button configuration for the form..</p>
334
+ */
335
+ export interface FormCTA {
336
+ /**
337
+ * <p>The position of the button.</p>
338
+ */
339
+ position?: FormButtonsPosition | string;
340
+ /**
341
+ * <p>Displays a clear button.</p>
342
+ */
343
+ clear?: FormButton;
344
+ /**
345
+ * <p>Displays a cancel button.</p>
346
+ */
347
+ cancel?: FormButton;
348
+ /**
349
+ * <p>Displays a submit button.</p>
350
+ */
351
+ submit?: FormButton;
352
+ }
353
+ export declare enum FormDataSourceType {
354
+ /**
355
+ * Will use passed in hooks to use when creating a form from scratch
356
+ */
357
+ CUSTOM = "Custom",
358
+ /**
359
+ * Will use a provided Amplify DataStore enabled API
360
+ */
361
+ DATASTORE = "DataStore"
362
+ }
363
+ /**
364
+ * <p>Describes the data type configuration for the data source associated with a form.</p>
365
+ */
366
+ export interface FormDataTypeConfig {
367
+ /**
368
+ * <p>The data source type, either an Amplify DataStore model or a custom data type.</p>
369
+ */
370
+ dataSourceType: FormDataSourceType | string | undefined;
371
+ /**
372
+ * <p>The unique name of the data type you are using as the data source for the form.</p>
373
+ */
374
+ dataTypeName: string | undefined;
375
+ }
376
+ /**
377
+ * <p>Describes the configuration for an input field on a form. Use
378
+ * <code>FormInputValueProperty</code> to specify the values to render or bind by
379
+ * default.</p>
380
+ */
381
+ export interface FormInputValueProperty {
382
+ /**
383
+ * <p>The value to assign to the input field.</p>
384
+ */
385
+ value?: string;
386
+ }
387
+ /**
388
+ * <p>Associates a complex object with a display value. Use <code>ValueMapping</code> to store
389
+ * how to represent complex objects when they are displayed.</p>
390
+ */
391
+ export interface ValueMapping {
392
+ /**
393
+ * <p>The value to display for the complex object.</p>
394
+ */
395
+ displayValue?: FormInputValueProperty;
396
+ /**
397
+ * <p>The complex object.</p>
398
+ */
399
+ value: FormInputValueProperty | undefined;
400
+ }
401
+ /**
402
+ * <p>Represents the data binding configuration for a value map.</p>
403
+ */
404
+ export interface ValueMappings {
405
+ /**
406
+ * <p>The value and display value pairs.</p>
407
+ */
408
+ values: ValueMapping[] | undefined;
409
+ }
410
+ /**
411
+ * <p>Describes the configuration for the default input values to display for a field.</p>
412
+ */
413
+ export interface FieldInputConfig {
414
+ /**
415
+ * <p>The input type for the field. </p>
416
+ */
417
+ type: string | undefined;
418
+ /**
419
+ * <p>Specifies a field that requires input.</p>
420
+ */
421
+ required?: boolean;
422
+ /**
423
+ * <p>Specifies a read only field.</p>
424
+ */
425
+ readOnly?: boolean;
426
+ /**
427
+ * <p>The text to display as a placeholder for the field.</p>
428
+ */
429
+ placeholder?: string;
430
+ /**
431
+ * <p>The default value for the field.</p>
432
+ */
433
+ defaultValue?: string;
434
+ /**
435
+ * <p>The text to display to describe the field.</p>
436
+ */
437
+ descriptiveText?: string;
438
+ /**
439
+ * <p>Specifies whether a field has a default value.</p>
440
+ */
441
+ defaultChecked?: boolean;
442
+ /**
443
+ * <p>The default country code for a phone number.</p>
444
+ */
445
+ defaultCountryCode?: string;
446
+ /**
447
+ * <p>The information to use to customize the input fields with data at runtime.</p>
448
+ */
449
+ valueMappings?: ValueMappings;
450
+ /**
451
+ * <p>The name of the field.</p>
452
+ */
453
+ name?: string;
454
+ /**
455
+ * <p>The minimum value to display for the field.</p>
456
+ */
457
+ minValue?: number;
458
+ /**
459
+ * <p>The maximum value to display for the field.</p>
460
+ */
461
+ maxValue?: number;
462
+ /**
463
+ * <p>The stepping increment for a numeric value in a field.</p>
464
+ */
465
+ step?: number;
466
+ /**
467
+ * <p>The value for the field.</p>
468
+ */
469
+ value?: string;
470
+ }
471
+ /**
472
+ * <p>Describes the validation configuration for a field.</p>
473
+ */
474
+ export interface FieldValidationConfiguration {
475
+ /**
476
+ * <p>The validation to perform on an object type.<code/>
477
+ * </p>
478
+ */
479
+ type: string | undefined;
480
+ /**
481
+ * <p>The validation to perform on a string value.</p>
482
+ */
483
+ strValues?: string[];
484
+ /**
485
+ * <p>The validation to perform on a number value.</p>
486
+ */
487
+ numValues?: number[];
488
+ /**
489
+ * <p>The validation message to display.</p>
490
+ */
491
+ validationMessage?: string;
492
+ }
493
+ /**
494
+ * <p>Describes the configuration information for a field in a table.</p>
495
+ */
496
+ export interface FieldConfig {
497
+ /**
498
+ * <p>The label for the field.</p>
499
+ */
500
+ label?: string;
501
+ /**
502
+ * <p>Specifies the field position.</p>
503
+ */
504
+ position?: FieldPosition;
505
+ /**
506
+ * <p>Specifies whether to hide a field.</p>
507
+ */
508
+ excluded?: boolean;
509
+ /**
510
+ * <p>Describes the configuration for the default input value to display for a field.</p>
511
+ */
512
+ inputType?: FieldInputConfig;
513
+ /**
514
+ * <p>The validations to perform on the value in the field.</p>
515
+ */
516
+ validations?: FieldValidationConfiguration[];
517
+ }
518
+ export declare enum FormActionType {
519
+ CREATE = "create",
520
+ UPDATE = "update"
521
+ }
522
+ /**
523
+ * <p>Stores the configuration information for a visual helper element for a form. A sectional
524
+ * element can be a header, a text block, or a divider. These elements are static and not
525
+ * associated with any data.</p>
526
+ */
527
+ export interface SectionalElement {
528
+ /**
529
+ * <p>The type of sectional element. Valid values are <code>Heading</code>, <code>Text</code>,
530
+ * and <code>Divider</code>.</p>
531
+ */
532
+ type: string | undefined;
533
+ /**
534
+ * <p>Specifies the position of the text in a field for a <code>Text</code> sectional
535
+ * element.</p>
536
+ */
537
+ position?: FieldPosition;
538
+ /**
539
+ * <p>The text for a <code>Text</code> sectional element.</p>
540
+ */
541
+ text?: string;
542
+ /**
543
+ * <p>Specifies the size of the font for a <code>Heading</code> sectional element. Valid values
544
+ * are <code>1 | 2 | 3 | 4 | 5 | 6</code>.</p>
545
+ */
546
+ level?: number;
547
+ /**
548
+ * <p>Specifies the orientation for a <code>Divider</code> sectional element. Valid values are
549
+ * <code>horizontal</code> or <code>vertical</code>.</p>
550
+ */
551
+ orientation?: string;
552
+ }
553
+ /**
554
+ * <p>Describes the configuration settings for the form's style properties.</p>
555
+ */
556
+ export declare type FormStyleConfig = FormStyleConfig.TokenReferenceMember | FormStyleConfig.ValueMember | FormStyleConfig.$UnknownMember;
557
+ export declare namespace FormStyleConfig {
558
+ /**
559
+ * <p>A reference to a design token to use to bind the form's style properties to an existing
560
+ * theme.</p>
561
+ */
562
+ interface TokenReferenceMember {
563
+ tokenReference: string;
564
+ value?: never;
565
+ $unknown?: never;
566
+ }
567
+ /**
568
+ * <p>The value of the style setting.</p>
569
+ */
570
+ interface ValueMember {
571
+ tokenReference?: never;
572
+ value: string;
573
+ $unknown?: never;
574
+ }
575
+ interface $UnknownMember {
576
+ tokenReference?: never;
577
+ value?: never;
578
+ $unknown: [string, any];
579
+ }
580
+ interface Visitor<T> {
581
+ tokenReference: (value: string) => T;
582
+ value: (value: string) => T;
583
+ _: (name: string, value: any) => T;
584
+ }
585
+ const visit: <T>(value: FormStyleConfig, visitor: Visitor<T>) => T;
586
+ }
587
+ /**
588
+ * <p>Describes the configuration for the form's style.</p>
589
+ */
590
+ export interface FormStyle {
591
+ /**
592
+ * <p>The spacing for the horizontal gap.</p>
593
+ */
594
+ horizontalGap?: FormStyleConfig;
595
+ /**
596
+ * <p>The spacing for the vertical gap.</p>
597
+ */
598
+ verticalGap?: FormStyleConfig;
599
+ /**
600
+ * <p>The size of the outer padding for the form.</p>
601
+ */
602
+ outerPadding?: FormStyleConfig;
603
+ }
604
+ /**
605
+ * <p>Represents all of the information that is required to create a form.</p>
606
+ */
607
+ export interface CreateFormData {
608
+ /**
609
+ * <p>The name of the form.</p>
610
+ */
611
+ name: string | undefined;
612
+ /**
613
+ * <p>The type of data source to use to create the form.</p>
614
+ */
615
+ dataType: FormDataTypeConfig | undefined;
616
+ /**
617
+ * <p>Specifies whether to perform a create or update action on the form.</p>
618
+ */
619
+ formActionType: FormActionType | string | undefined;
620
+ /**
621
+ * <p>The configuration information for the form's fields.</p>
622
+ */
623
+ fields: Record<string, FieldConfig> | undefined;
624
+ /**
625
+ * <p>The configuration for the form's style.</p>
626
+ */
627
+ style: FormStyle | undefined;
628
+ /**
629
+ * <p>The configuration information for the visual helper elements for the form. These elements
630
+ * are not associated with any data.</p>
631
+ */
632
+ sectionalElements: Record<string, SectionalElement> | undefined;
633
+ /**
634
+ * <p>The schema version of the form.</p>
635
+ */
636
+ schemaVersion: string | undefined;
637
+ /**
638
+ * <p>The <code>FormCTA</code> object that stores the call to action configuration for the
639
+ * form.</p>
640
+ */
641
+ cta?: FormCTA;
642
+ /**
643
+ * <p>One or more key-value pairs to use when tagging the form data.</p>
644
+ */
645
+ tags?: Record<string, string>;
646
+ }
647
+ export interface CreateFormRequest {
648
+ /**
649
+ * <p>The unique ID of the Amplify app to associate with the form.</p>
650
+ */
651
+ appId: string | undefined;
652
+ /**
653
+ * <p>The name of the backend environment that is a part of the Amplify app.</p>
654
+ */
655
+ environmentName: string | undefined;
656
+ /**
657
+ * <p>The unique client token.</p>
658
+ */
659
+ clientToken?: string;
660
+ /**
661
+ * <p>Represents the configuration of the form to create.</p>
662
+ */
663
+ formToCreate: CreateFormData | undefined;
664
+ }
665
+ /**
666
+ * <p>Contains the configuration settings for a <code>Form</code> user interface (UI) element
667
+ * for an Amplify app. A form is a component you can add to your project by specifying a data
668
+ * source as the default configuration for the form.</p>
669
+ */
670
+ export interface Form {
671
+ /**
672
+ * <p>The unique ID of the Amplify app associated with the form.</p>
673
+ */
674
+ appId: string | undefined;
675
+ /**
676
+ * <p>The name of the backend environment that is a part of the Amplify app.</p>
677
+ */
678
+ environmentName: string | undefined;
679
+ /**
680
+ * <p>The unique ID of the form.</p>
681
+ */
682
+ id: string | undefined;
683
+ /**
684
+ * <p>The name of the form.</p>
685
+ */
686
+ name: string | undefined;
687
+ /**
688
+ * <p>The operation to perform on the specified form.</p>
689
+ */
690
+ formActionType: FormActionType | string | undefined;
691
+ /**
692
+ * <p>Stores the configuration for the form's style.</p>
693
+ */
694
+ style: FormStyle | undefined;
695
+ /**
696
+ * <p>The type of data source to use to create the form.</p>
697
+ */
698
+ dataType: FormDataTypeConfig | undefined;
699
+ /**
700
+ * <p>Stores the information about the form's fields.</p>
701
+ */
702
+ fields: Record<string, FieldConfig> | undefined;
703
+ /**
704
+ * <p>Stores the visual helper elements for the form that are not associated with any
705
+ * data.</p>
706
+ */
707
+ sectionalElements: Record<string, SectionalElement> | undefined;
708
+ /**
709
+ * <p>The schema version of the form when it was imported.</p>
710
+ */
711
+ schemaVersion: string | undefined;
712
+ /**
713
+ * <p>One or more key-value pairs to use when tagging the form.</p>
714
+ */
715
+ tags?: Record<string, string>;
716
+ /**
717
+ * <p>Stores the call to action configuration for the form.</p>
718
+ */
719
+ cta?: FormCTA;
720
+ }
721
+ export interface CreateFormResponse {
722
+ /**
723
+ * <p>Describes the configuration of the new form.</p>
724
+ */
725
+ entity?: Form;
726
+ }
727
+ export interface DeleteFormRequest {
728
+ /**
729
+ * <p>The unique ID of the Amplify app associated with the form to delete.</p>
730
+ */
731
+ appId: string | undefined;
732
+ /**
733
+ * <p>The name of the backend environment that is a part of the Amplify app.</p>
734
+ */
735
+ environmentName: string | undefined;
736
+ /**
737
+ * <p>The unique ID of the form to delete.</p>
738
+ */
739
+ id: string | undefined;
740
+ }
741
+ export interface ExportFormsRequest {
742
+ /**
743
+ * <p>The unique ID of the Amplify app to export forms to.</p>
744
+ */
745
+ appId: string | undefined;
746
+ /**
747
+ * <p>The name of the backend environment that is a part of the Amplify app.</p>
748
+ */
749
+ environmentName: string | undefined;
750
+ /**
751
+ * <p>The token to request the next page of results.</p>
752
+ */
753
+ nextToken?: string;
754
+ }
755
+ export interface ExportFormsResponse {
756
+ /**
757
+ * <p>Represents the configuration of the exported forms.</p>
758
+ */
759
+ entities: Form[] | undefined;
760
+ /**
761
+ * <p>The pagination token that's included if more results are available.</p>
762
+ */
763
+ nextToken?: string;
764
+ }
765
+ export interface GetFormRequest {
766
+ /**
767
+ * <p>The unique ID of the Amplify app.</p>
768
+ */
769
+ appId: string | undefined;
770
+ /**
771
+ * <p>The name of the backend environment that is part of the Amplify app.</p>
772
+ */
773
+ environmentName: string | undefined;
774
+ /**
775
+ * <p>The unique ID of the form.</p>
776
+ */
777
+ id: string | undefined;
778
+ }
779
+ export interface GetFormResponse {
780
+ /**
781
+ * <p>Represents the configuration settings for the form.</p>
782
+ */
783
+ form?: Form;
784
+ }
785
+ export interface ListFormsRequest {
786
+ /**
787
+ * <p>The unique ID for the Amplify app.</p>
788
+ */
789
+ appId: string | undefined;
790
+ /**
791
+ * <p>The name of the backend environment that is a part of the Amplify app.</p>
792
+ */
793
+ environmentName: string | undefined;
794
+ /**
795
+ * <p>The token to request the next page of results.</p>
796
+ */
797
+ nextToken?: string;
798
+ /**
799
+ * <p>The maximum number of forms to retrieve.</p>
800
+ */
801
+ maxResults?: number;
802
+ }
803
+ /**
804
+ * <p>Describes the basic information about a form.</p>
805
+ */
806
+ export interface FormSummary {
807
+ /**
808
+ * <p>The unique ID for the app associated with the form summary.</p>
809
+ */
810
+ appId: string | undefined;
811
+ /**
812
+ * <p>The form's data source type.</p>
813
+ */
814
+ dataType: FormDataTypeConfig | undefined;
815
+ /**
816
+ * <p>The name of the backend environment that is part of the Amplify app.</p>
817
+ */
818
+ environmentName: string | undefined;
819
+ /**
820
+ * <p>The type of operation to perform on the form.</p>
821
+ */
822
+ formActionType: FormActionType | string | undefined;
823
+ /**
824
+ * <p>The ID of the form.</p>
825
+ */
826
+ id: string | undefined;
827
+ /**
828
+ * <p>The name of the form.</p>
829
+ */
830
+ name: string | undefined;
831
+ }
832
+ export interface ListFormsResponse {
833
+ /**
834
+ * <p>The list of forms for the Amplify app.</p>
835
+ */
836
+ entities: FormSummary[] | undefined;
837
+ /**
838
+ * <p>The pagination token that's included if more results are available.</p>
839
+ */
840
+ nextToken?: string;
841
+ }
842
+ /**
843
+ * <p>Updates and saves all of the information about a form, based on form ID.</p>
844
+ */
845
+ export interface UpdateFormData {
846
+ /**
847
+ * <p>The name of the form.</p>
848
+ */
849
+ name?: string;
850
+ /**
851
+ * <p>The type of data source to use to create the form.</p>
852
+ */
853
+ dataType?: FormDataTypeConfig;
854
+ /**
855
+ * <p>Specifies whether to perform a create or update action on the form.</p>
856
+ */
857
+ formActionType?: FormActionType | string;
858
+ /**
859
+ * <p>The configuration information for the form's fields.</p>
860
+ */
861
+ fields?: Record<string, FieldConfig>;
862
+ /**
863
+ * <p>The configuration for the form's style.</p>
864
+ */
865
+ style?: FormStyle;
866
+ /**
867
+ * <p>The configuration information for the visual helper elements for the form. These elements
868
+ * are not associated with any data.</p>
869
+ */
870
+ sectionalElements?: Record<string, SectionalElement>;
871
+ /**
872
+ * <p>The schema version of the form.</p>
873
+ */
874
+ schemaVersion?: string;
875
+ /**
876
+ * <p>The <code>FormCTA</code> object that stores the call to action configuration for the
877
+ * form.</p>
878
+ */
879
+ cta?: FormCTA;
880
+ }
881
+ export interface UpdateFormRequest {
882
+ /**
883
+ * <p>The unique ID for the Amplify app.</p>
884
+ */
885
+ appId: string | undefined;
886
+ /**
887
+ * <p>The name of the backend environment that is part of the Amplify app.</p>
888
+ */
889
+ environmentName: string | undefined;
890
+ /**
891
+ * <p>The unique ID for the form.</p>
892
+ */
893
+ id: string | undefined;
894
+ /**
895
+ * <p>The unique client token.</p>
896
+ */
897
+ clientToken?: string;
898
+ /**
899
+ * <p>The request accepts the following data in JSON format.</p>
900
+ */
901
+ updatedForm: UpdateFormData | undefined;
902
+ }
903
+ export interface UpdateFormResponse {
904
+ /**
905
+ * <p>Describes the configuration of the updated form.</p>
906
+ */
907
+ entity?: Form;
908
+ }
909
+ export interface GetMetadataRequest {
910
+ /**
911
+ * <p>The unique ID of the Amplify app.</p>
912
+ */
913
+ appId: string | undefined;
914
+ /**
915
+ * <p>The name of the backend environment that is part of the Amplify app.</p>
916
+ */
917
+ environmentName: string | undefined;
918
+ }
919
+ export interface GetMetadataResponse {
920
+ /**
921
+ * <p>Represents the configuration settings for the features metadata.</p>
922
+ */
923
+ features: Record<string, string> | undefined;
924
+ }
925
+ /**
926
+ * <p>You don't have permission to perform this operation.</p>
927
+ */
928
+ export declare class UnauthorizedException extends __BaseException {
929
+ readonly name: "UnauthorizedException";
930
+ readonly $fault: "client";
931
+ /**
932
+ * @internal
933
+ */
934
+ constructor(opts: __ExceptionOptionType<UnauthorizedException, __BaseException>);
935
+ }
936
+ /**
937
+ * <p>Stores the metadata information about a feature on a form or view.</p>
938
+ */
939
+ export interface PutMetadataFlagBody {
940
+ /**
941
+ * <p>The new information to store.</p>
942
+ */
943
+ newValue: string | undefined;
944
+ }
945
+ export interface PutMetadataFlagRequest {
946
+ /**
947
+ * <p>The unique ID for the Amplify app.</p>
948
+ */
949
+ appId: string | undefined;
950
+ /**
951
+ * <p>The name of the backend environment that is part of the Amplify app.</p>
952
+ */
953
+ environmentName: string | undefined;
954
+ /**
955
+ * <p>The name of the feature associated with the metadata.</p>
956
+ */
957
+ featureName: string | undefined;
958
+ /**
959
+ * <p>The metadata information to store.</p>
960
+ */
961
+ body: PutMetadataFlagBody | undefined;
962
+ }
261
963
  /**
262
964
  * <p>Describes a refresh token.</p>
263
965
  */
@@ -469,6 +1171,10 @@ export interface ComponentBindingPropertiesValueProperties {
469
1171
  * <p>The default value to assign to the property.</p>
470
1172
  */
471
1173
  defaultValue?: string;
1174
+ /**
1175
+ * <p>The name of a component slot.</p>
1176
+ */
1177
+ slotName?: string;
472
1178
  }
473
1179
  /**
474
1180
  * <p>Describes the configuration for binding a component's properties to data.</p>
@@ -670,8 +1376,8 @@ export interface UpdateThemeData {
670
1376
  overrides?: ThemeValues[];
671
1377
  }
672
1378
  /**
673
- * <p>Represents the state configuration when an action modifies a property of another element
674
- * within the same component.</p>
1379
+ * <p>Represents the state configuration when an action modifies a property of another
1380
+ * element within the same component.</p>
675
1381
  */
676
1382
  export interface MutationActionSetStateParameter {
677
1383
  /**
@@ -793,15 +1499,14 @@ export interface ExportThemesResponse {
793
1499
  nextToken?: string;
794
1500
  }
795
1501
  /**
796
- * <p>Represents the event action configuration for an element of a <code>Component</code> or
797
- * <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio
1502
+ * <p>Represents the event action configuration for an element of a <code>Component</code>
1503
+ * or <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio
798
1504
  * that allows you to bind events and actions to components. <code>ActionParameters</code>
799
1505
  * defines the action that is performed when an event occurs on the component.</p>
800
1506
  */
801
1507
  export interface ActionParameters {
802
1508
  /**
803
- * <p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>.
804
- * This value is required for a navigation action.</p>
1509
+ * <p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>. This value is required for a navigation action.</p>
805
1510
  */
806
1511
  type?: ComponentProperty;
807
1512
  /**
@@ -809,8 +1514,7 @@ export interface ActionParameters {
809
1514
  */
810
1515
  url?: ComponentProperty;
811
1516
  /**
812
- * <p>The HTML anchor link to the location to open. Specify this value for a navigation
813
- * action.</p>
1517
+ * <p>The HTML anchor link to the location to open. Specify this value for a navigation action.</p>
814
1518
  */
815
1519
  anchor?: ComponentProperty;
816
1520
  /**
@@ -818,12 +1522,12 @@ export interface ActionParameters {
818
1522
  */
819
1523
  target?: ComponentProperty;
820
1524
  /**
821
- * <p>Specifies whether the user should be signed out globally. Specify this value for an auth
822
- * sign out action.</p>
1525
+ * <p>Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.</p>
823
1526
  */
824
1527
  global?: ComponentProperty;
825
1528
  /**
826
- * <p>The name of the data model. Use when the action performs an operation on an Amplify DataStore model.</p>
1529
+ * <p>The name of the data model. Use when the action performs an operation on an Amplify DataStore
1530
+ * model.</p>
827
1531
  */
828
1532
  model?: string;
829
1533
  /**
@@ -831,9 +1535,8 @@ export interface ActionParameters {
831
1535
  */
832
1536
  id?: ComponentProperty;
833
1537
  /**
834
- * <p>A dictionary of key-value pairs mapping Amplify Studio properties to fields
835
- * in a data model. Use when the action performs an operation on an Amplify
836
- * DataStore model.</p>
1538
+ * <p>A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action
1539
+ * performs an operation on an Amplify DataStore model.</p>
837
1540
  */
838
1541
  fields?: Record<string, ComponentProperty>;
839
1542
  /**
@@ -842,9 +1545,9 @@ export interface ActionParameters {
842
1545
  state?: MutationActionSetStateParameter;
843
1546
  }
844
1547
  /**
845
- * <p>Describes the configuration of an event. You can bind an event and a corresponding action
846
- * to a <code>Component</code> or a <code>ComponentChild</code>. A button click is an example of
847
- * an event. </p>
1548
+ * <p>Describes the configuration of an event. You can bind an event and a corresponding
1549
+ * action to a <code>Component</code> or a <code>ComponentChild</code>. A button click
1550
+ * is an example of an event. </p>
848
1551
  */
849
1552
  export interface ComponentEvent {
850
1553
  /**
@@ -856,7 +1559,8 @@ export interface ComponentEvent {
856
1559
  */
857
1560
  parameters?: ActionParameters;
858
1561
  /**
859
- * <p>Binds an event to an action on a component. When you specify a <code>bindingEvent</code>, the event is called when the action is performed.</p>
1562
+ * <p>Binds an event to an action on a component. When you specify a <code>bindingEvent</code>,
1563
+ * the event is called when the action is performed.</p>
860
1564
  */
861
1565
  bindingEvent?: string;
862
1566
  }
@@ -882,9 +1586,8 @@ export interface ComponentChild {
882
1586
  */
883
1587
  children?: ComponentChild[];
884
1588
  /**
885
- * <p>Describes the events that can be raised on the child component. Use for the workflow
886
- * feature in Amplify Studio that allows you to bind events and actions to
887
- * components.</p>
1589
+ * <p>Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to
1590
+ * bind events and actions to components.</p>
888
1591
  */
889
1592
  events?: Record<string, ComponentEvent>;
890
1593
  /**
@@ -970,9 +1673,8 @@ export interface Component {
970
1673
  */
971
1674
  tags?: Record<string, string>;
972
1675
  /**
973
- * <p>Describes the events that can be raised on the component. Use for the workflow feature in
974
- * Amplify Studio that allows you to bind events and actions to
975
- * components.</p>
1676
+ * <p>Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to
1677
+ * bind events and actions to components.</p>
976
1678
  */
977
1679
  events?: Record<string, ComponentEvent>;
978
1680
  /**
@@ -1212,6 +1914,134 @@ export declare const ExchangeCodeForTokenRequestFilterSensitiveLog: (obj: Exchan
1212
1914
  * @internal
1213
1915
  */
1214
1916
  export declare const ExchangeCodeForTokenResponseFilterSensitiveLog: (obj: ExchangeCodeForTokenResponse) => any;
1917
+ /**
1918
+ * @internal
1919
+ */
1920
+ export declare const FieldPositionFilterSensitiveLog: (obj: FieldPosition) => any;
1921
+ /**
1922
+ * @internal
1923
+ */
1924
+ export declare const FormButtonFilterSensitiveLog: (obj: FormButton) => any;
1925
+ /**
1926
+ * @internal
1927
+ */
1928
+ export declare const FormCTAFilterSensitiveLog: (obj: FormCTA) => any;
1929
+ /**
1930
+ * @internal
1931
+ */
1932
+ export declare const FormDataTypeConfigFilterSensitiveLog: (obj: FormDataTypeConfig) => any;
1933
+ /**
1934
+ * @internal
1935
+ */
1936
+ export declare const FormInputValuePropertyFilterSensitiveLog: (obj: FormInputValueProperty) => any;
1937
+ /**
1938
+ * @internal
1939
+ */
1940
+ export declare const ValueMappingFilterSensitiveLog: (obj: ValueMapping) => any;
1941
+ /**
1942
+ * @internal
1943
+ */
1944
+ export declare const ValueMappingsFilterSensitiveLog: (obj: ValueMappings) => any;
1945
+ /**
1946
+ * @internal
1947
+ */
1948
+ export declare const FieldInputConfigFilterSensitiveLog: (obj: FieldInputConfig) => any;
1949
+ /**
1950
+ * @internal
1951
+ */
1952
+ export declare const FieldValidationConfigurationFilterSensitiveLog: (obj: FieldValidationConfiguration) => any;
1953
+ /**
1954
+ * @internal
1955
+ */
1956
+ export declare const FieldConfigFilterSensitiveLog: (obj: FieldConfig) => any;
1957
+ /**
1958
+ * @internal
1959
+ */
1960
+ export declare const SectionalElementFilterSensitiveLog: (obj: SectionalElement) => any;
1961
+ /**
1962
+ * @internal
1963
+ */
1964
+ export declare const FormStyleConfigFilterSensitiveLog: (obj: FormStyleConfig) => any;
1965
+ /**
1966
+ * @internal
1967
+ */
1968
+ export declare const FormStyleFilterSensitiveLog: (obj: FormStyle) => any;
1969
+ /**
1970
+ * @internal
1971
+ */
1972
+ export declare const CreateFormDataFilterSensitiveLog: (obj: CreateFormData) => any;
1973
+ /**
1974
+ * @internal
1975
+ */
1976
+ export declare const CreateFormRequestFilterSensitiveLog: (obj: CreateFormRequest) => any;
1977
+ /**
1978
+ * @internal
1979
+ */
1980
+ export declare const FormFilterSensitiveLog: (obj: Form) => any;
1981
+ /**
1982
+ * @internal
1983
+ */
1984
+ export declare const CreateFormResponseFilterSensitiveLog: (obj: CreateFormResponse) => any;
1985
+ /**
1986
+ * @internal
1987
+ */
1988
+ export declare const DeleteFormRequestFilterSensitiveLog: (obj: DeleteFormRequest) => any;
1989
+ /**
1990
+ * @internal
1991
+ */
1992
+ export declare const ExportFormsRequestFilterSensitiveLog: (obj: ExportFormsRequest) => any;
1993
+ /**
1994
+ * @internal
1995
+ */
1996
+ export declare const ExportFormsResponseFilterSensitiveLog: (obj: ExportFormsResponse) => any;
1997
+ /**
1998
+ * @internal
1999
+ */
2000
+ export declare const GetFormRequestFilterSensitiveLog: (obj: GetFormRequest) => any;
2001
+ /**
2002
+ * @internal
2003
+ */
2004
+ export declare const GetFormResponseFilterSensitiveLog: (obj: GetFormResponse) => any;
2005
+ /**
2006
+ * @internal
2007
+ */
2008
+ export declare const ListFormsRequestFilterSensitiveLog: (obj: ListFormsRequest) => any;
2009
+ /**
2010
+ * @internal
2011
+ */
2012
+ export declare const FormSummaryFilterSensitiveLog: (obj: FormSummary) => any;
2013
+ /**
2014
+ * @internal
2015
+ */
2016
+ export declare const ListFormsResponseFilterSensitiveLog: (obj: ListFormsResponse) => any;
2017
+ /**
2018
+ * @internal
2019
+ */
2020
+ export declare const UpdateFormDataFilterSensitiveLog: (obj: UpdateFormData) => any;
2021
+ /**
2022
+ * @internal
2023
+ */
2024
+ export declare const UpdateFormRequestFilterSensitiveLog: (obj: UpdateFormRequest) => any;
2025
+ /**
2026
+ * @internal
2027
+ */
2028
+ export declare const UpdateFormResponseFilterSensitiveLog: (obj: UpdateFormResponse) => any;
2029
+ /**
2030
+ * @internal
2031
+ */
2032
+ export declare const GetMetadataRequestFilterSensitiveLog: (obj: GetMetadataRequest) => any;
2033
+ /**
2034
+ * @internal
2035
+ */
2036
+ export declare const GetMetadataResponseFilterSensitiveLog: (obj: GetMetadataResponse) => any;
2037
+ /**
2038
+ * @internal
2039
+ */
2040
+ export declare const PutMetadataFlagBodyFilterSensitiveLog: (obj: PutMetadataFlagBody) => any;
2041
+ /**
2042
+ * @internal
2043
+ */
2044
+ export declare const PutMetadataFlagRequestFilterSensitiveLog: (obj: PutMetadataFlagRequest) => any;
1215
2045
  /**
1216
2046
  * @internal
1217
2047
  */