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