aws-sdk-amplifyuibuilder 1.5.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -581,6 +581,7 @@ module Aws::AmplifyUIBuilder
581
581
  # },
582
582
  # },
583
583
  # ],
584
+ # slot_name: "String",
584
585
  # user_attribute: "String",
585
586
  # },
586
587
  # default_value: "String",
@@ -637,6 +638,7 @@ module Aws::AmplifyUIBuilder
637
638
  # },
638
639
  # },
639
640
  # ],
641
+ # slot_name: "String",
640
642
  # user_attribute: "String",
641
643
  # }
642
644
  #
@@ -664,6 +666,10 @@ module Aws::AmplifyUIBuilder
664
666
  # A list of predicates for binding a component's properties to data.
665
667
  # @return [Array<Types::Predicate>]
666
668
  #
669
+ # @!attribute [rw] slot_name
670
+ # The name of a component slot.
671
+ # @return [String]
672
+ #
667
673
  # @!attribute [rw] user_attribute
668
674
  # An authenticated user attribute.
669
675
  # @return [String]
@@ -677,6 +683,7 @@ module Aws::AmplifyUIBuilder
677
683
  :key,
678
684
  :model,
679
685
  :predicates,
686
+ :slot_name,
680
687
  :user_attribute)
681
688
  SENSITIVE = []
682
689
  include Aws::Structure
@@ -2547,6 +2554,7 @@ module Aws::AmplifyUIBuilder
2547
2554
  # },
2548
2555
  # },
2549
2556
  # ],
2557
+ # slot_name: "String",
2550
2558
  # user_attribute: "String",
2551
2559
  # },
2552
2560
  # default_value: "String",
@@ -3543,6 +3551,7 @@ module Aws::AmplifyUIBuilder
3543
3551
  # },
3544
3552
  # },
3545
3553
  # ],
3554
+ # slot_name: "String",
3546
3555
  # user_attribute: "String",
3547
3556
  # },
3548
3557
  # default_value: "String",
@@ -4483,6 +4492,350 @@ module Aws::AmplifyUIBuilder
4483
4492
  include Aws::Structure
4484
4493
  end
4485
4494
 
4495
+ # Represents all of the information that is required to create a form.
4496
+ #
4497
+ # @note When making an API call, you may pass CreateFormData
4498
+ # data as a hash:
4499
+ #
4500
+ # {
4501
+ # cta: {
4502
+ # cancel: {
4503
+ # children: "String",
4504
+ # excluded: false,
4505
+ # position: {
4506
+ # below: "String",
4507
+ # fixed: "first", # accepts first
4508
+ # right_of: "String",
4509
+ # },
4510
+ # },
4511
+ # clear: {
4512
+ # children: "String",
4513
+ # excluded: false,
4514
+ # position: {
4515
+ # below: "String",
4516
+ # fixed: "first", # accepts first
4517
+ # right_of: "String",
4518
+ # },
4519
+ # },
4520
+ # position: "top", # accepts top, bottom, top_and_bottom
4521
+ # submit: {
4522
+ # children: "String",
4523
+ # excluded: false,
4524
+ # position: {
4525
+ # below: "String",
4526
+ # fixed: "first", # accepts first
4527
+ # right_of: "String",
4528
+ # },
4529
+ # },
4530
+ # },
4531
+ # data_type: { # required
4532
+ # data_source_type: "DataStore", # required, accepts DataStore, Custom
4533
+ # data_type_name: "String", # required
4534
+ # },
4535
+ # fields: { # required
4536
+ # "String" => {
4537
+ # excluded: false,
4538
+ # input_type: {
4539
+ # default_checked: false,
4540
+ # default_country_code: "String",
4541
+ # default_value: "String",
4542
+ # descriptive_text: "String",
4543
+ # is_array: false,
4544
+ # max_value: 1.0,
4545
+ # min_value: 1.0,
4546
+ # name: "String",
4547
+ # placeholder: "String",
4548
+ # read_only: false,
4549
+ # required: false,
4550
+ # step: 1.0,
4551
+ # type: "String", # required
4552
+ # value: "String",
4553
+ # value_mappings: {
4554
+ # values: [ # required
4555
+ # {
4556
+ # display_value: {
4557
+ # value: "String",
4558
+ # },
4559
+ # value: { # required
4560
+ # value: "String",
4561
+ # },
4562
+ # },
4563
+ # ],
4564
+ # },
4565
+ # },
4566
+ # label: "String",
4567
+ # position: {
4568
+ # below: "String",
4569
+ # fixed: "first", # accepts first
4570
+ # right_of: "String",
4571
+ # },
4572
+ # validations: [
4573
+ # {
4574
+ # num_values: [1],
4575
+ # str_values: ["String"],
4576
+ # type: "String", # required
4577
+ # validation_message: "String",
4578
+ # },
4579
+ # ],
4580
+ # },
4581
+ # },
4582
+ # form_action_type: "create", # required, accepts create, update
4583
+ # name: "FormName", # required
4584
+ # schema_version: "String", # required
4585
+ # sectional_elements: { # required
4586
+ # "String" => {
4587
+ # level: 1,
4588
+ # orientation: "String",
4589
+ # position: {
4590
+ # below: "String",
4591
+ # fixed: "first", # accepts first
4592
+ # right_of: "String",
4593
+ # },
4594
+ # text: "String",
4595
+ # type: "String", # required
4596
+ # },
4597
+ # },
4598
+ # style: { # required
4599
+ # horizontal_gap: {
4600
+ # token_reference: "String",
4601
+ # value: "String",
4602
+ # },
4603
+ # outer_padding: {
4604
+ # token_reference: "String",
4605
+ # value: "String",
4606
+ # },
4607
+ # vertical_gap: {
4608
+ # token_reference: "String",
4609
+ # value: "String",
4610
+ # },
4611
+ # },
4612
+ # tags: {
4613
+ # "TagKey" => "TagValue",
4614
+ # },
4615
+ # }
4616
+ #
4617
+ # @!attribute [rw] cta
4618
+ # The `FormCTA` object that stores the call to action configuration
4619
+ # for the form.
4620
+ # @return [Types::FormCTA]
4621
+ #
4622
+ # @!attribute [rw] data_type
4623
+ # The type of data source to use to create the form.
4624
+ # @return [Types::FormDataTypeConfig]
4625
+ #
4626
+ # @!attribute [rw] fields
4627
+ # The configuration information for the form's fields.
4628
+ # @return [Hash<String,Types::FieldConfig>]
4629
+ #
4630
+ # @!attribute [rw] form_action_type
4631
+ # Specifies whether to perform a create or update action on the form.
4632
+ # @return [String]
4633
+ #
4634
+ # @!attribute [rw] name
4635
+ # The name of the form.
4636
+ # @return [String]
4637
+ #
4638
+ # @!attribute [rw] schema_version
4639
+ # The schema version of the form.
4640
+ # @return [String]
4641
+ #
4642
+ # @!attribute [rw] sectional_elements
4643
+ # The configuration information for the visual helper elements for the
4644
+ # form. These elements are not associated with any data.
4645
+ # @return [Hash<String,Types::SectionalElement>]
4646
+ #
4647
+ # @!attribute [rw] style
4648
+ # The configuration for the form's style.
4649
+ # @return [Types::FormStyle]
4650
+ #
4651
+ # @!attribute [rw] tags
4652
+ # One or more key-value pairs to use when tagging the form data.
4653
+ # @return [Hash<String,String>]
4654
+ #
4655
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateFormData AWS API Documentation
4656
+ #
4657
+ class CreateFormData < Struct.new(
4658
+ :cta,
4659
+ :data_type,
4660
+ :fields,
4661
+ :form_action_type,
4662
+ :name,
4663
+ :schema_version,
4664
+ :sectional_elements,
4665
+ :style,
4666
+ :tags)
4667
+ SENSITIVE = []
4668
+ include Aws::Structure
4669
+ end
4670
+
4671
+ # @note When making an API call, you may pass CreateFormRequest
4672
+ # data as a hash:
4673
+ #
4674
+ # {
4675
+ # app_id: "String", # required
4676
+ # client_token: "String",
4677
+ # environment_name: "String", # required
4678
+ # form_to_create: { # required
4679
+ # cta: {
4680
+ # cancel: {
4681
+ # children: "String",
4682
+ # excluded: false,
4683
+ # position: {
4684
+ # below: "String",
4685
+ # fixed: "first", # accepts first
4686
+ # right_of: "String",
4687
+ # },
4688
+ # },
4689
+ # clear: {
4690
+ # children: "String",
4691
+ # excluded: false,
4692
+ # position: {
4693
+ # below: "String",
4694
+ # fixed: "first", # accepts first
4695
+ # right_of: "String",
4696
+ # },
4697
+ # },
4698
+ # position: "top", # accepts top, bottom, top_and_bottom
4699
+ # submit: {
4700
+ # children: "String",
4701
+ # excluded: false,
4702
+ # position: {
4703
+ # below: "String",
4704
+ # fixed: "first", # accepts first
4705
+ # right_of: "String",
4706
+ # },
4707
+ # },
4708
+ # },
4709
+ # data_type: { # required
4710
+ # data_source_type: "DataStore", # required, accepts DataStore, Custom
4711
+ # data_type_name: "String", # required
4712
+ # },
4713
+ # fields: { # required
4714
+ # "String" => {
4715
+ # excluded: false,
4716
+ # input_type: {
4717
+ # default_checked: false,
4718
+ # default_country_code: "String",
4719
+ # default_value: "String",
4720
+ # descriptive_text: "String",
4721
+ # is_array: false,
4722
+ # max_value: 1.0,
4723
+ # min_value: 1.0,
4724
+ # name: "String",
4725
+ # placeholder: "String",
4726
+ # read_only: false,
4727
+ # required: false,
4728
+ # step: 1.0,
4729
+ # type: "String", # required
4730
+ # value: "String",
4731
+ # value_mappings: {
4732
+ # values: [ # required
4733
+ # {
4734
+ # display_value: {
4735
+ # value: "String",
4736
+ # },
4737
+ # value: { # required
4738
+ # value: "String",
4739
+ # },
4740
+ # },
4741
+ # ],
4742
+ # },
4743
+ # },
4744
+ # label: "String",
4745
+ # position: {
4746
+ # below: "String",
4747
+ # fixed: "first", # accepts first
4748
+ # right_of: "String",
4749
+ # },
4750
+ # validations: [
4751
+ # {
4752
+ # num_values: [1],
4753
+ # str_values: ["String"],
4754
+ # type: "String", # required
4755
+ # validation_message: "String",
4756
+ # },
4757
+ # ],
4758
+ # },
4759
+ # },
4760
+ # form_action_type: "create", # required, accepts create, update
4761
+ # name: "FormName", # required
4762
+ # schema_version: "String", # required
4763
+ # sectional_elements: { # required
4764
+ # "String" => {
4765
+ # level: 1,
4766
+ # orientation: "String",
4767
+ # position: {
4768
+ # below: "String",
4769
+ # fixed: "first", # accepts first
4770
+ # right_of: "String",
4771
+ # },
4772
+ # text: "String",
4773
+ # type: "String", # required
4774
+ # },
4775
+ # },
4776
+ # style: { # required
4777
+ # horizontal_gap: {
4778
+ # token_reference: "String",
4779
+ # value: "String",
4780
+ # },
4781
+ # outer_padding: {
4782
+ # token_reference: "String",
4783
+ # value: "String",
4784
+ # },
4785
+ # vertical_gap: {
4786
+ # token_reference: "String",
4787
+ # value: "String",
4788
+ # },
4789
+ # },
4790
+ # tags: {
4791
+ # "TagKey" => "TagValue",
4792
+ # },
4793
+ # },
4794
+ # }
4795
+ #
4796
+ # @!attribute [rw] app_id
4797
+ # The unique ID of the Amplify app to associate with the form.
4798
+ # @return [String]
4799
+ #
4800
+ # @!attribute [rw] client_token
4801
+ # The unique client token.
4802
+ #
4803
+ # **A suitable default value is auto-generated.** You should normally
4804
+ # not need to pass this option.
4805
+ # @return [String]
4806
+ #
4807
+ # @!attribute [rw] environment_name
4808
+ # The name of the backend environment that is a part of the Amplify
4809
+ # app.
4810
+ # @return [String]
4811
+ #
4812
+ # @!attribute [rw] form_to_create
4813
+ # Represents the configuration of the form to create.
4814
+ # @return [Types::CreateFormData]
4815
+ #
4816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateFormRequest AWS API Documentation
4817
+ #
4818
+ class CreateFormRequest < Struct.new(
4819
+ :app_id,
4820
+ :client_token,
4821
+ :environment_name,
4822
+ :form_to_create)
4823
+ SENSITIVE = []
4824
+ include Aws::Structure
4825
+ end
4826
+
4827
+ # @!attribute [rw] entity
4828
+ # Describes the configuration of the new form.
4829
+ # @return [Types::Form]
4830
+ #
4831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateFormResponse AWS API Documentation
4832
+ #
4833
+ class CreateFormResponse < Struct.new(
4834
+ :entity)
4835
+ SENSITIVE = []
4836
+ include Aws::Structure
4837
+ end
4838
+
4486
4839
  # Represents all of the information that is required to create a theme.
4487
4840
  #
4488
4841
  # @note When making an API call, you may pass CreateThemeData
@@ -4658,6 +5011,38 @@ module Aws::AmplifyUIBuilder
4658
5011
  include Aws::Structure
4659
5012
  end
4660
5013
 
5014
+ # @note When making an API call, you may pass DeleteFormRequest
5015
+ # data as a hash:
5016
+ #
5017
+ # {
5018
+ # app_id: "String", # required
5019
+ # environment_name: "String", # required
5020
+ # id: "Uuid", # required
5021
+ # }
5022
+ #
5023
+ # @!attribute [rw] app_id
5024
+ # The unique ID of the Amplify app associated with the form to delete.
5025
+ # @return [String]
5026
+ #
5027
+ # @!attribute [rw] environment_name
5028
+ # The name of the backend environment that is a part of the Amplify
5029
+ # app.
5030
+ # @return [String]
5031
+ #
5032
+ # @!attribute [rw] id
5033
+ # The unique ID of the form to delete.
5034
+ # @return [String]
5035
+ #
5036
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/DeleteFormRequest AWS API Documentation
5037
+ #
5038
+ class DeleteFormRequest < Struct.new(
5039
+ :app_id,
5040
+ :environment_name,
5041
+ :id)
5042
+ SENSITIVE = []
5043
+ include Aws::Structure
5044
+ end
5045
+
4661
5046
  # @note When making an API call, you may pass DeleteThemeRequest
4662
5047
  # data as a hash:
4663
5048
  #
@@ -4820,7 +5205,7 @@ module Aws::AmplifyUIBuilder
4820
5205
  include Aws::Structure
4821
5206
  end
4822
5207
 
4823
- # @note When making an API call, you may pass ExportThemesRequest
5208
+ # @note When making an API call, you may pass ExportFormsRequest
4824
5209
  # data as a hash:
4825
5210
  #
4826
5211
  # {
@@ -4830,20 +5215,21 @@ module Aws::AmplifyUIBuilder
4830
5215
  # }
4831
5216
  #
4832
5217
  # @!attribute [rw] app_id
4833
- # The unique ID of the Amplify app to export the themes to.
5218
+ # The unique ID of the Amplify app to export forms to.
4834
5219
  # @return [String]
4835
5220
  #
4836
5221
  # @!attribute [rw] environment_name
4837
- # The name of the backend environment that is part of the Amplify app.
5222
+ # The name of the backend environment that is a part of the Amplify
5223
+ # app.
4838
5224
  # @return [String]
4839
5225
  #
4840
5226
  # @!attribute [rw] next_token
4841
5227
  # The token to request the next page of results.
4842
5228
  # @return [String]
4843
5229
  #
4844
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemesRequest AWS API Documentation
5230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportFormsRequest AWS API Documentation
4845
5231
  #
4846
- class ExportThemesRequest < Struct.new(
5232
+ class ExportFormsRequest < Struct.new(
4847
5233
  :app_id,
4848
5234
  :environment_name,
4849
5235
  :next_token)
@@ -4852,103 +5238,849 @@ module Aws::AmplifyUIBuilder
4852
5238
  end
4853
5239
 
4854
5240
  # @!attribute [rw] entities
4855
- # Represents the configuration of the exported themes.
4856
- # @return [Array<Types::Theme>]
5241
+ # Represents the configuration of the exported forms.
5242
+ # @return [Array<Types::Form>]
4857
5243
  #
4858
5244
  # @!attribute [rw] next_token
4859
5245
  # The pagination token that's included if more results are available.
4860
5246
  # @return [String]
4861
5247
  #
4862
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemesResponse AWS API Documentation
5248
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportFormsResponse AWS API Documentation
4863
5249
  #
4864
- class ExportThemesResponse < Struct.new(
5250
+ class ExportFormsResponse < Struct.new(
4865
5251
  :entities,
4866
5252
  :next_token)
4867
5253
  SENSITIVE = []
4868
5254
  include Aws::Structure
4869
5255
  end
4870
5256
 
4871
- # Describes how to bind a component property to form data.
4872
- #
4873
- # @note When making an API call, you may pass FormBindingElement
4874
- # data as a hash:
4875
- #
4876
- # {
4877
- # element: "String", # required
4878
- # property: "String", # required
4879
- # }
4880
- #
4881
- # @!attribute [rw] element
4882
- # The name of the component to retrieve a value from.
4883
- # @return [String]
4884
- #
4885
- # @!attribute [rw] property
4886
- # The property to retrieve a value from.
4887
- # @return [String]
4888
- #
4889
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormBindingElement AWS API Documentation
4890
- #
4891
- class FormBindingElement < Struct.new(
4892
- :element,
4893
- :property)
4894
- SENSITIVE = []
4895
- include Aws::Structure
4896
- end
4897
-
4898
- # @note When making an API call, you may pass GetComponentRequest
5257
+ # @note When making an API call, you may pass ExportThemesRequest
4899
5258
  # data as a hash:
4900
5259
  #
4901
5260
  # {
4902
5261
  # app_id: "String", # required
4903
5262
  # environment_name: "String", # required
4904
- # id: "Uuid", # required
5263
+ # next_token: "String",
4905
5264
  # }
4906
5265
  #
4907
5266
  # @!attribute [rw] app_id
4908
- # The unique ID of the Amplify app.
5267
+ # The unique ID of the Amplify app to export the themes to.
4909
5268
  # @return [String]
4910
5269
  #
4911
5270
  # @!attribute [rw] environment_name
4912
5271
  # The name of the backend environment that is part of the Amplify app.
4913
5272
  # @return [String]
4914
5273
  #
4915
- # @!attribute [rw] id
4916
- # The unique ID of the component.
5274
+ # @!attribute [rw] next_token
5275
+ # The token to request the next page of results.
4917
5276
  # @return [String]
4918
5277
  #
4919
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponentRequest AWS API Documentation
5278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemesRequest AWS API Documentation
4920
5279
  #
4921
- class GetComponentRequest < Struct.new(
5280
+ class ExportThemesRequest < Struct.new(
4922
5281
  :app_id,
4923
5282
  :environment_name,
4924
- :id)
5283
+ :next_token)
4925
5284
  SENSITIVE = []
4926
5285
  include Aws::Structure
4927
5286
  end
4928
5287
 
4929
- # @!attribute [rw] component
4930
- # Represents the configuration settings for the component.
4931
- # @return [Types::Component]
5288
+ # @!attribute [rw] entities
5289
+ # Represents the configuration of the exported themes.
5290
+ # @return [Array<Types::Theme>]
4932
5291
  #
4933
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponentResponse AWS API Documentation
5292
+ # @!attribute [rw] next_token
5293
+ # The pagination token that's included if more results are available.
5294
+ # @return [String]
4934
5295
  #
4935
- class GetComponentResponse < Struct.new(
4936
- :component)
5296
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExportThemesResponse AWS API Documentation
5297
+ #
5298
+ class ExportThemesResponse < Struct.new(
5299
+ :entities,
5300
+ :next_token)
4937
5301
  SENSITIVE = []
4938
5302
  include Aws::Structure
4939
5303
  end
4940
5304
 
4941
- # @note When making an API call, you may pass GetThemeRequest
5305
+ # Describes the configuration information for a field in a table.
5306
+ #
5307
+ # @note When making an API call, you may pass FieldConfig
4942
5308
  # data as a hash:
4943
5309
  #
4944
5310
  # {
4945
- # app_id: "String", # required
4946
- # environment_name: "String", # required
4947
- # id: "Uuid", # required
4948
- # }
4949
- #
4950
- # @!attribute [rw] app_id
4951
- # The unique ID of the Amplify app.
5311
+ # excluded: false,
5312
+ # input_type: {
5313
+ # default_checked: false,
5314
+ # default_country_code: "String",
5315
+ # default_value: "String",
5316
+ # descriptive_text: "String",
5317
+ # is_array: false,
5318
+ # max_value: 1.0,
5319
+ # min_value: 1.0,
5320
+ # name: "String",
5321
+ # placeholder: "String",
5322
+ # read_only: false,
5323
+ # required: false,
5324
+ # step: 1.0,
5325
+ # type: "String", # required
5326
+ # value: "String",
5327
+ # value_mappings: {
5328
+ # values: [ # required
5329
+ # {
5330
+ # display_value: {
5331
+ # value: "String",
5332
+ # },
5333
+ # value: { # required
5334
+ # value: "String",
5335
+ # },
5336
+ # },
5337
+ # ],
5338
+ # },
5339
+ # },
5340
+ # label: "String",
5341
+ # position: {
5342
+ # below: "String",
5343
+ # fixed: "first", # accepts first
5344
+ # right_of: "String",
5345
+ # },
5346
+ # validations: [
5347
+ # {
5348
+ # num_values: [1],
5349
+ # str_values: ["String"],
5350
+ # type: "String", # required
5351
+ # validation_message: "String",
5352
+ # },
5353
+ # ],
5354
+ # }
5355
+ #
5356
+ # @!attribute [rw] excluded
5357
+ # Specifies whether to hide a field.
5358
+ # @return [Boolean]
5359
+ #
5360
+ # @!attribute [rw] input_type
5361
+ # Describes the configuration for the default input value to display
5362
+ # for a field.
5363
+ # @return [Types::FieldInputConfig]
5364
+ #
5365
+ # @!attribute [rw] label
5366
+ # The label for the field.
5367
+ # @return [String]
5368
+ #
5369
+ # @!attribute [rw] position
5370
+ # Specifies the field position.
5371
+ # @return [Types::FieldPosition]
5372
+ #
5373
+ # @!attribute [rw] validations
5374
+ # The validations to perform on the value in the field.
5375
+ # @return [Array<Types::FieldValidationConfiguration>]
5376
+ #
5377
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldConfig AWS API Documentation
5378
+ #
5379
+ class FieldConfig < Struct.new(
5380
+ :excluded,
5381
+ :input_type,
5382
+ :label,
5383
+ :position,
5384
+ :validations)
5385
+ SENSITIVE = []
5386
+ include Aws::Structure
5387
+ end
5388
+
5389
+ # Describes the configuration for the default input values to display
5390
+ # for a field.
5391
+ #
5392
+ # @note When making an API call, you may pass FieldInputConfig
5393
+ # data as a hash:
5394
+ #
5395
+ # {
5396
+ # default_checked: false,
5397
+ # default_country_code: "String",
5398
+ # default_value: "String",
5399
+ # descriptive_text: "String",
5400
+ # is_array: false,
5401
+ # max_value: 1.0,
5402
+ # min_value: 1.0,
5403
+ # name: "String",
5404
+ # placeholder: "String",
5405
+ # read_only: false,
5406
+ # required: false,
5407
+ # step: 1.0,
5408
+ # type: "String", # required
5409
+ # value: "String",
5410
+ # value_mappings: {
5411
+ # values: [ # required
5412
+ # {
5413
+ # display_value: {
5414
+ # value: "String",
5415
+ # },
5416
+ # value: { # required
5417
+ # value: "String",
5418
+ # },
5419
+ # },
5420
+ # ],
5421
+ # },
5422
+ # }
5423
+ #
5424
+ # @!attribute [rw] default_checked
5425
+ # Specifies whether a field has a default value.
5426
+ # @return [Boolean]
5427
+ #
5428
+ # @!attribute [rw] default_country_code
5429
+ # The default country code for a phone number.
5430
+ # @return [String]
5431
+ #
5432
+ # @!attribute [rw] default_value
5433
+ # The default value for the field.
5434
+ # @return [String]
5435
+ #
5436
+ # @!attribute [rw] descriptive_text
5437
+ # The text to display to describe the field.
5438
+ # @return [String]
5439
+ #
5440
+ # @!attribute [rw] is_array
5441
+ # Specifies whether to render the field as an array. This property is
5442
+ # ignored if the `dataSourceType` for the form is a Data Store.
5443
+ # @return [Boolean]
5444
+ #
5445
+ # @!attribute [rw] max_value
5446
+ # The maximum value to display for the field.
5447
+ # @return [Float]
5448
+ #
5449
+ # @!attribute [rw] min_value
5450
+ # The minimum value to display for the field.
5451
+ # @return [Float]
5452
+ #
5453
+ # @!attribute [rw] name
5454
+ # The name of the field.
5455
+ # @return [String]
5456
+ #
5457
+ # @!attribute [rw] placeholder
5458
+ # The text to display as a placeholder for the field.
5459
+ # @return [String]
5460
+ #
5461
+ # @!attribute [rw] read_only
5462
+ # Specifies a read only field.
5463
+ # @return [Boolean]
5464
+ #
5465
+ # @!attribute [rw] required
5466
+ # Specifies a field that requires input.
5467
+ # @return [Boolean]
5468
+ #
5469
+ # @!attribute [rw] step
5470
+ # The stepping increment for a numeric value in a field.
5471
+ # @return [Float]
5472
+ #
5473
+ # @!attribute [rw] type
5474
+ # The input type for the field.
5475
+ # @return [String]
5476
+ #
5477
+ # @!attribute [rw] value
5478
+ # The value for the field.
5479
+ # @return [String]
5480
+ #
5481
+ # @!attribute [rw] value_mappings
5482
+ # The information to use to customize the input fields with data at
5483
+ # runtime.
5484
+ # @return [Types::ValueMappings]
5485
+ #
5486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldInputConfig AWS API Documentation
5487
+ #
5488
+ class FieldInputConfig < Struct.new(
5489
+ :default_checked,
5490
+ :default_country_code,
5491
+ :default_value,
5492
+ :descriptive_text,
5493
+ :is_array,
5494
+ :max_value,
5495
+ :min_value,
5496
+ :name,
5497
+ :placeholder,
5498
+ :read_only,
5499
+ :required,
5500
+ :step,
5501
+ :type,
5502
+ :value,
5503
+ :value_mappings)
5504
+ SENSITIVE = []
5505
+ include Aws::Structure
5506
+ end
5507
+
5508
+ # Describes the field position.
5509
+ #
5510
+ # @note FieldPosition is a union - when making an API calls you must set exactly one of the members.
5511
+ #
5512
+ # @note FieldPosition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FieldPosition corresponding to the set member.
5513
+ #
5514
+ # @!attribute [rw] below
5515
+ # The field position is below the field specified by the string.
5516
+ # @return [String]
5517
+ #
5518
+ # @!attribute [rw] fixed
5519
+ # The field position is fixed and doesn't change in relation to other
5520
+ # fields.
5521
+ # @return [String]
5522
+ #
5523
+ # @!attribute [rw] right_of
5524
+ # The field position is to the right of the field specified by the
5525
+ # string.
5526
+ # @return [String]
5527
+ #
5528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldPosition AWS API Documentation
5529
+ #
5530
+ class FieldPosition < Struct.new(
5531
+ :below,
5532
+ :fixed,
5533
+ :right_of,
5534
+ :unknown)
5535
+ SENSITIVE = []
5536
+ include Aws::Structure
5537
+ include Aws::Structure::Union
5538
+
5539
+ class Below < FieldPosition; end
5540
+ class Fixed < FieldPosition; end
5541
+ class RightOf < FieldPosition; end
5542
+ class Unknown < FieldPosition; end
5543
+ end
5544
+
5545
+ # Describes the validation configuration for a field.
5546
+ #
5547
+ # @note When making an API call, you may pass FieldValidationConfiguration
5548
+ # data as a hash:
5549
+ #
5550
+ # {
5551
+ # num_values: [1],
5552
+ # str_values: ["String"],
5553
+ # type: "String", # required
5554
+ # validation_message: "String",
5555
+ # }
5556
+ #
5557
+ # @!attribute [rw] num_values
5558
+ # The validation to perform on a number value.
5559
+ # @return [Array<Integer>]
5560
+ #
5561
+ # @!attribute [rw] str_values
5562
+ # The validation to perform on a string value.
5563
+ # @return [Array<String>]
5564
+ #
5565
+ # @!attribute [rw] type
5566
+ # The validation to perform on an object type.``
5567
+ # @return [String]
5568
+ #
5569
+ # @!attribute [rw] validation_message
5570
+ # The validation message to display.
5571
+ # @return [String]
5572
+ #
5573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldValidationConfiguration AWS API Documentation
5574
+ #
5575
+ class FieldValidationConfiguration < Struct.new(
5576
+ :num_values,
5577
+ :str_values,
5578
+ :type,
5579
+ :validation_message)
5580
+ SENSITIVE = []
5581
+ include Aws::Structure
5582
+ end
5583
+
5584
+ # Contains the configuration settings for a `Form` user interface (UI)
5585
+ # element for an Amplify app. A form is a component you can add to your
5586
+ # project by specifying a data source as the default configuration for
5587
+ # the form.
5588
+ #
5589
+ # @!attribute [rw] app_id
5590
+ # The unique ID of the Amplify app associated with the form.
5591
+ # @return [String]
5592
+ #
5593
+ # @!attribute [rw] cta
5594
+ # Stores the call to action configuration for the form.
5595
+ # @return [Types::FormCTA]
5596
+ #
5597
+ # @!attribute [rw] data_type
5598
+ # The type of data source to use to create the form.
5599
+ # @return [Types::FormDataTypeConfig]
5600
+ #
5601
+ # @!attribute [rw] environment_name
5602
+ # The name of the backend environment that is a part of the Amplify
5603
+ # app.
5604
+ # @return [String]
5605
+ #
5606
+ # @!attribute [rw] fields
5607
+ # Stores the information about the form's fields.
5608
+ # @return [Hash<String,Types::FieldConfig>]
5609
+ #
5610
+ # @!attribute [rw] form_action_type
5611
+ # The operation to perform on the specified form.
5612
+ # @return [String]
5613
+ #
5614
+ # @!attribute [rw] id
5615
+ # The unique ID of the form.
5616
+ # @return [String]
5617
+ #
5618
+ # @!attribute [rw] name
5619
+ # The name of the form.
5620
+ # @return [String]
5621
+ #
5622
+ # @!attribute [rw] schema_version
5623
+ # The schema version of the form when it was imported.
5624
+ # @return [String]
5625
+ #
5626
+ # @!attribute [rw] sectional_elements
5627
+ # Stores the visual helper elements for the form that are not
5628
+ # associated with any data.
5629
+ # @return [Hash<String,Types::SectionalElement>]
5630
+ #
5631
+ # @!attribute [rw] style
5632
+ # Stores the configuration for the form's style.
5633
+ # @return [Types::FormStyle]
5634
+ #
5635
+ # @!attribute [rw] tags
5636
+ # One or more key-value pairs to use when tagging the form.
5637
+ # @return [Hash<String,String>]
5638
+ #
5639
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Form AWS API Documentation
5640
+ #
5641
+ class Form < Struct.new(
5642
+ :app_id,
5643
+ :cta,
5644
+ :data_type,
5645
+ :environment_name,
5646
+ :fields,
5647
+ :form_action_type,
5648
+ :id,
5649
+ :name,
5650
+ :schema_version,
5651
+ :sectional_elements,
5652
+ :style,
5653
+ :tags)
5654
+ SENSITIVE = []
5655
+ include Aws::Structure
5656
+ end
5657
+
5658
+ # Describes how to bind a component property to form data.
5659
+ #
5660
+ # @note When making an API call, you may pass FormBindingElement
5661
+ # data as a hash:
5662
+ #
5663
+ # {
5664
+ # element: "String", # required
5665
+ # property: "String", # required
5666
+ # }
5667
+ #
5668
+ # @!attribute [rw] element
5669
+ # The name of the component to retrieve a value from.
5670
+ # @return [String]
5671
+ #
5672
+ # @!attribute [rw] property
5673
+ # The property to retrieve a value from.
5674
+ # @return [String]
5675
+ #
5676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormBindingElement AWS API Documentation
5677
+ #
5678
+ class FormBindingElement < Struct.new(
5679
+ :element,
5680
+ :property)
5681
+ SENSITIVE = []
5682
+ include Aws::Structure
5683
+ end
5684
+
5685
+ # Describes the configuration for a button UI element that is a part of
5686
+ # a form.
5687
+ #
5688
+ # @note When making an API call, you may pass FormButton
5689
+ # data as a hash:
5690
+ #
5691
+ # {
5692
+ # children: "String",
5693
+ # excluded: false,
5694
+ # position: {
5695
+ # below: "String",
5696
+ # fixed: "first", # accepts first
5697
+ # right_of: "String",
5698
+ # },
5699
+ # }
5700
+ #
5701
+ # @!attribute [rw] children
5702
+ # Describes the button's properties.
5703
+ # @return [String]
5704
+ #
5705
+ # @!attribute [rw] excluded
5706
+ # Specifies whether the button is visible on the form.
5707
+ # @return [Boolean]
5708
+ #
5709
+ # @!attribute [rw] position
5710
+ # The position of the button.
5711
+ # @return [Types::FieldPosition]
5712
+ #
5713
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormButton AWS API Documentation
5714
+ #
5715
+ class FormButton < Struct.new(
5716
+ :children,
5717
+ :excluded,
5718
+ :position)
5719
+ SENSITIVE = []
5720
+ include Aws::Structure
5721
+ end
5722
+
5723
+ # Describes the call to action button configuration for the form.
5724
+ #
5725
+ # @note When making an API call, you may pass FormCTA
5726
+ # data as a hash:
5727
+ #
5728
+ # {
5729
+ # cancel: {
5730
+ # children: "String",
5731
+ # excluded: false,
5732
+ # position: {
5733
+ # below: "String",
5734
+ # fixed: "first", # accepts first
5735
+ # right_of: "String",
5736
+ # },
5737
+ # },
5738
+ # clear: {
5739
+ # children: "String",
5740
+ # excluded: false,
5741
+ # position: {
5742
+ # below: "String",
5743
+ # fixed: "first", # accepts first
5744
+ # right_of: "String",
5745
+ # },
5746
+ # },
5747
+ # position: "top", # accepts top, bottom, top_and_bottom
5748
+ # submit: {
5749
+ # children: "String",
5750
+ # excluded: false,
5751
+ # position: {
5752
+ # below: "String",
5753
+ # fixed: "first", # accepts first
5754
+ # right_of: "String",
5755
+ # },
5756
+ # },
5757
+ # }
5758
+ #
5759
+ # @!attribute [rw] cancel
5760
+ # Displays a cancel button.
5761
+ # @return [Types::FormButton]
5762
+ #
5763
+ # @!attribute [rw] clear
5764
+ # Displays a clear button.
5765
+ # @return [Types::FormButton]
5766
+ #
5767
+ # @!attribute [rw] position
5768
+ # The position of the button.
5769
+ # @return [String]
5770
+ #
5771
+ # @!attribute [rw] submit
5772
+ # Displays a submit button.
5773
+ # @return [Types::FormButton]
5774
+ #
5775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormCTA AWS API Documentation
5776
+ #
5777
+ class FormCTA < Struct.new(
5778
+ :cancel,
5779
+ :clear,
5780
+ :position,
5781
+ :submit)
5782
+ SENSITIVE = []
5783
+ include Aws::Structure
5784
+ end
5785
+
5786
+ # Describes the data type configuration for the data source associated
5787
+ # with a form.
5788
+ #
5789
+ # @note When making an API call, you may pass FormDataTypeConfig
5790
+ # data as a hash:
5791
+ #
5792
+ # {
5793
+ # data_source_type: "DataStore", # required, accepts DataStore, Custom
5794
+ # data_type_name: "String", # required
5795
+ # }
5796
+ #
5797
+ # @!attribute [rw] data_source_type
5798
+ # The data source type, either an Amplify DataStore model or a custom
5799
+ # data type.
5800
+ # @return [String]
5801
+ #
5802
+ # @!attribute [rw] data_type_name
5803
+ # The unique name of the data type you are using as the data source
5804
+ # for the form.
5805
+ # @return [String]
5806
+ #
5807
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormDataTypeConfig AWS API Documentation
5808
+ #
5809
+ class FormDataTypeConfig < Struct.new(
5810
+ :data_source_type,
5811
+ :data_type_name)
5812
+ SENSITIVE = []
5813
+ include Aws::Structure
5814
+ end
5815
+
5816
+ # Describes the configuration for an input field on a form. Use
5817
+ # `FormInputValueProperty` to specify the values to render or bind by
5818
+ # default.
5819
+ #
5820
+ # @note When making an API call, you may pass FormInputValueProperty
5821
+ # data as a hash:
5822
+ #
5823
+ # {
5824
+ # value: "String",
5825
+ # }
5826
+ #
5827
+ # @!attribute [rw] value
5828
+ # The value to assign to the input field.
5829
+ # @return [String]
5830
+ #
5831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormInputValueProperty AWS API Documentation
5832
+ #
5833
+ class FormInputValueProperty < Struct.new(
5834
+ :value)
5835
+ SENSITIVE = []
5836
+ include Aws::Structure
5837
+ end
5838
+
5839
+ # Describes the configuration for the form's style.
5840
+ #
5841
+ # @note When making an API call, you may pass FormStyle
5842
+ # data as a hash:
5843
+ #
5844
+ # {
5845
+ # horizontal_gap: {
5846
+ # token_reference: "String",
5847
+ # value: "String",
5848
+ # },
5849
+ # outer_padding: {
5850
+ # token_reference: "String",
5851
+ # value: "String",
5852
+ # },
5853
+ # vertical_gap: {
5854
+ # token_reference: "String",
5855
+ # value: "String",
5856
+ # },
5857
+ # }
5858
+ #
5859
+ # @!attribute [rw] horizontal_gap
5860
+ # The spacing for the horizontal gap.
5861
+ # @return [Types::FormStyleConfig]
5862
+ #
5863
+ # @!attribute [rw] outer_padding
5864
+ # The size of the outer padding for the form.
5865
+ # @return [Types::FormStyleConfig]
5866
+ #
5867
+ # @!attribute [rw] vertical_gap
5868
+ # The spacing for the vertical gap.
5869
+ # @return [Types::FormStyleConfig]
5870
+ #
5871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormStyle AWS API Documentation
5872
+ #
5873
+ class FormStyle < Struct.new(
5874
+ :horizontal_gap,
5875
+ :outer_padding,
5876
+ :vertical_gap)
5877
+ SENSITIVE = []
5878
+ include Aws::Structure
5879
+ end
5880
+
5881
+ # Describes the configuration settings for the form's style properties.
5882
+ #
5883
+ # @note FormStyleConfig is a union - when making an API calls you must set exactly one of the members.
5884
+ #
5885
+ # @note FormStyleConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FormStyleConfig corresponding to the set member.
5886
+ #
5887
+ # @!attribute [rw] token_reference
5888
+ # A reference to a design token to use to bind the form's style
5889
+ # properties to an existing theme.
5890
+ # @return [String]
5891
+ #
5892
+ # @!attribute [rw] value
5893
+ # The value of the style setting.
5894
+ # @return [String]
5895
+ #
5896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormStyleConfig AWS API Documentation
5897
+ #
5898
+ class FormStyleConfig < Struct.new(
5899
+ :token_reference,
5900
+ :value,
5901
+ :unknown)
5902
+ SENSITIVE = []
5903
+ include Aws::Structure
5904
+ include Aws::Structure::Union
5905
+
5906
+ class TokenReference < FormStyleConfig; end
5907
+ class Value < FormStyleConfig; end
5908
+ class Unknown < FormStyleConfig; end
5909
+ end
5910
+
5911
+ # Describes the basic information about a form.
5912
+ #
5913
+ # @!attribute [rw] app_id
5914
+ # The unique ID for the app associated with the form summary.
5915
+ # @return [String]
5916
+ #
5917
+ # @!attribute [rw] data_type
5918
+ # The form's data source type.
5919
+ # @return [Types::FormDataTypeConfig]
5920
+ #
5921
+ # @!attribute [rw] environment_name
5922
+ # The name of the backend environment that is part of the Amplify app.
5923
+ # @return [String]
5924
+ #
5925
+ # @!attribute [rw] form_action_type
5926
+ # The type of operation to perform on the form.
5927
+ # @return [String]
5928
+ #
5929
+ # @!attribute [rw] id
5930
+ # The ID of the form.
5931
+ # @return [String]
5932
+ #
5933
+ # @!attribute [rw] name
5934
+ # The name of the form.
5935
+ # @return [String]
5936
+ #
5937
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormSummary AWS API Documentation
5938
+ #
5939
+ class FormSummary < Struct.new(
5940
+ :app_id,
5941
+ :data_type,
5942
+ :environment_name,
5943
+ :form_action_type,
5944
+ :id,
5945
+ :name)
5946
+ SENSITIVE = []
5947
+ include Aws::Structure
5948
+ end
5949
+
5950
+ # @note When making an API call, you may pass GetComponentRequest
5951
+ # data as a hash:
5952
+ #
5953
+ # {
5954
+ # app_id: "String", # required
5955
+ # environment_name: "String", # required
5956
+ # id: "Uuid", # required
5957
+ # }
5958
+ #
5959
+ # @!attribute [rw] app_id
5960
+ # The unique ID of the Amplify app.
5961
+ # @return [String]
5962
+ #
5963
+ # @!attribute [rw] environment_name
5964
+ # The name of the backend environment that is part of the Amplify app.
5965
+ # @return [String]
5966
+ #
5967
+ # @!attribute [rw] id
5968
+ # The unique ID of the component.
5969
+ # @return [String]
5970
+ #
5971
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponentRequest AWS API Documentation
5972
+ #
5973
+ class GetComponentRequest < Struct.new(
5974
+ :app_id,
5975
+ :environment_name,
5976
+ :id)
5977
+ SENSITIVE = []
5978
+ include Aws::Structure
5979
+ end
5980
+
5981
+ # @!attribute [rw] component
5982
+ # Represents the configuration settings for the component.
5983
+ # @return [Types::Component]
5984
+ #
5985
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetComponentResponse AWS API Documentation
5986
+ #
5987
+ class GetComponentResponse < Struct.new(
5988
+ :component)
5989
+ SENSITIVE = []
5990
+ include Aws::Structure
5991
+ end
5992
+
5993
+ # @note When making an API call, you may pass GetFormRequest
5994
+ # data as a hash:
5995
+ #
5996
+ # {
5997
+ # app_id: "String", # required
5998
+ # environment_name: "String", # required
5999
+ # id: "Uuid", # required
6000
+ # }
6001
+ #
6002
+ # @!attribute [rw] app_id
6003
+ # The unique ID of the Amplify app.
6004
+ # @return [String]
6005
+ #
6006
+ # @!attribute [rw] environment_name
6007
+ # The name of the backend environment that is part of the Amplify app.
6008
+ # @return [String]
6009
+ #
6010
+ # @!attribute [rw] id
6011
+ # The unique ID of the form.
6012
+ # @return [String]
6013
+ #
6014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetFormRequest AWS API Documentation
6015
+ #
6016
+ class GetFormRequest < Struct.new(
6017
+ :app_id,
6018
+ :environment_name,
6019
+ :id)
6020
+ SENSITIVE = []
6021
+ include Aws::Structure
6022
+ end
6023
+
6024
+ # @!attribute [rw] form
6025
+ # Represents the configuration settings for the form.
6026
+ # @return [Types::Form]
6027
+ #
6028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetFormResponse AWS API Documentation
6029
+ #
6030
+ class GetFormResponse < Struct.new(
6031
+ :form)
6032
+ SENSITIVE = []
6033
+ include Aws::Structure
6034
+ end
6035
+
6036
+ # @note When making an API call, you may pass GetMetadataRequest
6037
+ # data as a hash:
6038
+ #
6039
+ # {
6040
+ # app_id: "String", # required
6041
+ # environment_name: "String", # required
6042
+ # }
6043
+ #
6044
+ # @!attribute [rw] app_id
6045
+ # The unique ID of the Amplify app.
6046
+ # @return [String]
6047
+ #
6048
+ # @!attribute [rw] environment_name
6049
+ # The name of the backend environment that is part of the Amplify app.
6050
+ # @return [String]
6051
+ #
6052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetMetadataRequest AWS API Documentation
6053
+ #
6054
+ class GetMetadataRequest < Struct.new(
6055
+ :app_id,
6056
+ :environment_name)
6057
+ SENSITIVE = []
6058
+ include Aws::Structure
6059
+ end
6060
+
6061
+ # @!attribute [rw] features
6062
+ # Represents the configuration settings for the features metadata.
6063
+ # @return [Hash<String,String>]
6064
+ #
6065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetMetadataResponse AWS API Documentation
6066
+ #
6067
+ class GetMetadataResponse < Struct.new(
6068
+ :features)
6069
+ SENSITIVE = []
6070
+ include Aws::Structure
6071
+ end
6072
+
6073
+ # @note When making an API call, you may pass GetThemeRequest
6074
+ # data as a hash:
6075
+ #
6076
+ # {
6077
+ # app_id: "String", # required
6078
+ # environment_name: "String", # required
6079
+ # id: "Uuid", # required
6080
+ # }
6081
+ #
6082
+ # @!attribute [rw] app_id
6083
+ # The unique ID of the Amplify app.
4952
6084
  # @return [String]
4953
6085
  #
4954
6086
  # @!attribute [rw] environment_name
@@ -5062,6 +6194,61 @@ module Aws::AmplifyUIBuilder
5062
6194
  include Aws::Structure
5063
6195
  end
5064
6196
 
6197
+ # @note When making an API call, you may pass ListFormsRequest
6198
+ # data as a hash:
6199
+ #
6200
+ # {
6201
+ # app_id: "String", # required
6202
+ # environment_name: "String", # required
6203
+ # max_results: 1,
6204
+ # next_token: "String",
6205
+ # }
6206
+ #
6207
+ # @!attribute [rw] app_id
6208
+ # The unique ID for the Amplify app.
6209
+ # @return [String]
6210
+ #
6211
+ # @!attribute [rw] environment_name
6212
+ # The name of the backend environment that is a part of the Amplify
6213
+ # app.
6214
+ # @return [String]
6215
+ #
6216
+ # @!attribute [rw] max_results
6217
+ # The maximum number of forms to retrieve.
6218
+ # @return [Integer]
6219
+ #
6220
+ # @!attribute [rw] next_token
6221
+ # The token to request the next page of results.
6222
+ # @return [String]
6223
+ #
6224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListFormsRequest AWS API Documentation
6225
+ #
6226
+ class ListFormsRequest < Struct.new(
6227
+ :app_id,
6228
+ :environment_name,
6229
+ :max_results,
6230
+ :next_token)
6231
+ SENSITIVE = []
6232
+ include Aws::Structure
6233
+ end
6234
+
6235
+ # @!attribute [rw] entities
6236
+ # The list of forms for the Amplify app.
6237
+ # @return [Array<Types::FormSummary>]
6238
+ #
6239
+ # @!attribute [rw] next_token
6240
+ # The pagination token that's included if more results are available.
6241
+ # @return [String]
6242
+ #
6243
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListFormsResponse AWS API Documentation
6244
+ #
6245
+ class ListFormsResponse < Struct.new(
6246
+ :entities,
6247
+ :next_token)
6248
+ SENSITIVE = []
6249
+ include Aws::Structure
6250
+ end
6251
+
5065
6252
  # @note When making an API call, you may pass ListThemesRequest
5066
6253
  # data as a hash:
5067
6254
  #
@@ -5233,34 +6420,94 @@ module Aws::AmplifyUIBuilder
5233
6420
  # ],
5234
6421
  # }
5235
6422
  #
5236
- # @!attribute [rw] and
5237
- # A list of predicates to combine logically.
5238
- # @return [Array<Types::Predicate>]
6423
+ # @!attribute [rw] and
6424
+ # A list of predicates to combine logically.
6425
+ # @return [Array<Types::Predicate>]
6426
+ #
6427
+ # @!attribute [rw] field
6428
+ # The field to query.
6429
+ # @return [String]
6430
+ #
6431
+ # @!attribute [rw] operand
6432
+ # The value to use when performing the evaluation.
6433
+ # @return [String]
6434
+ #
6435
+ # @!attribute [rw] operator
6436
+ # The operator to use to perform the evaluation.
6437
+ # @return [String]
6438
+ #
6439
+ # @!attribute [rw] or
6440
+ # A list of predicates to combine logically.
6441
+ # @return [Array<Types::Predicate>]
6442
+ #
6443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Predicate AWS API Documentation
6444
+ #
6445
+ class Predicate < Struct.new(
6446
+ :and,
6447
+ :field,
6448
+ :operand,
6449
+ :operator,
6450
+ :or)
6451
+ SENSITIVE = []
6452
+ include Aws::Structure
6453
+ end
6454
+
6455
+ # Stores the metadata information about a feature on a form or view.
6456
+ #
6457
+ # @note When making an API call, you may pass PutMetadataFlagBody
6458
+ # data as a hash:
6459
+ #
6460
+ # {
6461
+ # new_value: "String", # required
6462
+ # }
6463
+ #
6464
+ # @!attribute [rw] new_value
6465
+ # The new information to store.
6466
+ # @return [String]
6467
+ #
6468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/PutMetadataFlagBody AWS API Documentation
6469
+ #
6470
+ class PutMetadataFlagBody < Struct.new(
6471
+ :new_value)
6472
+ SENSITIVE = []
6473
+ include Aws::Structure
6474
+ end
6475
+
6476
+ # @note When making an API call, you may pass PutMetadataFlagRequest
6477
+ # data as a hash:
6478
+ #
6479
+ # {
6480
+ # app_id: "String", # required
6481
+ # body: { # required
6482
+ # new_value: "String", # required
6483
+ # },
6484
+ # environment_name: "String", # required
6485
+ # feature_name: "String", # required
6486
+ # }
5239
6487
  #
5240
- # @!attribute [rw] field
5241
- # The field to query.
6488
+ # @!attribute [rw] app_id
6489
+ # The unique ID for the Amplify app.
5242
6490
  # @return [String]
5243
6491
  #
5244
- # @!attribute [rw] operand
5245
- # The value to use when performing the evaluation.
5246
- # @return [String]
6492
+ # @!attribute [rw] body
6493
+ # The metadata information to store.
6494
+ # @return [Types::PutMetadataFlagBody]
5247
6495
  #
5248
- # @!attribute [rw] operator
5249
- # The operator to use to perform the evaluation.
6496
+ # @!attribute [rw] environment_name
6497
+ # The name of the backend environment that is part of the Amplify app.
5250
6498
  # @return [String]
5251
6499
  #
5252
- # @!attribute [rw] or
5253
- # A list of predicates to combine logically.
5254
- # @return [Array<Types::Predicate>]
6500
+ # @!attribute [rw] feature_name
6501
+ # The name of the feature associated with the metadata.
6502
+ # @return [String]
5255
6503
  #
5256
- # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Predicate AWS API Documentation
6504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/PutMetadataFlagRequest AWS API Documentation
5257
6505
  #
5258
- class Predicate < Struct.new(
5259
- :and,
5260
- :field,
5261
- :operand,
5262
- :operator,
5263
- :or)
6506
+ class PutMetadataFlagRequest < Struct.new(
6507
+ :app_id,
6508
+ :body,
6509
+ :environment_name,
6510
+ :feature_name)
5264
6511
  SENSITIVE = []
5265
6512
  include Aws::Structure
5266
6513
  end
@@ -5359,6 +6606,61 @@ module Aws::AmplifyUIBuilder
5359
6606
  include Aws::Structure
5360
6607
  end
5361
6608
 
6609
+ # Stores the configuration information for a visual helper element for a
6610
+ # form. A sectional element can be a header, a text block, or a divider.
6611
+ # These elements are static and not associated with any data.
6612
+ #
6613
+ # @note When making an API call, you may pass SectionalElement
6614
+ # data as a hash:
6615
+ #
6616
+ # {
6617
+ # level: 1,
6618
+ # orientation: "String",
6619
+ # position: {
6620
+ # below: "String",
6621
+ # fixed: "first", # accepts first
6622
+ # right_of: "String",
6623
+ # },
6624
+ # text: "String",
6625
+ # type: "String", # required
6626
+ # }
6627
+ #
6628
+ # @!attribute [rw] level
6629
+ # Specifies the size of the font for a `Heading` sectional element.
6630
+ # Valid values are `1 | 2 | 3 | 4 | 5 | 6`.
6631
+ # @return [Integer]
6632
+ #
6633
+ # @!attribute [rw] orientation
6634
+ # Specifies the orientation for a `Divider` sectional element. Valid
6635
+ # values are `horizontal` or `vertical`.
6636
+ # @return [String]
6637
+ #
6638
+ # @!attribute [rw] position
6639
+ # Specifies the position of the text in a field for a `Text` sectional
6640
+ # element.
6641
+ # @return [Types::FieldPosition]
6642
+ #
6643
+ # @!attribute [rw] text
6644
+ # The text for a `Text` sectional element.
6645
+ # @return [String]
6646
+ #
6647
+ # @!attribute [rw] type
6648
+ # The type of sectional element. Valid values are `Heading`, `Text`,
6649
+ # and `Divider`.
6650
+ # @return [String]
6651
+ #
6652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/SectionalElement AWS API Documentation
6653
+ #
6654
+ class SectionalElement < Struct.new(
6655
+ :level,
6656
+ :orientation,
6657
+ :position,
6658
+ :text,
6659
+ :type)
6660
+ SENSITIVE = []
6661
+ include Aws::Structure
6662
+ end
6663
+
5362
6664
  # You exceeded your service quota. Service quotas, also referred to as
5363
6665
  # limits, are the maximum number of service resources or operations for
5364
6666
  # your Amazon Web Services account.
@@ -5560,6 +6862,19 @@ module Aws::AmplifyUIBuilder
5560
6862
  include Aws::Structure
5561
6863
  end
5562
6864
 
6865
+ # You don't have permission to perform this operation.
6866
+ #
6867
+ # @!attribute [rw] message
6868
+ # @return [String]
6869
+ #
6870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UnauthorizedException AWS API Documentation
6871
+ #
6872
+ class UnauthorizedException < Struct.new(
6873
+ :message)
6874
+ SENSITIVE = []
6875
+ include Aws::Structure
6876
+ end
6877
+
5563
6878
  # Updates and saves all of the information about a component, based on
5564
6879
  # component ID.
5565
6880
  #
@@ -5588,6 +6903,7 @@ module Aws::AmplifyUIBuilder
5588
6903
  # },
5589
6904
  # },
5590
6905
  # ],
6906
+ # slot_name: "String",
5591
6907
  # user_attribute: "String",
5592
6908
  # },
5593
6909
  # default_value: "String",
@@ -6584,6 +7900,7 @@ module Aws::AmplifyUIBuilder
6584
7900
  # },
6585
7901
  # },
6586
7902
  # ],
7903
+ # slot_name: "String",
6587
7904
  # user_attribute: "String",
6588
7905
  # },
6589
7906
  # default_value: "String",
@@ -7525,6 +8842,345 @@ module Aws::AmplifyUIBuilder
7525
8842
  include Aws::Structure
7526
8843
  end
7527
8844
 
8845
+ # Updates and saves all of the information about a form, based on form
8846
+ # ID.
8847
+ #
8848
+ # @note When making an API call, you may pass UpdateFormData
8849
+ # data as a hash:
8850
+ #
8851
+ # {
8852
+ # cta: {
8853
+ # cancel: {
8854
+ # children: "String",
8855
+ # excluded: false,
8856
+ # position: {
8857
+ # below: "String",
8858
+ # fixed: "first", # accepts first
8859
+ # right_of: "String",
8860
+ # },
8861
+ # },
8862
+ # clear: {
8863
+ # children: "String",
8864
+ # excluded: false,
8865
+ # position: {
8866
+ # below: "String",
8867
+ # fixed: "first", # accepts first
8868
+ # right_of: "String",
8869
+ # },
8870
+ # },
8871
+ # position: "top", # accepts top, bottom, top_and_bottom
8872
+ # submit: {
8873
+ # children: "String",
8874
+ # excluded: false,
8875
+ # position: {
8876
+ # below: "String",
8877
+ # fixed: "first", # accepts first
8878
+ # right_of: "String",
8879
+ # },
8880
+ # },
8881
+ # },
8882
+ # data_type: {
8883
+ # data_source_type: "DataStore", # required, accepts DataStore, Custom
8884
+ # data_type_name: "String", # required
8885
+ # },
8886
+ # fields: {
8887
+ # "String" => {
8888
+ # excluded: false,
8889
+ # input_type: {
8890
+ # default_checked: false,
8891
+ # default_country_code: "String",
8892
+ # default_value: "String",
8893
+ # descriptive_text: "String",
8894
+ # is_array: false,
8895
+ # max_value: 1.0,
8896
+ # min_value: 1.0,
8897
+ # name: "String",
8898
+ # placeholder: "String",
8899
+ # read_only: false,
8900
+ # required: false,
8901
+ # step: 1.0,
8902
+ # type: "String", # required
8903
+ # value: "String",
8904
+ # value_mappings: {
8905
+ # values: [ # required
8906
+ # {
8907
+ # display_value: {
8908
+ # value: "String",
8909
+ # },
8910
+ # value: { # required
8911
+ # value: "String",
8912
+ # },
8913
+ # },
8914
+ # ],
8915
+ # },
8916
+ # },
8917
+ # label: "String",
8918
+ # position: {
8919
+ # below: "String",
8920
+ # fixed: "first", # accepts first
8921
+ # right_of: "String",
8922
+ # },
8923
+ # validations: [
8924
+ # {
8925
+ # num_values: [1],
8926
+ # str_values: ["String"],
8927
+ # type: "String", # required
8928
+ # validation_message: "String",
8929
+ # },
8930
+ # ],
8931
+ # },
8932
+ # },
8933
+ # form_action_type: "create", # accepts create, update
8934
+ # name: "FormName",
8935
+ # schema_version: "String",
8936
+ # sectional_elements: {
8937
+ # "String" => {
8938
+ # level: 1,
8939
+ # orientation: "String",
8940
+ # position: {
8941
+ # below: "String",
8942
+ # fixed: "first", # accepts first
8943
+ # right_of: "String",
8944
+ # },
8945
+ # text: "String",
8946
+ # type: "String", # required
8947
+ # },
8948
+ # },
8949
+ # style: {
8950
+ # horizontal_gap: {
8951
+ # token_reference: "String",
8952
+ # value: "String",
8953
+ # },
8954
+ # outer_padding: {
8955
+ # token_reference: "String",
8956
+ # value: "String",
8957
+ # },
8958
+ # vertical_gap: {
8959
+ # token_reference: "String",
8960
+ # value: "String",
8961
+ # },
8962
+ # },
8963
+ # }
8964
+ #
8965
+ # @!attribute [rw] cta
8966
+ # The `FormCTA` object that stores the call to action configuration
8967
+ # for the form.
8968
+ # @return [Types::FormCTA]
8969
+ #
8970
+ # @!attribute [rw] data_type
8971
+ # The type of data source to use to create the form.
8972
+ # @return [Types::FormDataTypeConfig]
8973
+ #
8974
+ # @!attribute [rw] fields
8975
+ # The configuration information for the form's fields.
8976
+ # @return [Hash<String,Types::FieldConfig>]
8977
+ #
8978
+ # @!attribute [rw] form_action_type
8979
+ # Specifies whether to perform a create or update action on the form.
8980
+ # @return [String]
8981
+ #
8982
+ # @!attribute [rw] name
8983
+ # The name of the form.
8984
+ # @return [String]
8985
+ #
8986
+ # @!attribute [rw] schema_version
8987
+ # The schema version of the form.
8988
+ # @return [String]
8989
+ #
8990
+ # @!attribute [rw] sectional_elements
8991
+ # The configuration information for the visual helper elements for the
8992
+ # form. These elements are not associated with any data.
8993
+ # @return [Hash<String,Types::SectionalElement>]
8994
+ #
8995
+ # @!attribute [rw] style
8996
+ # The configuration for the form's style.
8997
+ # @return [Types::FormStyle]
8998
+ #
8999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateFormData AWS API Documentation
9000
+ #
9001
+ class UpdateFormData < Struct.new(
9002
+ :cta,
9003
+ :data_type,
9004
+ :fields,
9005
+ :form_action_type,
9006
+ :name,
9007
+ :schema_version,
9008
+ :sectional_elements,
9009
+ :style)
9010
+ SENSITIVE = []
9011
+ include Aws::Structure
9012
+ end
9013
+
9014
+ # @note When making an API call, you may pass UpdateFormRequest
9015
+ # data as a hash:
9016
+ #
9017
+ # {
9018
+ # app_id: "String", # required
9019
+ # client_token: "String",
9020
+ # environment_name: "String", # required
9021
+ # id: "Uuid", # required
9022
+ # updated_form: { # required
9023
+ # cta: {
9024
+ # cancel: {
9025
+ # children: "String",
9026
+ # excluded: false,
9027
+ # position: {
9028
+ # below: "String",
9029
+ # fixed: "first", # accepts first
9030
+ # right_of: "String",
9031
+ # },
9032
+ # },
9033
+ # clear: {
9034
+ # children: "String",
9035
+ # excluded: false,
9036
+ # position: {
9037
+ # below: "String",
9038
+ # fixed: "first", # accepts first
9039
+ # right_of: "String",
9040
+ # },
9041
+ # },
9042
+ # position: "top", # accepts top, bottom, top_and_bottom
9043
+ # submit: {
9044
+ # children: "String",
9045
+ # excluded: false,
9046
+ # position: {
9047
+ # below: "String",
9048
+ # fixed: "first", # accepts first
9049
+ # right_of: "String",
9050
+ # },
9051
+ # },
9052
+ # },
9053
+ # data_type: {
9054
+ # data_source_type: "DataStore", # required, accepts DataStore, Custom
9055
+ # data_type_name: "String", # required
9056
+ # },
9057
+ # fields: {
9058
+ # "String" => {
9059
+ # excluded: false,
9060
+ # input_type: {
9061
+ # default_checked: false,
9062
+ # default_country_code: "String",
9063
+ # default_value: "String",
9064
+ # descriptive_text: "String",
9065
+ # is_array: false,
9066
+ # max_value: 1.0,
9067
+ # min_value: 1.0,
9068
+ # name: "String",
9069
+ # placeholder: "String",
9070
+ # read_only: false,
9071
+ # required: false,
9072
+ # step: 1.0,
9073
+ # type: "String", # required
9074
+ # value: "String",
9075
+ # value_mappings: {
9076
+ # values: [ # required
9077
+ # {
9078
+ # display_value: {
9079
+ # value: "String",
9080
+ # },
9081
+ # value: { # required
9082
+ # value: "String",
9083
+ # },
9084
+ # },
9085
+ # ],
9086
+ # },
9087
+ # },
9088
+ # label: "String",
9089
+ # position: {
9090
+ # below: "String",
9091
+ # fixed: "first", # accepts first
9092
+ # right_of: "String",
9093
+ # },
9094
+ # validations: [
9095
+ # {
9096
+ # num_values: [1],
9097
+ # str_values: ["String"],
9098
+ # type: "String", # required
9099
+ # validation_message: "String",
9100
+ # },
9101
+ # ],
9102
+ # },
9103
+ # },
9104
+ # form_action_type: "create", # accepts create, update
9105
+ # name: "FormName",
9106
+ # schema_version: "String",
9107
+ # sectional_elements: {
9108
+ # "String" => {
9109
+ # level: 1,
9110
+ # orientation: "String",
9111
+ # position: {
9112
+ # below: "String",
9113
+ # fixed: "first", # accepts first
9114
+ # right_of: "String",
9115
+ # },
9116
+ # text: "String",
9117
+ # type: "String", # required
9118
+ # },
9119
+ # },
9120
+ # style: {
9121
+ # horizontal_gap: {
9122
+ # token_reference: "String",
9123
+ # value: "String",
9124
+ # },
9125
+ # outer_padding: {
9126
+ # token_reference: "String",
9127
+ # value: "String",
9128
+ # },
9129
+ # vertical_gap: {
9130
+ # token_reference: "String",
9131
+ # value: "String",
9132
+ # },
9133
+ # },
9134
+ # },
9135
+ # }
9136
+ #
9137
+ # @!attribute [rw] app_id
9138
+ # The unique ID for the Amplify app.
9139
+ # @return [String]
9140
+ #
9141
+ # @!attribute [rw] client_token
9142
+ # The unique client token.
9143
+ #
9144
+ # **A suitable default value is auto-generated.** You should normally
9145
+ # not need to pass this option.
9146
+ # @return [String]
9147
+ #
9148
+ # @!attribute [rw] environment_name
9149
+ # The name of the backend environment that is part of the Amplify app.
9150
+ # @return [String]
9151
+ #
9152
+ # @!attribute [rw] id
9153
+ # The unique ID for the form.
9154
+ # @return [String]
9155
+ #
9156
+ # @!attribute [rw] updated_form
9157
+ # The request accepts the following data in JSON format.
9158
+ # @return [Types::UpdateFormData]
9159
+ #
9160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateFormRequest AWS API Documentation
9161
+ #
9162
+ class UpdateFormRequest < Struct.new(
9163
+ :app_id,
9164
+ :client_token,
9165
+ :environment_name,
9166
+ :id,
9167
+ :updated_form)
9168
+ SENSITIVE = []
9169
+ include Aws::Structure
9170
+ end
9171
+
9172
+ # @!attribute [rw] entity
9173
+ # Describes the configuration of the updated form.
9174
+ # @return [Types::Form]
9175
+ #
9176
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateFormResponse AWS API Documentation
9177
+ #
9178
+ class UpdateFormResponse < Struct.new(
9179
+ :entity)
9180
+ SENSITIVE = []
9181
+ include Aws::Structure
9182
+ end
9183
+
7528
9184
  # Saves the data binding information for a theme.
7529
9185
  #
7530
9186
  # @note When making an API call, you may pass UpdateThemeData
@@ -7668,5 +9324,67 @@ module Aws::AmplifyUIBuilder
7668
9324
  include Aws::Structure
7669
9325
  end
7670
9326
 
9327
+ # Associates a complex object with a display value. Use `ValueMapping`
9328
+ # to store how to represent complex objects when they are displayed.
9329
+ #
9330
+ # @note When making an API call, you may pass ValueMapping
9331
+ # data as a hash:
9332
+ #
9333
+ # {
9334
+ # display_value: {
9335
+ # value: "String",
9336
+ # },
9337
+ # value: { # required
9338
+ # value: "String",
9339
+ # },
9340
+ # }
9341
+ #
9342
+ # @!attribute [rw] display_value
9343
+ # The value to display for the complex object.
9344
+ # @return [Types::FormInputValueProperty]
9345
+ #
9346
+ # @!attribute [rw] value
9347
+ # The complex object.
9348
+ # @return [Types::FormInputValueProperty]
9349
+ #
9350
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ValueMapping AWS API Documentation
9351
+ #
9352
+ class ValueMapping < Struct.new(
9353
+ :display_value,
9354
+ :value)
9355
+ SENSITIVE = []
9356
+ include Aws::Structure
9357
+ end
9358
+
9359
+ # Represents the data binding configuration for a value map.
9360
+ #
9361
+ # @note When making an API call, you may pass ValueMappings
9362
+ # data as a hash:
9363
+ #
9364
+ # {
9365
+ # values: [ # required
9366
+ # {
9367
+ # display_value: {
9368
+ # value: "String",
9369
+ # },
9370
+ # value: { # required
9371
+ # value: "String",
9372
+ # },
9373
+ # },
9374
+ # ],
9375
+ # }
9376
+ #
9377
+ # @!attribute [rw] values
9378
+ # The value and display value pairs.
9379
+ # @return [Array<Types::ValueMapping>]
9380
+ #
9381
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ValueMappings AWS API Documentation
9382
+ #
9383
+ class ValueMappings < Struct.new(
9384
+ :values)
9385
+ SENSITIVE = []
9386
+ include Aws::Structure
9387
+ end
9388
+
7671
9389
  end
7672
9390
  end