aws-sdk-amplifyuibuilder 1.9.0 → 1.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-amplifyuibuilder/client.rb +3460 -3294
- data/lib/aws-sdk-amplifyuibuilder/client_api.rb +160 -116
- data/lib/aws-sdk-amplifyuibuilder/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-amplifyuibuilder/types.rb +773 -597
- data/lib/aws-sdk-amplifyuibuilder/waiters.rb +15 -0
- data/lib/aws-sdk-amplifyuibuilder.rb +2 -1
- metadata +3 -2
@@ -16,63 +16,63 @@ module Aws::AmplifyUIBuilder
|
|
16
16
|
# components. `ActionParameters` defines the action that is performed
|
17
17
|
# when an event occurs on the component.
|
18
18
|
#
|
19
|
+
# @!attribute [rw] type
|
20
|
+
# The type of navigation action. Valid values are `url` and `anchor`.
|
21
|
+
# This value is required for a navigation action.
|
22
|
+
# @return [Types::ComponentProperty]
|
23
|
+
#
|
24
|
+
# @!attribute [rw] url
|
25
|
+
# The URL to the location to open. Specify this value for a navigation
|
26
|
+
# action.
|
27
|
+
# @return [Types::ComponentProperty]
|
28
|
+
#
|
19
29
|
# @!attribute [rw] anchor
|
20
30
|
# The HTML anchor link to the location to open. Specify this value for
|
21
31
|
# a navigation action.
|
22
32
|
# @return [Types::ComponentProperty]
|
23
33
|
#
|
24
|
-
# @!attribute [rw]
|
25
|
-
#
|
26
|
-
#
|
27
|
-
#
|
28
|
-
# @return [Hash<String,Types::ComponentProperty>]
|
34
|
+
# @!attribute [rw] target
|
35
|
+
# The element within the same component to modify when the action
|
36
|
+
# occurs.
|
37
|
+
# @return [Types::ComponentProperty]
|
29
38
|
#
|
30
39
|
# @!attribute [rw] global
|
31
40
|
# Specifies whether the user should be signed out globally. Specify
|
32
41
|
# this value for an auth sign out action.
|
33
42
|
# @return [Types::ComponentProperty]
|
34
43
|
#
|
35
|
-
# @!attribute [rw] id
|
36
|
-
# The unique ID of the component that the `ActionParameters` apply to.
|
37
|
-
# @return [Types::ComponentProperty]
|
38
|
-
#
|
39
44
|
# @!attribute [rw] model
|
40
45
|
# The name of the data model. Use when the action performs an
|
41
46
|
# operation on an Amplify DataStore model.
|
42
47
|
# @return [String]
|
43
48
|
#
|
49
|
+
# @!attribute [rw] id
|
50
|
+
# The unique ID of the component that the `ActionParameters` apply to.
|
51
|
+
# @return [Types::ComponentProperty]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] fields
|
54
|
+
# A dictionary of key-value pairs mapping Amplify Studio properties to
|
55
|
+
# fields in a data model. Use when the action performs an operation on
|
56
|
+
# an Amplify DataStore model.
|
57
|
+
# @return [Hash<String,Types::ComponentProperty>]
|
58
|
+
#
|
44
59
|
# @!attribute [rw] state
|
45
60
|
# A key-value pair that specifies the state property name and its
|
46
61
|
# initial value.
|
47
62
|
# @return [Types::MutationActionSetStateParameter]
|
48
63
|
#
|
49
|
-
# @!attribute [rw] target
|
50
|
-
# The element within the same component to modify when the action
|
51
|
-
# occurs.
|
52
|
-
# @return [Types::ComponentProperty]
|
53
|
-
#
|
54
|
-
# @!attribute [rw] type
|
55
|
-
# The type of navigation action. Valid values are `url` and `anchor`.
|
56
|
-
# This value is required for a navigation action.
|
57
|
-
# @return [Types::ComponentProperty]
|
58
|
-
#
|
59
|
-
# @!attribute [rw] url
|
60
|
-
# The URL to the location to open. Specify this value for a navigation
|
61
|
-
# action.
|
62
|
-
# @return [Types::ComponentProperty]
|
63
|
-
#
|
64
64
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ActionParameters AWS API Documentation
|
65
65
|
#
|
66
66
|
class ActionParameters < Struct.new(
|
67
|
+
:type,
|
68
|
+
:url,
|
67
69
|
:anchor,
|
68
|
-
:
|
70
|
+
:target,
|
69
71
|
:global,
|
70
|
-
:id,
|
71
72
|
:model,
|
72
|
-
:
|
73
|
-
:
|
74
|
-
:
|
75
|
-
:url)
|
73
|
+
:id,
|
74
|
+
:fields,
|
75
|
+
:state)
|
76
76
|
SENSITIVE = []
|
77
77
|
include Aws::Structure
|
78
78
|
end
|
@@ -87,103 +87,103 @@ module Aws::AmplifyUIBuilder
|
|
87
87
|
# The unique ID of the Amplify app associated with the component.
|
88
88
|
# @return [String]
|
89
89
|
#
|
90
|
-
# @!attribute [rw] binding_properties
|
91
|
-
# The information to connect a component's properties to data at
|
92
|
-
# runtime. You can't specify `tags` as a valid property for
|
93
|
-
# `bindingProperties`.
|
94
|
-
# @return [Hash<String,Types::ComponentBindingPropertiesValue>]
|
95
|
-
#
|
96
|
-
# @!attribute [rw] children
|
97
|
-
# A list of the component's `ComponentChild` instances.
|
98
|
-
# @return [Array<Types::ComponentChild>]
|
99
|
-
#
|
100
|
-
# @!attribute [rw] collection_properties
|
101
|
-
# The data binding configuration for the component's properties. Use
|
102
|
-
# this for a collection component. You can't specify `tags` as a
|
103
|
-
# valid property for `collectionProperties`.
|
104
|
-
# @return [Hash<String,Types::ComponentDataConfiguration>]
|
105
|
-
#
|
106
|
-
# @!attribute [rw] component_type
|
107
|
-
# The type of the component. This can be an Amplify custom UI
|
108
|
-
# component or another custom component.
|
109
|
-
# @return [String]
|
110
|
-
#
|
111
|
-
# @!attribute [rw] created_at
|
112
|
-
# The time that the component was created.
|
113
|
-
# @return [Time]
|
114
|
-
#
|
115
90
|
# @!attribute [rw] environment_name
|
116
91
|
# The name of the backend environment that is a part of the Amplify
|
117
92
|
# app.
|
118
93
|
# @return [String]
|
119
94
|
#
|
120
|
-
# @!attribute [rw]
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
# @return [Hash<String,Types::ComponentEvent>]
|
95
|
+
# @!attribute [rw] source_id
|
96
|
+
# The unique ID of the component in its original source system, such
|
97
|
+
# as Figma.
|
98
|
+
# @return [String]
|
125
99
|
#
|
126
100
|
# @!attribute [rw] id
|
127
101
|
# The unique ID of the component.
|
128
102
|
# @return [String]
|
129
103
|
#
|
130
|
-
# @!attribute [rw] modified_at
|
131
|
-
# The time that the component was modified.
|
132
|
-
# @return [Time]
|
133
|
-
#
|
134
104
|
# @!attribute [rw] name
|
135
105
|
# The name of the component.
|
136
106
|
# @return [String]
|
137
107
|
#
|
108
|
+
# @!attribute [rw] component_type
|
109
|
+
# The type of the component. This can be an Amplify custom UI
|
110
|
+
# component or another custom component.
|
111
|
+
# @return [String]
|
112
|
+
#
|
113
|
+
# @!attribute [rw] properties
|
114
|
+
# Describes the component's properties. You can't specify `tags` as
|
115
|
+
# a valid property for `properties`.
|
116
|
+
# @return [Hash<String,Types::ComponentProperty>]
|
117
|
+
#
|
118
|
+
# @!attribute [rw] children
|
119
|
+
# A list of the component's `ComponentChild` instances.
|
120
|
+
# @return [Array<Types::ComponentChild>]
|
121
|
+
#
|
122
|
+
# @!attribute [rw] variants
|
123
|
+
# A list of the component's variants. A variant is a unique style
|
124
|
+
# configuration of a main component.
|
125
|
+
# @return [Array<Types::ComponentVariant>]
|
126
|
+
#
|
138
127
|
# @!attribute [rw] overrides
|
139
128
|
# Describes the component's properties that can be overriden in a
|
140
129
|
# customized instance of the component. You can't specify `tags` as a
|
141
130
|
# valid property for `overrides`.
|
142
131
|
# @return [Hash<String,Hash<String,String>>]
|
143
132
|
#
|
144
|
-
# @!attribute [rw]
|
145
|
-
#
|
146
|
-
# a valid property for
|
147
|
-
#
|
133
|
+
# @!attribute [rw] binding_properties
|
134
|
+
# The information to connect a component's properties to data at
|
135
|
+
# runtime. You can't specify `tags` as a valid property for
|
136
|
+
# `bindingProperties`.
|
137
|
+
# @return [Hash<String,Types::ComponentBindingPropertiesValue>]
|
148
138
|
#
|
149
|
-
# @!attribute [rw]
|
150
|
-
# The
|
151
|
-
#
|
139
|
+
# @!attribute [rw] collection_properties
|
140
|
+
# The data binding configuration for the component's properties. Use
|
141
|
+
# this for a collection component. You can't specify `tags` as a
|
142
|
+
# valid property for `collectionProperties`.
|
143
|
+
# @return [Hash<String,Types::ComponentDataConfiguration>]
|
152
144
|
#
|
153
|
-
# @!attribute [rw]
|
154
|
-
# The
|
155
|
-
#
|
156
|
-
#
|
145
|
+
# @!attribute [rw] created_at
|
146
|
+
# The time that the component was created.
|
147
|
+
# @return [Time]
|
148
|
+
#
|
149
|
+
# @!attribute [rw] modified_at
|
150
|
+
# The time that the component was modified.
|
151
|
+
# @return [Time]
|
157
152
|
#
|
158
153
|
# @!attribute [rw] tags
|
159
154
|
# One or more key-value pairs to use when tagging the component.
|
160
155
|
# @return [Hash<String,String>]
|
161
156
|
#
|
162
|
-
# @!attribute [rw]
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
157
|
+
# @!attribute [rw] events
|
158
|
+
# Describes the events that can be raised on the component. Use for
|
159
|
+
# the workflow feature in Amplify Studio that allows you to bind
|
160
|
+
# events and actions to components.
|
161
|
+
# @return [Hash<String,Types::ComponentEvent>]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] schema_version
|
164
|
+
# The schema version of the component when it was imported.
|
165
|
+
# @return [String]
|
166
166
|
#
|
167
167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Component AWS API Documentation
|
168
168
|
#
|
169
169
|
class Component < Struct.new(
|
170
170
|
:app_id,
|
171
|
-
:binding_properties,
|
172
|
-
:children,
|
173
|
-
:collection_properties,
|
174
|
-
:component_type,
|
175
|
-
:created_at,
|
176
171
|
:environment_name,
|
177
|
-
:
|
172
|
+
:source_id,
|
178
173
|
:id,
|
179
|
-
:modified_at,
|
180
174
|
:name,
|
181
|
-
:
|
175
|
+
:component_type,
|
182
176
|
:properties,
|
183
|
-
:
|
184
|
-
:
|
177
|
+
:children,
|
178
|
+
:variants,
|
179
|
+
:overrides,
|
180
|
+
:binding_properties,
|
181
|
+
:collection_properties,
|
182
|
+
:created_at,
|
183
|
+
:modified_at,
|
185
184
|
:tags,
|
186
|
-
:
|
185
|
+
:events,
|
186
|
+
:schema_version)
|
187
187
|
SENSITIVE = []
|
188
188
|
include Aws::Structure
|
189
189
|
end
|
@@ -193,6 +193,10 @@ module Aws::AmplifyUIBuilder
|
|
193
193
|
# properties to a component to allow different values to be entered when
|
194
194
|
# a component is reused in different places in an app.
|
195
195
|
#
|
196
|
+
# @!attribute [rw] type
|
197
|
+
# The property type.
|
198
|
+
# @return [String]
|
199
|
+
#
|
196
200
|
# @!attribute [rw] binding_properties
|
197
201
|
# Describes the properties to customize with data at runtime.
|
198
202
|
# @return [Types::ComponentBindingPropertiesValueProperties]
|
@@ -201,16 +205,12 @@ module Aws::AmplifyUIBuilder
|
|
201
205
|
# The default value of the property.
|
202
206
|
# @return [String]
|
203
207
|
#
|
204
|
-
# @!attribute [rw] type
|
205
|
-
# The property type.
|
206
|
-
# @return [String]
|
207
|
-
#
|
208
208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentBindingPropertiesValue AWS API Documentation
|
209
209
|
#
|
210
210
|
class ComponentBindingPropertiesValue < Struct.new(
|
211
|
+
:type,
|
211
212
|
:binding_properties,
|
212
|
-
:default_value
|
213
|
-
:type)
|
213
|
+
:default_value)
|
214
214
|
SENSITIVE = []
|
215
215
|
include Aws::Structure
|
216
216
|
end
|
@@ -221,69 +221,59 @@ module Aws::AmplifyUIBuilder
|
|
221
221
|
# Amazon S3 bucket, an Amplify DataStore model or an authenticated user
|
222
222
|
# attribute.
|
223
223
|
#
|
224
|
-
# @!attribute [rw]
|
225
|
-
# An
|
226
|
-
# @return [String]
|
227
|
-
#
|
228
|
-
# @!attribute [rw] default_value
|
229
|
-
# The default value to assign to the property.
|
224
|
+
# @!attribute [rw] model
|
225
|
+
# An Amplify DataStore model.
|
230
226
|
# @return [String]
|
231
227
|
#
|
232
228
|
# @!attribute [rw] field
|
233
229
|
# The field to bind the data to.
|
234
230
|
# @return [String]
|
235
231
|
#
|
232
|
+
# @!attribute [rw] predicates
|
233
|
+
# A list of predicates for binding a component's properties to data.
|
234
|
+
# @return [Array<Types::Predicate>]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] user_attribute
|
237
|
+
# An authenticated user attribute.
|
238
|
+
# @return [String]
|
239
|
+
#
|
240
|
+
# @!attribute [rw] bucket
|
241
|
+
# An Amazon S3 bucket.
|
242
|
+
# @return [String]
|
243
|
+
#
|
236
244
|
# @!attribute [rw] key
|
237
245
|
# The storage key for an Amazon S3 bucket.
|
238
246
|
# @return [String]
|
239
247
|
#
|
240
|
-
# @!attribute [rw]
|
241
|
-
#
|
248
|
+
# @!attribute [rw] default_value
|
249
|
+
# The default value to assign to the property.
|
242
250
|
# @return [String]
|
243
251
|
#
|
244
|
-
# @!attribute [rw] predicates
|
245
|
-
# A list of predicates for binding a component's properties to data.
|
246
|
-
# @return [Array<Types::Predicate>]
|
247
|
-
#
|
248
252
|
# @!attribute [rw] slot_name
|
249
253
|
# The name of a component slot.
|
250
254
|
# @return [String]
|
251
255
|
#
|
252
|
-
# @!attribute [rw] user_attribute
|
253
|
-
# An authenticated user attribute.
|
254
|
-
# @return [String]
|
255
|
-
#
|
256
256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentBindingPropertiesValueProperties AWS API Documentation
|
257
257
|
#
|
258
258
|
class ComponentBindingPropertiesValueProperties < Struct.new(
|
259
|
-
:bucket,
|
260
|
-
:default_value,
|
261
|
-
:field,
|
262
|
-
:key,
|
263
259
|
:model,
|
260
|
+
:field,
|
264
261
|
:predicates,
|
265
|
-
:
|
266
|
-
:
|
262
|
+
:user_attribute,
|
263
|
+
:bucket,
|
264
|
+
:key,
|
265
|
+
:default_value,
|
266
|
+
:slot_name)
|
267
267
|
SENSITIVE = []
|
268
268
|
include Aws::Structure
|
269
269
|
end
|
270
270
|
|
271
271
|
# A nested UI configuration within a parent `Component`.
|
272
272
|
#
|
273
|
-
# @!attribute [rw] children
|
274
|
-
# The list of `ComponentChild` instances for this component.
|
275
|
-
# @return [Array<Types::ComponentChild>]
|
276
|
-
#
|
277
273
|
# @!attribute [rw] component_type
|
278
274
|
# The type of the child component.
|
279
275
|
# @return [String]
|
280
276
|
#
|
281
|
-
# @!attribute [rw] events
|
282
|
-
# Describes the events that can be raised on the child component. Use
|
283
|
-
# for the workflow feature in Amplify Studio that allows you to bind
|
284
|
-
# events and actions to components.
|
285
|
-
# @return [Hash<String,Types::ComponentEvent>]
|
286
|
-
#
|
287
277
|
# @!attribute [rw] name
|
288
278
|
# The name of the child component.
|
289
279
|
# @return [String]
|
@@ -293,6 +283,16 @@ module Aws::AmplifyUIBuilder
|
|
293
283
|
# `tags` as a valid property for `properties`.
|
294
284
|
# @return [Hash<String,Types::ComponentProperty>]
|
295
285
|
#
|
286
|
+
# @!attribute [rw] children
|
287
|
+
# The list of `ComponentChild` instances for this component.
|
288
|
+
# @return [Array<Types::ComponentChild>]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] events
|
291
|
+
# Describes the events that can be raised on the child component. Use
|
292
|
+
# for the workflow feature in Amplify Studio that allows you to bind
|
293
|
+
# events and actions to components.
|
294
|
+
# @return [Hash<String,Types::ComponentEvent>]
|
295
|
+
#
|
296
296
|
# @!attribute [rw] source_id
|
297
297
|
# The unique ID of the child component in its original source system,
|
298
298
|
# such as Figma.
|
@@ -301,11 +301,11 @@ module Aws::AmplifyUIBuilder
|
|
301
301
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentChild AWS API Documentation
|
302
302
|
#
|
303
303
|
class ComponentChild < Struct.new(
|
304
|
-
:children,
|
305
304
|
:component_type,
|
306
|
-
:events,
|
307
305
|
:name,
|
308
306
|
:properties,
|
307
|
+
:children,
|
308
|
+
:events,
|
309
309
|
:source_id)
|
310
310
|
SENSITIVE = []
|
311
311
|
include Aws::Structure
|
@@ -315,45 +315,45 @@ module Aws::AmplifyUIBuilder
|
|
315
315
|
# `ComponentConditionProperty` to set a property to different values
|
316
316
|
# conditionally, based on the value of another property.
|
317
317
|
#
|
318
|
-
# @!attribute [rw]
|
319
|
-
# The
|
320
|
-
# @return [
|
318
|
+
# @!attribute [rw] property
|
319
|
+
# The name of the conditional property.
|
320
|
+
# @return [String]
|
321
321
|
#
|
322
322
|
# @!attribute [rw] field
|
323
323
|
# The name of a field. Specify this when the property is a data model.
|
324
324
|
# @return [String]
|
325
325
|
#
|
326
|
-
# @!attribute [rw] operand
|
327
|
-
# The value of the property to evaluate.
|
328
|
-
# @return [String]
|
329
|
-
#
|
330
|
-
# @!attribute [rw] operand_type
|
331
|
-
# The type of the property to evaluate.
|
332
|
-
# @return [String]
|
333
|
-
#
|
334
326
|
# @!attribute [rw] operator
|
335
327
|
# The operator to use to perform the evaluation, such as `eq` to
|
336
328
|
# represent equals.
|
337
329
|
# @return [String]
|
338
330
|
#
|
339
|
-
# @!attribute [rw]
|
340
|
-
# The
|
331
|
+
# @!attribute [rw] operand
|
332
|
+
# The value of the property to evaluate.
|
341
333
|
# @return [String]
|
342
334
|
#
|
343
335
|
# @!attribute [rw] then
|
344
336
|
# The value to assign to the property if the condition is met.
|
345
337
|
# @return [Types::ComponentProperty]
|
346
338
|
#
|
339
|
+
# @!attribute [rw] else
|
340
|
+
# The value to assign to the property if the condition is not met.
|
341
|
+
# @return [Types::ComponentProperty]
|
342
|
+
#
|
343
|
+
# @!attribute [rw] operand_type
|
344
|
+
# The type of the property to evaluate.
|
345
|
+
# @return [String]
|
346
|
+
#
|
347
347
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentConditionProperty AWS API Documentation
|
348
348
|
#
|
349
349
|
class ComponentConditionProperty < Struct.new(
|
350
|
-
:
|
350
|
+
:property,
|
351
351
|
:field,
|
352
|
-
:operand,
|
353
|
-
:operand_type,
|
354
352
|
:operator,
|
355
|
-
:
|
356
|
-
:then
|
353
|
+
:operand,
|
354
|
+
:then,
|
355
|
+
:else,
|
356
|
+
:operand_type)
|
357
357
|
SENSITIVE = []
|
358
358
|
include Aws::Structure
|
359
359
|
end
|
@@ -361,33 +361,33 @@ module Aws::AmplifyUIBuilder
|
|
361
361
|
# Describes the configuration for binding a component's properties to
|
362
362
|
# data.
|
363
363
|
#
|
364
|
-
# @!attribute [rw] identifiers
|
365
|
-
# A list of IDs to use to bind data to a component. Use this property
|
366
|
-
# to bind specifically chosen data, rather than data retrieved from a
|
367
|
-
# query.
|
368
|
-
# @return [Array<String>]
|
369
|
-
#
|
370
364
|
# @!attribute [rw] model
|
371
365
|
# The name of the data model to use to bind data to a component.
|
372
366
|
# @return [String]
|
373
367
|
#
|
368
|
+
# @!attribute [rw] sort
|
369
|
+
# Describes how to sort the component's properties.
|
370
|
+
# @return [Array<Types::SortProperty>]
|
371
|
+
#
|
374
372
|
# @!attribute [rw] predicate
|
375
373
|
# Represents the conditional logic to use when binding data to a
|
376
374
|
# component. Use this property to retrieve only a subset of the data
|
377
375
|
# in a collection.
|
378
376
|
# @return [Types::Predicate]
|
379
377
|
#
|
380
|
-
# @!attribute [rw]
|
381
|
-
#
|
382
|
-
#
|
378
|
+
# @!attribute [rw] identifiers
|
379
|
+
# A list of IDs to use to bind data to a component. Use this property
|
380
|
+
# to bind specifically chosen data, rather than data retrieved from a
|
381
|
+
# query.
|
382
|
+
# @return [Array<String>]
|
383
383
|
#
|
384
384
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentDataConfiguration AWS API Documentation
|
385
385
|
#
|
386
386
|
class ComponentDataConfiguration < Struct.new(
|
387
|
-
:identifiers,
|
388
387
|
:model,
|
388
|
+
:sort,
|
389
389
|
:predicate,
|
390
|
-
:
|
390
|
+
:identifiers)
|
391
391
|
SENSITIVE = []
|
392
392
|
include Aws::Structure
|
393
393
|
end
|
@@ -400,21 +400,21 @@ module Aws::AmplifyUIBuilder
|
|
400
400
|
# The action to perform when a specific event is raised.
|
401
401
|
# @return [String]
|
402
402
|
#
|
403
|
+
# @!attribute [rw] parameters
|
404
|
+
# Describes information about the action.
|
405
|
+
# @return [Types::ActionParameters]
|
406
|
+
#
|
403
407
|
# @!attribute [rw] binding_event
|
404
408
|
# Binds an event to an action on a component. When you specify a
|
405
409
|
# `bindingEvent`, the event is called when the action is performed.
|
406
410
|
# @return [String]
|
407
411
|
#
|
408
|
-
# @!attribute [rw] parameters
|
409
|
-
# Describes information about the action.
|
410
|
-
# @return [Types::ActionParameters]
|
411
|
-
#
|
412
412
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentEvent AWS API Documentation
|
413
413
|
#
|
414
414
|
class ComponentEvent < Struct.new(
|
415
415
|
:action,
|
416
|
-
:
|
417
|
-
:
|
416
|
+
:parameters,
|
417
|
+
:binding_event)
|
418
418
|
SENSITIVE = []
|
419
419
|
include Aws::Structure
|
420
420
|
end
|
@@ -423,21 +423,39 @@ module Aws::AmplifyUIBuilder
|
|
423
423
|
# `ComponentProperty` to specify the values to render or bind by
|
424
424
|
# default.
|
425
425
|
#
|
426
|
+
# @!attribute [rw] value
|
427
|
+
# The value to assign to the component property.
|
428
|
+
# @return [String]
|
429
|
+
#
|
426
430
|
# @!attribute [rw] binding_properties
|
427
431
|
# The information to bind the component property to data at runtime.
|
428
432
|
# @return [Types::ComponentPropertyBindingProperties]
|
429
433
|
#
|
430
|
-
# @!attribute [rw] bindings
|
431
|
-
# The information to bind the component property to form data.
|
432
|
-
# @return [Hash<String,Types::FormBindingElement>]
|
433
|
-
#
|
434
434
|
# @!attribute [rw] collection_binding_properties
|
435
435
|
# The information to bind the component property to data at runtime.
|
436
436
|
# Use this for collection components.
|
437
437
|
# @return [Types::ComponentPropertyBindingProperties]
|
438
438
|
#
|
439
|
-
# @!attribute [rw]
|
440
|
-
# The
|
439
|
+
# @!attribute [rw] default_value
|
440
|
+
# The default value to assign to the component property.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] model
|
444
|
+
# The data model to use to assign a value to the component property.
|
445
|
+
# @return [String]
|
446
|
+
#
|
447
|
+
# @!attribute [rw] bindings
|
448
|
+
# The information to bind the component property to form data.
|
449
|
+
# @return [Hash<String,Types::FormBindingElement>]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] event
|
452
|
+
# An event that occurs in your app. Use this for workflow data
|
453
|
+
# binding.
|
454
|
+
# @return [String]
|
455
|
+
#
|
456
|
+
# @!attribute [rw] user_attribute
|
457
|
+
# An authenticated user attribute to use to assign a value to the
|
458
|
+
# component property.
|
441
459
|
# @return [String]
|
442
460
|
#
|
443
461
|
# @!attribute [rw] concat
|
@@ -455,13 +473,8 @@ module Aws::AmplifyUIBuilder
|
|
455
473
|
# after importing it.
|
456
474
|
# @return [Boolean]
|
457
475
|
#
|
458
|
-
# @!attribute [rw]
|
459
|
-
# The
|
460
|
-
# @return [String]
|
461
|
-
#
|
462
|
-
# @!attribute [rw] event
|
463
|
-
# An event that occurs in your app. Use this for workflow data
|
464
|
-
# binding.
|
476
|
+
# @!attribute [rw] type
|
477
|
+
# The component type.
|
465
478
|
# @return [String]
|
466
479
|
#
|
467
480
|
# @!attribute [rw] imported_value
|
@@ -469,45 +482,32 @@ module Aws::AmplifyUIBuilder
|
|
469
482
|
# imported into an app.
|
470
483
|
# @return [String]
|
471
484
|
#
|
472
|
-
# @!attribute [rw]
|
473
|
-
# The
|
485
|
+
# @!attribute [rw] component_name
|
486
|
+
# The name of the component that is affected by an event.
|
474
487
|
# @return [String]
|
475
488
|
#
|
476
489
|
# @!attribute [rw] property
|
477
490
|
# The name of the component's property that is affected by an event.
|
478
491
|
# @return [String]
|
479
492
|
#
|
480
|
-
# @!attribute [rw] type
|
481
|
-
# The component type.
|
482
|
-
# @return [String]
|
483
|
-
#
|
484
|
-
# @!attribute [rw] user_attribute
|
485
|
-
# An authenticated user attribute to use to assign a value to the
|
486
|
-
# component property.
|
487
|
-
# @return [String]
|
488
|
-
#
|
489
|
-
# @!attribute [rw] value
|
490
|
-
# The value to assign to the component property.
|
491
|
-
# @return [String]
|
492
|
-
#
|
493
493
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentProperty AWS API Documentation
|
494
494
|
#
|
495
495
|
class ComponentProperty < Struct.new(
|
496
|
+
:value,
|
496
497
|
:binding_properties,
|
497
|
-
:bindings,
|
498
498
|
:collection_binding_properties,
|
499
|
-
:
|
499
|
+
:default_value,
|
500
|
+
:model,
|
501
|
+
:bindings,
|
502
|
+
:event,
|
503
|
+
:user_attribute,
|
500
504
|
:concat,
|
501
505
|
:condition,
|
502
506
|
:configured,
|
503
|
-
:default_value,
|
504
|
-
:event,
|
505
|
-
:imported_value,
|
506
|
-
:model,
|
507
|
-
:property,
|
508
507
|
:type,
|
509
|
-
:
|
510
|
-
:
|
508
|
+
:imported_value,
|
509
|
+
:component_name,
|
510
|
+
:property)
|
511
511
|
SENSITIVE = []
|
512
512
|
include Aws::Structure
|
513
513
|
end
|
@@ -516,19 +516,19 @@ module Aws::AmplifyUIBuilder
|
|
516
516
|
# exposed properties on the top level component to propagate data to the
|
517
517
|
# component's property values.
|
518
518
|
#
|
519
|
-
# @!attribute [rw] field
|
520
|
-
# The data field to bind the property to.
|
521
|
-
# @return [String]
|
522
|
-
#
|
523
519
|
# @!attribute [rw] property
|
524
520
|
# The component property to bind to the data field.
|
525
521
|
# @return [String]
|
526
522
|
#
|
523
|
+
# @!attribute [rw] field
|
524
|
+
# The data field to bind the property to.
|
525
|
+
# @return [String]
|
526
|
+
#
|
527
527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentPropertyBindingProperties AWS API Documentation
|
528
528
|
#
|
529
529
|
class ComponentPropertyBindingProperties < Struct.new(
|
530
|
-
:
|
531
|
-
:
|
530
|
+
:property,
|
531
|
+
:field)
|
532
532
|
SENSITIVE = []
|
533
533
|
include Aws::Structure
|
534
534
|
end
|
@@ -540,10 +540,6 @@ module Aws::AmplifyUIBuilder
|
|
540
540
|
# The unique ID of the Amplify app associated with the component.
|
541
541
|
# @return [String]
|
542
542
|
#
|
543
|
-
# @!attribute [rw] component_type
|
544
|
-
# The component type.
|
545
|
-
# @return [String]
|
546
|
-
#
|
547
543
|
# @!attribute [rw] environment_name
|
548
544
|
# The name of the backend environment that is a part of the Amplify
|
549
545
|
# app.
|
@@ -557,14 +553,18 @@ module Aws::AmplifyUIBuilder
|
|
557
553
|
# The name of the component.
|
558
554
|
# @return [String]
|
559
555
|
#
|
556
|
+
# @!attribute [rw] component_type
|
557
|
+
# The component type.
|
558
|
+
# @return [String]
|
559
|
+
#
|
560
560
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentSummary AWS API Documentation
|
561
561
|
#
|
562
562
|
class ComponentSummary < Struct.new(
|
563
563
|
:app_id,
|
564
|
-
:component_type,
|
565
564
|
:environment_name,
|
566
565
|
:id,
|
567
|
-
:name
|
566
|
+
:name,
|
567
|
+
:component_type)
|
568
568
|
SENSITIVE = []
|
569
569
|
include Aws::Structure
|
570
570
|
end
|
@@ -572,22 +572,22 @@ module Aws::AmplifyUIBuilder
|
|
572
572
|
# Describes the style configuration of a unique variation of a main
|
573
573
|
# component.
|
574
574
|
#
|
575
|
+
# @!attribute [rw] variant_values
|
576
|
+
# The combination of variants that comprise this variant. You can't
|
577
|
+
# specify `tags` as a valid property for `variantValues`.
|
578
|
+
# @return [Hash<String,String>]
|
579
|
+
#
|
575
580
|
# @!attribute [rw] overrides
|
576
581
|
# The properties of the component variant that can be overriden when
|
577
582
|
# customizing an instance of the component. You can't specify `tags`
|
578
583
|
# as a valid property for `overrides`.
|
579
584
|
# @return [Hash<String,Hash<String,String>>]
|
580
585
|
#
|
581
|
-
# @!attribute [rw] variant_values
|
582
|
-
# The combination of variants that comprise this variant. You can't
|
583
|
-
# specify `tags` as a valid property for `variantValues`.
|
584
|
-
# @return [Hash<String,String>]
|
585
|
-
#
|
586
586
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ComponentVariant AWS API Documentation
|
587
587
|
#
|
588
588
|
class ComponentVariant < Struct.new(
|
589
|
-
:
|
590
|
-
:
|
589
|
+
:variant_values,
|
590
|
+
:overrides)
|
591
591
|
SENSITIVE = []
|
592
592
|
include Aws::Structure
|
593
593
|
end
|
@@ -595,23 +595,49 @@ module Aws::AmplifyUIBuilder
|
|
595
595
|
# Represents all of the information that is required to create a
|
596
596
|
# component.
|
597
597
|
#
|
598
|
-
# @!attribute [rw]
|
599
|
-
# The
|
600
|
-
# @return [
|
598
|
+
# @!attribute [rw] name
|
599
|
+
# The name of the component
|
600
|
+
# @return [String]
|
601
|
+
#
|
602
|
+
# @!attribute [rw] source_id
|
603
|
+
# The unique ID of the component in its original source system, such
|
604
|
+
# as Figma.
|
605
|
+
# @return [String]
|
606
|
+
#
|
607
|
+
# @!attribute [rw] component_type
|
608
|
+
# The component type. This can be an Amplify custom UI component or
|
609
|
+
# another custom component.
|
610
|
+
# @return [String]
|
611
|
+
#
|
612
|
+
# @!attribute [rw] properties
|
613
|
+
# Describes the component's properties.
|
614
|
+
# @return [Hash<String,Types::ComponentProperty>]
|
601
615
|
#
|
602
616
|
# @!attribute [rw] children
|
603
617
|
# A list of child components that are instances of the main component.
|
604
618
|
# @return [Array<Types::ComponentChild>]
|
605
619
|
#
|
620
|
+
# @!attribute [rw] variants
|
621
|
+
# A list of the unique variants of this component.
|
622
|
+
# @return [Array<Types::ComponentVariant>]
|
623
|
+
#
|
624
|
+
# @!attribute [rw] overrides
|
625
|
+
# Describes the component properties that can be overriden to
|
626
|
+
# customize an instance of the component.
|
627
|
+
# @return [Hash<String,Hash<String,String>>]
|
628
|
+
#
|
629
|
+
# @!attribute [rw] binding_properties
|
630
|
+
# The data binding information for the component's properties.
|
631
|
+
# @return [Hash<String,Types::ComponentBindingPropertiesValue>]
|
632
|
+
#
|
606
633
|
# @!attribute [rw] collection_properties
|
607
634
|
# The data binding configuration for customizing a component's
|
608
635
|
# properties. Use this for a collection component.
|
609
636
|
# @return [Hash<String,Types::ComponentDataConfiguration>]
|
610
637
|
#
|
611
|
-
# @!attribute [rw]
|
612
|
-
#
|
613
|
-
#
|
614
|
-
# @return [String]
|
638
|
+
# @!attribute [rw] tags
|
639
|
+
# One or more key-value pairs to use when tagging the component data.
|
640
|
+
# @return [Hash<String,String>]
|
615
641
|
#
|
616
642
|
# @!attribute [rw] events
|
617
643
|
# The event configuration for the component. Use for the workflow
|
@@ -619,51 +645,25 @@ module Aws::AmplifyUIBuilder
|
|
619
645
|
# to components.
|
620
646
|
# @return [Hash<String,Types::ComponentEvent>]
|
621
647
|
#
|
622
|
-
# @!attribute [rw] name
|
623
|
-
# The name of the component
|
624
|
-
# @return [String]
|
625
|
-
#
|
626
|
-
# @!attribute [rw] overrides
|
627
|
-
# Describes the component properties that can be overriden to
|
628
|
-
# customize an instance of the component.
|
629
|
-
# @return [Hash<String,Hash<String,String>>]
|
630
|
-
#
|
631
|
-
# @!attribute [rw] properties
|
632
|
-
# Describes the component's properties.
|
633
|
-
# @return [Hash<String,Types::ComponentProperty>]
|
634
|
-
#
|
635
648
|
# @!attribute [rw] schema_version
|
636
649
|
# The schema version of the component when it was imported.
|
637
650
|
# @return [String]
|
638
651
|
#
|
639
|
-
# @!attribute [rw] source_id
|
640
|
-
# The unique ID of the component in its original source system, such
|
641
|
-
# as Figma.
|
642
|
-
# @return [String]
|
643
|
-
#
|
644
|
-
# @!attribute [rw] tags
|
645
|
-
# One or more key-value pairs to use when tagging the component data.
|
646
|
-
# @return [Hash<String,String>]
|
647
|
-
#
|
648
|
-
# @!attribute [rw] variants
|
649
|
-
# A list of the unique variants of this component.
|
650
|
-
# @return [Array<Types::ComponentVariant>]
|
651
|
-
#
|
652
652
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateComponentData AWS API Documentation
|
653
653
|
#
|
654
654
|
class CreateComponentData < Struct.new(
|
655
|
-
:binding_properties,
|
656
|
-
:children,
|
657
|
-
:collection_properties,
|
658
|
-
:component_type,
|
659
|
-
:events,
|
660
655
|
:name,
|
661
|
-
:overrides,
|
662
|
-
:properties,
|
663
|
-
:schema_version,
|
664
656
|
:source_id,
|
657
|
+
:component_type,
|
658
|
+
:properties,
|
659
|
+
:children,
|
660
|
+
:variants,
|
661
|
+
:overrides,
|
662
|
+
:binding_properties,
|
663
|
+
:collection_properties,
|
665
664
|
:tags,
|
666
|
-
:
|
665
|
+
:events,
|
666
|
+
:schema_version)
|
667
667
|
SENSITIVE = []
|
668
668
|
include Aws::Structure
|
669
669
|
end
|
@@ -672,6 +672,11 @@ module Aws::AmplifyUIBuilder
|
|
672
672
|
# The unique ID of the Amplify app to associate with the component.
|
673
673
|
# @return [String]
|
674
674
|
#
|
675
|
+
# @!attribute [rw] environment_name
|
676
|
+
# The name of the backend environment that is a part of the Amplify
|
677
|
+
# app.
|
678
|
+
# @return [String]
|
679
|
+
#
|
675
680
|
# @!attribute [rw] client_token
|
676
681
|
# The unique client token.
|
677
682
|
#
|
@@ -683,18 +688,13 @@ module Aws::AmplifyUIBuilder
|
|
683
688
|
# Represents the configuration of the component to create.
|
684
689
|
# @return [Types::CreateComponentData]
|
685
690
|
#
|
686
|
-
# @!attribute [rw] environment_name
|
687
|
-
# The name of the backend environment that is a part of the Amplify
|
688
|
-
# app.
|
689
|
-
# @return [String]
|
690
|
-
#
|
691
691
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateComponentRequest AWS API Documentation
|
692
692
|
#
|
693
693
|
class CreateComponentRequest < Struct.new(
|
694
694
|
:app_id,
|
695
|
+
:environment_name,
|
695
696
|
:client_token,
|
696
|
-
:component_to_create
|
697
|
-
:environment_name)
|
697
|
+
:component_to_create)
|
698
698
|
SENSITIVE = []
|
699
699
|
include Aws::Structure
|
700
700
|
end
|
@@ -713,56 +713,61 @@ module Aws::AmplifyUIBuilder
|
|
713
713
|
|
714
714
|
# Represents all of the information that is required to create a form.
|
715
715
|
#
|
716
|
-
# @!attribute [rw]
|
717
|
-
# The
|
718
|
-
#
|
719
|
-
# @return [Types::FormCTA]
|
716
|
+
# @!attribute [rw] name
|
717
|
+
# The name of the form.
|
718
|
+
# @return [String]
|
720
719
|
#
|
721
720
|
# @!attribute [rw] data_type
|
722
721
|
# The type of data source to use to create the form.
|
723
722
|
# @return [Types::FormDataTypeConfig]
|
724
723
|
#
|
725
|
-
# @!attribute [rw] fields
|
726
|
-
# The configuration information for the form's fields.
|
727
|
-
# @return [Hash<String,Types::FieldConfig>]
|
728
|
-
#
|
729
724
|
# @!attribute [rw] form_action_type
|
730
725
|
# Specifies whether to perform a create or update action on the form.
|
731
726
|
# @return [String]
|
732
727
|
#
|
733
|
-
# @!attribute [rw]
|
734
|
-
# The
|
735
|
-
# @return [String]
|
728
|
+
# @!attribute [rw] fields
|
729
|
+
# The configuration information for the form's fields.
|
730
|
+
# @return [Hash<String,Types::FieldConfig>]
|
736
731
|
#
|
737
|
-
# @!attribute [rw]
|
738
|
-
# The
|
739
|
-
# @return [
|
732
|
+
# @!attribute [rw] style
|
733
|
+
# The configuration for the form's style.
|
734
|
+
# @return [Types::FormStyle]
|
740
735
|
#
|
741
736
|
# @!attribute [rw] sectional_elements
|
742
737
|
# The configuration information for the visual helper elements for the
|
743
738
|
# form. These elements are not associated with any data.
|
744
739
|
# @return [Hash<String,Types::SectionalElement>]
|
745
740
|
#
|
746
|
-
# @!attribute [rw]
|
747
|
-
# The
|
748
|
-
# @return [
|
741
|
+
# @!attribute [rw] schema_version
|
742
|
+
# The schema version of the form.
|
743
|
+
# @return [String]
|
744
|
+
#
|
745
|
+
# @!attribute [rw] cta
|
746
|
+
# The `FormCTA` object that stores the call to action configuration
|
747
|
+
# for the form.
|
748
|
+
# @return [Types::FormCTA]
|
749
749
|
#
|
750
750
|
# @!attribute [rw] tags
|
751
751
|
# One or more key-value pairs to use when tagging the form data.
|
752
752
|
# @return [Hash<String,String>]
|
753
753
|
#
|
754
|
+
# @!attribute [rw] label_decorator
|
755
|
+
# Specifies an icon or decoration to display on the form.
|
756
|
+
# @return [String]
|
757
|
+
#
|
754
758
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateFormData AWS API Documentation
|
755
759
|
#
|
756
760
|
class CreateFormData < Struct.new(
|
757
|
-
:
|
761
|
+
:name,
|
758
762
|
:data_type,
|
759
|
-
:fields,
|
760
763
|
:form_action_type,
|
761
|
-
:
|
762
|
-
:schema_version,
|
763
|
-
:sectional_elements,
|
764
|
+
:fields,
|
764
765
|
:style,
|
765
|
-
:
|
766
|
+
:sectional_elements,
|
767
|
+
:schema_version,
|
768
|
+
:cta,
|
769
|
+
:tags,
|
770
|
+
:label_decorator)
|
766
771
|
SENSITIVE = []
|
767
772
|
include Aws::Structure
|
768
773
|
end
|
@@ -771,6 +776,11 @@ module Aws::AmplifyUIBuilder
|
|
771
776
|
# The unique ID of the Amplify app to associate with the form.
|
772
777
|
# @return [String]
|
773
778
|
#
|
779
|
+
# @!attribute [rw] environment_name
|
780
|
+
# The name of the backend environment that is a part of the Amplify
|
781
|
+
# app.
|
782
|
+
# @return [String]
|
783
|
+
#
|
774
784
|
# @!attribute [rw] client_token
|
775
785
|
# The unique client token.
|
776
786
|
#
|
@@ -778,11 +788,6 @@ module Aws::AmplifyUIBuilder
|
|
778
788
|
# not need to pass this option.
|
779
789
|
# @return [String]
|
780
790
|
#
|
781
|
-
# @!attribute [rw] environment_name
|
782
|
-
# The name of the backend environment that is a part of the Amplify
|
783
|
-
# app.
|
784
|
-
# @return [String]
|
785
|
-
#
|
786
791
|
# @!attribute [rw] form_to_create
|
787
792
|
# Represents the configuration of the form to create.
|
788
793
|
# @return [Types::CreateFormData]
|
@@ -791,8 +796,8 @@ module Aws::AmplifyUIBuilder
|
|
791
796
|
#
|
792
797
|
class CreateFormRequest < Struct.new(
|
793
798
|
:app_id,
|
794
|
-
:client_token,
|
795
799
|
:environment_name,
|
800
|
+
:client_token,
|
796
801
|
:form_to_create)
|
797
802
|
SENSITIVE = []
|
798
803
|
include Aws::Structure
|
@@ -816,6 +821,10 @@ module Aws::AmplifyUIBuilder
|
|
816
821
|
# The name of the theme.
|
817
822
|
# @return [String]
|
818
823
|
#
|
824
|
+
# @!attribute [rw] values
|
825
|
+
# A list of key-value pairs that defines the properties of the theme.
|
826
|
+
# @return [Array<Types::ThemeValues>]
|
827
|
+
#
|
819
828
|
# @!attribute [rw] overrides
|
820
829
|
# Describes the properties that can be overriden to customize an
|
821
830
|
# instance of the theme.
|
@@ -825,17 +834,13 @@ module Aws::AmplifyUIBuilder
|
|
825
834
|
# One or more key-value pairs to use when tagging the theme data.
|
826
835
|
# @return [Hash<String,String>]
|
827
836
|
#
|
828
|
-
# @!attribute [rw] values
|
829
|
-
# A list of key-value pairs that defines the properties of the theme.
|
830
|
-
# @return [Array<Types::ThemeValues>]
|
831
|
-
#
|
832
837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CreateThemeData AWS API Documentation
|
833
838
|
#
|
834
839
|
class CreateThemeData < Struct.new(
|
835
840
|
:name,
|
841
|
+
:values,
|
836
842
|
:overrides,
|
837
|
-
:tags
|
838
|
-
:values)
|
843
|
+
:tags)
|
839
844
|
SENSITIVE = []
|
840
845
|
include Aws::Structure
|
841
846
|
end
|
@@ -844,6 +849,11 @@ module Aws::AmplifyUIBuilder
|
|
844
849
|
# The unique ID of the Amplify app associated with the theme.
|
845
850
|
# @return [String]
|
846
851
|
#
|
852
|
+
# @!attribute [rw] environment_name
|
853
|
+
# The name of the backend environment that is a part of the Amplify
|
854
|
+
# app.
|
855
|
+
# @return [String]
|
856
|
+
#
|
847
857
|
# @!attribute [rw] client_token
|
848
858
|
# The unique client token.
|
849
859
|
#
|
@@ -851,11 +861,6 @@ module Aws::AmplifyUIBuilder
|
|
851
861
|
# not need to pass this option.
|
852
862
|
# @return [String]
|
853
863
|
#
|
854
|
-
# @!attribute [rw] environment_name
|
855
|
-
# The name of the backend environment that is a part of the Amplify
|
856
|
-
# app.
|
857
|
-
# @return [String]
|
858
|
-
#
|
859
864
|
# @!attribute [rw] theme_to_create
|
860
865
|
# Represents the configuration of the theme to create.
|
861
866
|
# @return [Types::CreateThemeData]
|
@@ -864,8 +869,8 @@ module Aws::AmplifyUIBuilder
|
|
864
869
|
#
|
865
870
|
class CreateThemeRequest < Struct.new(
|
866
871
|
:app_id,
|
867
|
-
:client_token,
|
868
872
|
:environment_name,
|
873
|
+
:client_token,
|
869
874
|
:theme_to_create)
|
870
875
|
SENSITIVE = []
|
871
876
|
include Aws::Structure
|
@@ -983,12 +988,17 @@ module Aws::AmplifyUIBuilder
|
|
983
988
|
# The location of the application that will receive the access code.
|
984
989
|
# @return [String]
|
985
990
|
#
|
991
|
+
# @!attribute [rw] client_id
|
992
|
+
# The ID of the client to request the token from.
|
993
|
+
# @return [String]
|
994
|
+
#
|
986
995
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ExchangeCodeForTokenRequestBody AWS API Documentation
|
987
996
|
#
|
988
997
|
class ExchangeCodeForTokenRequestBody < Struct.new(
|
989
998
|
:code,
|
990
|
-
:redirect_uri
|
991
|
-
|
999
|
+
:redirect_uri,
|
1000
|
+
:client_id)
|
1001
|
+
SENSITIVE = [:code, :client_id]
|
992
1002
|
include Aws::Structure
|
993
1003
|
end
|
994
1004
|
|
@@ -1136,6 +1146,14 @@ module Aws::AmplifyUIBuilder
|
|
1136
1146
|
|
1137
1147
|
# Describes the configuration information for a field in a table.
|
1138
1148
|
#
|
1149
|
+
# @!attribute [rw] label
|
1150
|
+
# The label for the field.
|
1151
|
+
# @return [String]
|
1152
|
+
#
|
1153
|
+
# @!attribute [rw] position
|
1154
|
+
# Specifies the field position.
|
1155
|
+
# @return [Types::FieldPosition]
|
1156
|
+
#
|
1139
1157
|
# @!attribute [rw] excluded
|
1140
1158
|
# Specifies whether to hide a field.
|
1141
1159
|
# @return [Boolean]
|
@@ -1145,14 +1163,6 @@ module Aws::AmplifyUIBuilder
|
|
1145
1163
|
# for a field.
|
1146
1164
|
# @return [Types::FieldInputConfig]
|
1147
1165
|
#
|
1148
|
-
# @!attribute [rw] label
|
1149
|
-
# The label for the field.
|
1150
|
-
# @return [String]
|
1151
|
-
#
|
1152
|
-
# @!attribute [rw] position
|
1153
|
-
# Specifies the field position.
|
1154
|
-
# @return [Types::FieldPosition]
|
1155
|
-
#
|
1156
1166
|
# @!attribute [rw] validations
|
1157
1167
|
# The validations to perform on the value in the field.
|
1158
1168
|
# @return [Array<Types::FieldValidationConfiguration>]
|
@@ -1160,10 +1170,10 @@ module Aws::AmplifyUIBuilder
|
|
1160
1170
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldConfig AWS API Documentation
|
1161
1171
|
#
|
1162
1172
|
class FieldConfig < Struct.new(
|
1163
|
-
:excluded,
|
1164
|
-
:input_type,
|
1165
1173
|
:label,
|
1166
1174
|
:position,
|
1175
|
+
:excluded,
|
1176
|
+
:input_type,
|
1167
1177
|
:validations)
|
1168
1178
|
SENSITIVE = []
|
1169
1179
|
include Aws::Structure
|
@@ -1172,12 +1182,20 @@ module Aws::AmplifyUIBuilder
|
|
1172
1182
|
# Describes the configuration for the default input values to display
|
1173
1183
|
# for a field.
|
1174
1184
|
#
|
1175
|
-
# @!attribute [rw]
|
1176
|
-
#
|
1185
|
+
# @!attribute [rw] type
|
1186
|
+
# The input type for the field.
|
1187
|
+
# @return [String]
|
1188
|
+
#
|
1189
|
+
# @!attribute [rw] required
|
1190
|
+
# Specifies a field that requires input.
|
1177
1191
|
# @return [Boolean]
|
1178
1192
|
#
|
1179
|
-
# @!attribute [rw]
|
1180
|
-
#
|
1193
|
+
# @!attribute [rw] read_only
|
1194
|
+
# Specifies a read only field.
|
1195
|
+
# @return [Boolean]
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] placeholder
|
1198
|
+
# The text to display as a placeholder for the field.
|
1181
1199
|
# @return [String]
|
1182
1200
|
#
|
1183
1201
|
# @!attribute [rw] default_value
|
@@ -1188,70 +1206,67 @@ module Aws::AmplifyUIBuilder
|
|
1188
1206
|
# The text to display to describe the field.
|
1189
1207
|
# @return [String]
|
1190
1208
|
#
|
1191
|
-
# @!attribute [rw]
|
1192
|
-
# Specifies whether
|
1193
|
-
# ignored if the `dataSourceType` for the form is a Data Store.
|
1209
|
+
# @!attribute [rw] default_checked
|
1210
|
+
# Specifies whether a field has a default value.
|
1194
1211
|
# @return [Boolean]
|
1195
1212
|
#
|
1196
|
-
# @!attribute [rw]
|
1197
|
-
# The
|
1198
|
-
# @return [
|
1213
|
+
# @!attribute [rw] default_country_code
|
1214
|
+
# The default country code for a phone number.
|
1215
|
+
# @return [String]
|
1199
1216
|
#
|
1200
|
-
# @!attribute [rw]
|
1201
|
-
# The
|
1202
|
-
#
|
1217
|
+
# @!attribute [rw] value_mappings
|
1218
|
+
# The information to use to customize the input fields with data at
|
1219
|
+
# runtime.
|
1220
|
+
# @return [Types::ValueMappings]
|
1203
1221
|
#
|
1204
1222
|
# @!attribute [rw] name
|
1205
1223
|
# The name of the field.
|
1206
1224
|
# @return [String]
|
1207
1225
|
#
|
1208
|
-
# @!attribute [rw]
|
1209
|
-
# The
|
1210
|
-
# @return [
|
1211
|
-
#
|
1212
|
-
# @!attribute [rw] read_only
|
1213
|
-
# Specifies a read only field.
|
1214
|
-
# @return [Boolean]
|
1226
|
+
# @!attribute [rw] min_value
|
1227
|
+
# The minimum value to display for the field.
|
1228
|
+
# @return [Float]
|
1215
1229
|
#
|
1216
|
-
# @!attribute [rw]
|
1217
|
-
#
|
1218
|
-
# @return [
|
1230
|
+
# @!attribute [rw] max_value
|
1231
|
+
# The maximum value to display for the field.
|
1232
|
+
# @return [Float]
|
1219
1233
|
#
|
1220
1234
|
# @!attribute [rw] step
|
1221
1235
|
# The stepping increment for a numeric value in a field.
|
1222
1236
|
# @return [Float]
|
1223
1237
|
#
|
1224
|
-
# @!attribute [rw] type
|
1225
|
-
# The input type for the field.
|
1226
|
-
# @return [String]
|
1227
|
-
#
|
1228
1238
|
# @!attribute [rw] value
|
1229
1239
|
# The value for the field.
|
1230
1240
|
# @return [String]
|
1231
1241
|
#
|
1232
|
-
# @!attribute [rw]
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
# @return [
|
1242
|
+
# @!attribute [rw] is_array
|
1243
|
+
# Specifies whether to render the field as an array. This property is
|
1244
|
+
# ignored if the `dataSourceType` for the form is a Data Store.
|
1245
|
+
# @return [Boolean]
|
1246
|
+
#
|
1247
|
+
# @!attribute [rw] file_uploader_config
|
1248
|
+
# The configuration for the file uploader field.
|
1249
|
+
# @return [Types::FileUploaderFieldConfig]
|
1236
1250
|
#
|
1237
1251
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldInputConfig AWS API Documentation
|
1238
1252
|
#
|
1239
1253
|
class FieldInputConfig < Struct.new(
|
1240
|
-
:
|
1241
|
-
:
|
1254
|
+
:type,
|
1255
|
+
:required,
|
1256
|
+
:read_only,
|
1257
|
+
:placeholder,
|
1242
1258
|
:default_value,
|
1243
1259
|
:descriptive_text,
|
1244
|
-
:
|
1245
|
-
:
|
1246
|
-
:
|
1260
|
+
:default_checked,
|
1261
|
+
:default_country_code,
|
1262
|
+
:value_mappings,
|
1247
1263
|
:name,
|
1248
|
-
:
|
1249
|
-
:
|
1250
|
-
:required,
|
1264
|
+
:min_value,
|
1265
|
+
:max_value,
|
1251
1266
|
:step,
|
1252
|
-
:type,
|
1253
1267
|
:value,
|
1254
|
-
:
|
1268
|
+
:is_array,
|
1269
|
+
:file_uploader_config)
|
1255
1270
|
SENSITIVE = []
|
1256
1271
|
include Aws::Structure
|
1257
1272
|
end
|
@@ -1262,10 +1277,6 @@ module Aws::AmplifyUIBuilder
|
|
1262
1277
|
#
|
1263
1278
|
# @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.
|
1264
1279
|
#
|
1265
|
-
# @!attribute [rw] below
|
1266
|
-
# The field position is below the field specified by the string.
|
1267
|
-
# @return [String]
|
1268
|
-
#
|
1269
1280
|
# @!attribute [rw] fixed
|
1270
1281
|
# The field position is fixed and doesn't change in relation to other
|
1271
1282
|
# fields.
|
@@ -1276,36 +1287,40 @@ module Aws::AmplifyUIBuilder
|
|
1276
1287
|
# string.
|
1277
1288
|
# @return [String]
|
1278
1289
|
#
|
1290
|
+
# @!attribute [rw] below
|
1291
|
+
# The field position is below the field specified by the string.
|
1292
|
+
# @return [String]
|
1293
|
+
#
|
1279
1294
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldPosition AWS API Documentation
|
1280
1295
|
#
|
1281
1296
|
class FieldPosition < Struct.new(
|
1282
|
-
:below,
|
1283
1297
|
:fixed,
|
1284
1298
|
:right_of,
|
1299
|
+
:below,
|
1285
1300
|
:unknown)
|
1286
1301
|
SENSITIVE = []
|
1287
1302
|
include Aws::Structure
|
1288
1303
|
include Aws::Structure::Union
|
1289
1304
|
|
1290
|
-
class Below < FieldPosition; end
|
1291
1305
|
class Fixed < FieldPosition; end
|
1292
1306
|
class RightOf < FieldPosition; end
|
1307
|
+
class Below < FieldPosition; end
|
1293
1308
|
class Unknown < FieldPosition; end
|
1294
1309
|
end
|
1295
1310
|
|
1296
1311
|
# Describes the validation configuration for a field.
|
1297
1312
|
#
|
1298
|
-
# @!attribute [rw]
|
1299
|
-
# The validation to perform on
|
1300
|
-
# @return [
|
1313
|
+
# @!attribute [rw] type
|
1314
|
+
# The validation to perform on an object type.``
|
1315
|
+
# @return [String]
|
1301
1316
|
#
|
1302
1317
|
# @!attribute [rw] str_values
|
1303
1318
|
# The validation to perform on a string value.
|
1304
1319
|
# @return [Array<String>]
|
1305
1320
|
#
|
1306
|
-
# @!attribute [rw]
|
1307
|
-
# The validation to perform on
|
1308
|
-
# @return [
|
1321
|
+
# @!attribute [rw] num_values
|
1322
|
+
# The validation to perform on a number value.
|
1323
|
+
# @return [Array<Integer>]
|
1309
1324
|
#
|
1310
1325
|
# @!attribute [rw] validation_message
|
1311
1326
|
# The validation message to display.
|
@@ -1314,14 +1329,73 @@ module Aws::AmplifyUIBuilder
|
|
1314
1329
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FieldValidationConfiguration AWS API Documentation
|
1315
1330
|
#
|
1316
1331
|
class FieldValidationConfiguration < Struct.new(
|
1317
|
-
:num_values,
|
1318
|
-
:str_values,
|
1319
1332
|
:type,
|
1333
|
+
:str_values,
|
1334
|
+
:num_values,
|
1320
1335
|
:validation_message)
|
1321
1336
|
SENSITIVE = []
|
1322
1337
|
include Aws::Structure
|
1323
1338
|
end
|
1324
1339
|
|
1340
|
+
# Describes the configuration for the file uploader field.
|
1341
|
+
#
|
1342
|
+
# @!attribute [rw] access_level
|
1343
|
+
# The access level to assign to the uploaded files in the Amazon S3
|
1344
|
+
# bucket where they are stored. The valid values for this property are
|
1345
|
+
# `private`, `protected`, or `public`. For detailed information about
|
1346
|
+
# the permissions associated with each access level, see [File access
|
1347
|
+
# levels][1] in the *Amplify documentation*.
|
1348
|
+
#
|
1349
|
+
#
|
1350
|
+
#
|
1351
|
+
# [1]: https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/
|
1352
|
+
# @return [String]
|
1353
|
+
#
|
1354
|
+
# @!attribute [rw] accepted_file_types
|
1355
|
+
# The file types that are allowed to be uploaded by the file uploader.
|
1356
|
+
# Provide this information in an array of strings specifying the valid
|
1357
|
+
# file extensions.
|
1358
|
+
# @return [Array<String>]
|
1359
|
+
#
|
1360
|
+
# @!attribute [rw] show_thumbnails
|
1361
|
+
# Specifies whether to display or hide the image preview after
|
1362
|
+
# selecting a file for upload. The default value is `true` to display
|
1363
|
+
# the image preview.
|
1364
|
+
# @return [Boolean]
|
1365
|
+
#
|
1366
|
+
# @!attribute [rw] is_resumable
|
1367
|
+
# Allows the file upload operation to be paused and resumed. The
|
1368
|
+
# default value is `false`.
|
1369
|
+
#
|
1370
|
+
# When `isResumable` is set to `true`, the file uploader uses a
|
1371
|
+
# multipart upload to break the files into chunks before upload. The
|
1372
|
+
# progress of the upload isn't continuous, because the file uploader
|
1373
|
+
# uploads a chunk at a time.
|
1374
|
+
# @return [Boolean]
|
1375
|
+
#
|
1376
|
+
# @!attribute [rw] max_file_count
|
1377
|
+
# Specifies the maximum number of files that can be selected to
|
1378
|
+
# upload. The default value is an unlimited number of files.
|
1379
|
+
# @return [Integer]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] max_size
|
1382
|
+
# The maximum file size in bytes that the file uploader will accept.
|
1383
|
+
# The default value is an unlimited file size.
|
1384
|
+
# @return [Integer]
|
1385
|
+
#
|
1386
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FileUploaderFieldConfig AWS API Documentation
|
1387
|
+
#
|
1388
|
+
class FileUploaderFieldConfig < Struct.new(
|
1389
|
+
:access_level,
|
1390
|
+
:accepted_file_types,
|
1391
|
+
:show_thumbnails,
|
1392
|
+
:is_resumable,
|
1393
|
+
:max_file_count,
|
1394
|
+
:max_size)
|
1395
|
+
SENSITIVE = []
|
1396
|
+
include Aws::Structure
|
1397
|
+
end
|
1398
|
+
|
1325
1399
|
# Contains the configuration settings for a `Form` user interface (UI)
|
1326
1400
|
# element for an Amplify app. A form is a component you can add to your
|
1327
1401
|
# project by specifying a data source as the default configuration for
|
@@ -1331,27 +1405,11 @@ module Aws::AmplifyUIBuilder
|
|
1331
1405
|
# The unique ID of the Amplify app associated with the form.
|
1332
1406
|
# @return [String]
|
1333
1407
|
#
|
1334
|
-
# @!attribute [rw] cta
|
1335
|
-
# Stores the call to action configuration for the form.
|
1336
|
-
# @return [Types::FormCTA]
|
1337
|
-
#
|
1338
|
-
# @!attribute [rw] data_type
|
1339
|
-
# The type of data source to use to create the form.
|
1340
|
-
# @return [Types::FormDataTypeConfig]
|
1341
|
-
#
|
1342
1408
|
# @!attribute [rw] environment_name
|
1343
1409
|
# The name of the backend environment that is a part of the Amplify
|
1344
1410
|
# app.
|
1345
1411
|
# @return [String]
|
1346
1412
|
#
|
1347
|
-
# @!attribute [rw] fields
|
1348
|
-
# Stores the information about the form's fields.
|
1349
|
-
# @return [Hash<String,Types::FieldConfig>]
|
1350
|
-
#
|
1351
|
-
# @!attribute [rw] form_action_type
|
1352
|
-
# The operation to perform on the specified form.
|
1353
|
-
# @return [String]
|
1354
|
-
#
|
1355
1413
|
# @!attribute [rw] id
|
1356
1414
|
# The unique ID of the form.
|
1357
1415
|
# @return [String]
|
@@ -1360,38 +1418,59 @@ module Aws::AmplifyUIBuilder
|
|
1360
1418
|
# The name of the form.
|
1361
1419
|
# @return [String]
|
1362
1420
|
#
|
1363
|
-
# @!attribute [rw]
|
1364
|
-
# The
|
1421
|
+
# @!attribute [rw] form_action_type
|
1422
|
+
# The operation to perform on the specified form.
|
1365
1423
|
# @return [String]
|
1366
1424
|
#
|
1425
|
+
# @!attribute [rw] style
|
1426
|
+
# Stores the configuration for the form's style.
|
1427
|
+
# @return [Types::FormStyle]
|
1428
|
+
#
|
1429
|
+
# @!attribute [rw] data_type
|
1430
|
+
# The type of data source to use to create the form.
|
1431
|
+
# @return [Types::FormDataTypeConfig]
|
1432
|
+
#
|
1433
|
+
# @!attribute [rw] fields
|
1434
|
+
# Stores the information about the form's fields.
|
1435
|
+
# @return [Hash<String,Types::FieldConfig>]
|
1436
|
+
#
|
1367
1437
|
# @!attribute [rw] sectional_elements
|
1368
1438
|
# Stores the visual helper elements for the form that are not
|
1369
1439
|
# associated with any data.
|
1370
1440
|
# @return [Hash<String,Types::SectionalElement>]
|
1371
1441
|
#
|
1372
|
-
# @!attribute [rw]
|
1373
|
-
#
|
1374
|
-
# @return [
|
1442
|
+
# @!attribute [rw] schema_version
|
1443
|
+
# The schema version of the form when it was imported.
|
1444
|
+
# @return [String]
|
1375
1445
|
#
|
1376
1446
|
# @!attribute [rw] tags
|
1377
1447
|
# One or more key-value pairs to use when tagging the form.
|
1378
1448
|
# @return [Hash<String,String>]
|
1379
1449
|
#
|
1450
|
+
# @!attribute [rw] cta
|
1451
|
+
# Stores the call to action configuration for the form.
|
1452
|
+
# @return [Types::FormCTA]
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] label_decorator
|
1455
|
+
# Specifies an icon or decoration to display on the form.
|
1456
|
+
# @return [String]
|
1457
|
+
#
|
1380
1458
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Form AWS API Documentation
|
1381
1459
|
#
|
1382
1460
|
class Form < Struct.new(
|
1383
1461
|
:app_id,
|
1384
|
-
:cta,
|
1385
|
-
:data_type,
|
1386
1462
|
:environment_name,
|
1387
|
-
:fields,
|
1388
|
-
:form_action_type,
|
1389
1463
|
:id,
|
1390
1464
|
:name,
|
1391
|
-
:
|
1392
|
-
:sectional_elements,
|
1465
|
+
:form_action_type,
|
1393
1466
|
:style,
|
1394
|
-
:
|
1467
|
+
:data_type,
|
1468
|
+
:fields,
|
1469
|
+
:sectional_elements,
|
1470
|
+
:schema_version,
|
1471
|
+
:tags,
|
1472
|
+
:cta,
|
1473
|
+
:label_decorator)
|
1395
1474
|
SENSITIVE = []
|
1396
1475
|
include Aws::Structure
|
1397
1476
|
end
|
@@ -1418,14 +1497,14 @@ module Aws::AmplifyUIBuilder
|
|
1418
1497
|
# Describes the configuration for a button UI element that is a part of
|
1419
1498
|
# a form.
|
1420
1499
|
#
|
1421
|
-
# @!attribute [rw] children
|
1422
|
-
# Describes the button's properties.
|
1423
|
-
# @return [String]
|
1424
|
-
#
|
1425
1500
|
# @!attribute [rw] excluded
|
1426
1501
|
# Specifies whether the button is visible on the form.
|
1427
1502
|
# @return [Boolean]
|
1428
1503
|
#
|
1504
|
+
# @!attribute [rw] children
|
1505
|
+
# Describes the button's properties.
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1429
1508
|
# @!attribute [rw] position
|
1430
1509
|
# The position of the button.
|
1431
1510
|
# @return [Types::FieldPosition]
|
@@ -1433,8 +1512,8 @@ module Aws::AmplifyUIBuilder
|
|
1433
1512
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormButton AWS API Documentation
|
1434
1513
|
#
|
1435
1514
|
class FormButton < Struct.new(
|
1436
|
-
:children,
|
1437
1515
|
:excluded,
|
1516
|
+
:children,
|
1438
1517
|
:position)
|
1439
1518
|
SENSITIVE = []
|
1440
1519
|
include Aws::Structure
|
@@ -1442,17 +1521,17 @@ module Aws::AmplifyUIBuilder
|
|
1442
1521
|
|
1443
1522
|
# Describes the call to action button configuration for the form.
|
1444
1523
|
#
|
1445
|
-
# @!attribute [rw]
|
1446
|
-
#
|
1447
|
-
# @return [
|
1524
|
+
# @!attribute [rw] position
|
1525
|
+
# The position of the button.
|
1526
|
+
# @return [String]
|
1448
1527
|
#
|
1449
1528
|
# @!attribute [rw] clear
|
1450
1529
|
# Displays a clear button.
|
1451
1530
|
# @return [Types::FormButton]
|
1452
1531
|
#
|
1453
|
-
# @!attribute [rw]
|
1454
|
-
#
|
1455
|
-
# @return [
|
1532
|
+
# @!attribute [rw] cancel
|
1533
|
+
# Displays a cancel button.
|
1534
|
+
# @return [Types::FormButton]
|
1456
1535
|
#
|
1457
1536
|
# @!attribute [rw] submit
|
1458
1537
|
# Displays a submit button.
|
@@ -1461,9 +1540,9 @@ module Aws::AmplifyUIBuilder
|
|
1461
1540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormCTA AWS API Documentation
|
1462
1541
|
#
|
1463
1542
|
class FormCTA < Struct.new(
|
1464
|
-
:cancel,
|
1465
|
-
:clear,
|
1466
1543
|
:position,
|
1544
|
+
:clear,
|
1545
|
+
:cancel,
|
1467
1546
|
:submit)
|
1468
1547
|
SENSITIVE = []
|
1469
1548
|
include Aws::Structure
|
@@ -1491,6 +1570,45 @@ module Aws::AmplifyUIBuilder
|
|
1491
1570
|
include Aws::Structure
|
1492
1571
|
end
|
1493
1572
|
|
1573
|
+
# Represents the data binding configuration for a form's input fields
|
1574
|
+
# at runtime.You can use `FormInputBindingPropertiesValue` to add
|
1575
|
+
# exposed properties to a form to allow different values to be entered
|
1576
|
+
# when a form is reused in different places in an app.
|
1577
|
+
#
|
1578
|
+
# @!attribute [rw] type
|
1579
|
+
# The property type.
|
1580
|
+
# @return [String]
|
1581
|
+
#
|
1582
|
+
# @!attribute [rw] binding_properties
|
1583
|
+
# Describes the properties to customize with data at runtime.
|
1584
|
+
# @return [Types::FormInputBindingPropertiesValueProperties]
|
1585
|
+
#
|
1586
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormInputBindingPropertiesValue AWS API Documentation
|
1587
|
+
#
|
1588
|
+
class FormInputBindingPropertiesValue < Struct.new(
|
1589
|
+
:type,
|
1590
|
+
:binding_properties)
|
1591
|
+
SENSITIVE = []
|
1592
|
+
include Aws::Structure
|
1593
|
+
end
|
1594
|
+
|
1595
|
+
# Represents the data binding configuration for a specific property
|
1596
|
+
# using data stored in Amazon Web Services. For Amazon Web Services
|
1597
|
+
# connected properties, you can bind a property to data stored in an
|
1598
|
+
# Amplify DataStore model.
|
1599
|
+
#
|
1600
|
+
# @!attribute [rw] model
|
1601
|
+
# An Amplify DataStore model.
|
1602
|
+
# @return [String]
|
1603
|
+
#
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormInputBindingPropertiesValueProperties AWS API Documentation
|
1605
|
+
#
|
1606
|
+
class FormInputBindingPropertiesValueProperties < Struct.new(
|
1607
|
+
:model)
|
1608
|
+
SENSITIVE = []
|
1609
|
+
include Aws::Structure
|
1610
|
+
end
|
1611
|
+
|
1494
1612
|
# Describes the configuration for an input field on a form. Use
|
1495
1613
|
# `FormInputValueProperty` to specify the values to render or bind by
|
1496
1614
|
# default.
|
@@ -1499,10 +1617,42 @@ module Aws::AmplifyUIBuilder
|
|
1499
1617
|
# The value to assign to the input field.
|
1500
1618
|
# @return [String]
|
1501
1619
|
#
|
1620
|
+
# @!attribute [rw] binding_properties
|
1621
|
+
# The information to bind fields to data at runtime.
|
1622
|
+
# @return [Types::FormInputValuePropertyBindingProperties]
|
1623
|
+
#
|
1624
|
+
# @!attribute [rw] concat
|
1625
|
+
# A list of form properties to concatenate to create the value to
|
1626
|
+
# assign to this field property.
|
1627
|
+
# @return [Array<Types::FormInputValueProperty>]
|
1628
|
+
#
|
1502
1629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormInputValueProperty AWS API Documentation
|
1503
1630
|
#
|
1504
1631
|
class FormInputValueProperty < Struct.new(
|
1505
|
-
:value
|
1632
|
+
:value,
|
1633
|
+
:binding_properties,
|
1634
|
+
:concat)
|
1635
|
+
SENSITIVE = []
|
1636
|
+
include Aws::Structure
|
1637
|
+
end
|
1638
|
+
|
1639
|
+
# Associates a form property to a binding property. This enables exposed
|
1640
|
+
# properties on the top level form to propagate data to the form's
|
1641
|
+
# property values.
|
1642
|
+
#
|
1643
|
+
# @!attribute [rw] property
|
1644
|
+
# The form property to bind to the data field.
|
1645
|
+
# @return [String]
|
1646
|
+
#
|
1647
|
+
# @!attribute [rw] field
|
1648
|
+
# The data field to bind the property to.
|
1649
|
+
# @return [String]
|
1650
|
+
#
|
1651
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormInputValuePropertyBindingProperties AWS API Documentation
|
1652
|
+
#
|
1653
|
+
class FormInputValuePropertyBindingProperties < Struct.new(
|
1654
|
+
:property,
|
1655
|
+
:field)
|
1506
1656
|
SENSITIVE = []
|
1507
1657
|
include Aws::Structure
|
1508
1658
|
end
|
@@ -1513,20 +1663,20 @@ module Aws::AmplifyUIBuilder
|
|
1513
1663
|
# The spacing for the horizontal gap.
|
1514
1664
|
# @return [Types::FormStyleConfig]
|
1515
1665
|
#
|
1516
|
-
# @!attribute [rw] outer_padding
|
1517
|
-
# The size of the outer padding for the form.
|
1518
|
-
# @return [Types::FormStyleConfig]
|
1519
|
-
#
|
1520
1666
|
# @!attribute [rw] vertical_gap
|
1521
1667
|
# The spacing for the vertical gap.
|
1522
1668
|
# @return [Types::FormStyleConfig]
|
1523
1669
|
#
|
1670
|
+
# @!attribute [rw] outer_padding
|
1671
|
+
# The size of the outer padding for the form.
|
1672
|
+
# @return [Types::FormStyleConfig]
|
1673
|
+
#
|
1524
1674
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/FormStyle AWS API Documentation
|
1525
1675
|
#
|
1526
1676
|
class FormStyle < Struct.new(
|
1527
1677
|
:horizontal_gap,
|
1528
|
-
:
|
1529
|
-
:
|
1678
|
+
:vertical_gap,
|
1679
|
+
:outer_padding)
|
1530
1680
|
SENSITIVE = []
|
1531
1681
|
include Aws::Structure
|
1532
1682
|
end
|
@@ -1766,21 +1916,21 @@ module Aws::AmplifyUIBuilder
|
|
1766
1916
|
# app.
|
1767
1917
|
# @return [String]
|
1768
1918
|
#
|
1769
|
-
# @!attribute [rw] max_results
|
1770
|
-
# The maximum number of components to retrieve.
|
1771
|
-
# @return [Integer]
|
1772
|
-
#
|
1773
1919
|
# @!attribute [rw] next_token
|
1774
1920
|
# The token to request the next page of results.
|
1775
1921
|
# @return [String]
|
1776
1922
|
#
|
1923
|
+
# @!attribute [rw] max_results
|
1924
|
+
# The maximum number of components to retrieve.
|
1925
|
+
# @return [Integer]
|
1926
|
+
#
|
1777
1927
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListComponentsRequest AWS API Documentation
|
1778
1928
|
#
|
1779
1929
|
class ListComponentsRequest < Struct.new(
|
1780
1930
|
:app_id,
|
1781
1931
|
:environment_name,
|
1782
|
-
:
|
1783
|
-
:
|
1932
|
+
:next_token,
|
1933
|
+
:max_results)
|
1784
1934
|
SENSITIVE = []
|
1785
1935
|
include Aws::Structure
|
1786
1936
|
end
|
@@ -1811,21 +1961,21 @@ module Aws::AmplifyUIBuilder
|
|
1811
1961
|
# app.
|
1812
1962
|
# @return [String]
|
1813
1963
|
#
|
1814
|
-
# @!attribute [rw] max_results
|
1815
|
-
# The maximum number of forms to retrieve.
|
1816
|
-
# @return [Integer]
|
1817
|
-
#
|
1818
1964
|
# @!attribute [rw] next_token
|
1819
1965
|
# The token to request the next page of results.
|
1820
1966
|
# @return [String]
|
1821
1967
|
#
|
1968
|
+
# @!attribute [rw] max_results
|
1969
|
+
# The maximum number of forms to retrieve.
|
1970
|
+
# @return [Integer]
|
1971
|
+
#
|
1822
1972
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListFormsRequest AWS API Documentation
|
1823
1973
|
#
|
1824
1974
|
class ListFormsRequest < Struct.new(
|
1825
1975
|
:app_id,
|
1826
1976
|
:environment_name,
|
1827
|
-
:
|
1828
|
-
:
|
1977
|
+
:next_token,
|
1978
|
+
:max_results)
|
1829
1979
|
SENSITIVE = []
|
1830
1980
|
include Aws::Structure
|
1831
1981
|
end
|
@@ -1856,21 +2006,21 @@ module Aws::AmplifyUIBuilder
|
|
1856
2006
|
# app.
|
1857
2007
|
# @return [String]
|
1858
2008
|
#
|
1859
|
-
# @!attribute [rw] max_results
|
1860
|
-
# The maximum number of theme results to return in the response.
|
1861
|
-
# @return [Integer]
|
1862
|
-
#
|
1863
2009
|
# @!attribute [rw] next_token
|
1864
2010
|
# The token to request the next page of results.
|
1865
2011
|
# @return [String]
|
1866
2012
|
#
|
2013
|
+
# @!attribute [rw] max_results
|
2014
|
+
# The maximum number of theme results to return in the response.
|
2015
|
+
# @return [Integer]
|
2016
|
+
#
|
1867
2017
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListThemesRequest AWS API Documentation
|
1868
2018
|
#
|
1869
2019
|
class ListThemesRequest < Struct.new(
|
1870
2020
|
:app_id,
|
1871
2021
|
:environment_name,
|
1872
|
-
:
|
1873
|
-
:
|
2022
|
+
:next_token,
|
2023
|
+
:max_results)
|
1874
2024
|
SENSITIVE = []
|
1875
2025
|
include Aws::Structure
|
1876
2026
|
end
|
@@ -1921,6 +2071,10 @@ module Aws::AmplifyUIBuilder
|
|
1921
2071
|
# Stores information for generating Amplify DataStore queries. Use a
|
1922
2072
|
# `Predicate` to retrieve a subset of the data in a collection.
|
1923
2073
|
#
|
2074
|
+
# @!attribute [rw] or
|
2075
|
+
# A list of predicates to combine logically.
|
2076
|
+
# @return [Array<Types::Predicate>]
|
2077
|
+
#
|
1924
2078
|
# @!attribute [rw] and
|
1925
2079
|
# A list of predicates to combine logically.
|
1926
2080
|
# @return [Array<Types::Predicate>]
|
@@ -1929,31 +2083,32 @@ module Aws::AmplifyUIBuilder
|
|
1929
2083
|
# The field to query.
|
1930
2084
|
# @return [String]
|
1931
2085
|
#
|
2086
|
+
# @!attribute [rw] operator
|
2087
|
+
# The operator to use to perform the evaluation.
|
2088
|
+
# @return [String]
|
2089
|
+
#
|
1932
2090
|
# @!attribute [rw] operand
|
1933
2091
|
# The value to use when performing the evaluation.
|
1934
2092
|
# @return [String]
|
1935
2093
|
#
|
1936
|
-
# @!attribute [rw]
|
1937
|
-
# The
|
2094
|
+
# @!attribute [rw] operand_type
|
2095
|
+
# The type of value to use when performing the evaluation.
|
1938
2096
|
# @return [String]
|
1939
2097
|
#
|
1940
|
-
# @!attribute [rw] or
|
1941
|
-
# A list of predicates to combine logically.
|
1942
|
-
# @return [Array<Types::Predicate>]
|
1943
|
-
#
|
1944
2098
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Predicate AWS API Documentation
|
1945
2099
|
#
|
1946
2100
|
class Predicate < Struct.new(
|
2101
|
+
:or,
|
1947
2102
|
:and,
|
1948
2103
|
:field,
|
1949
|
-
:operand,
|
1950
2104
|
:operator,
|
1951
|
-
:
|
2105
|
+
:operand,
|
2106
|
+
:operand_type)
|
1952
2107
|
SENSITIVE = []
|
1953
2108
|
include Aws::Structure
|
1954
2109
|
end
|
1955
2110
|
|
1956
|
-
# Stores the metadata information about a feature on a form
|
2111
|
+
# Stores the metadata information about a feature on a form.
|
1957
2112
|
#
|
1958
2113
|
# @!attribute [rw] new_value
|
1959
2114
|
# The new information to store.
|
@@ -1971,10 +2126,6 @@ module Aws::AmplifyUIBuilder
|
|
1971
2126
|
# The unique ID for the Amplify app.
|
1972
2127
|
# @return [String]
|
1973
2128
|
#
|
1974
|
-
# @!attribute [rw] body
|
1975
|
-
# The metadata information to store.
|
1976
|
-
# @return [Types::PutMetadataFlagBody]
|
1977
|
-
#
|
1978
2129
|
# @!attribute [rw] environment_name
|
1979
2130
|
# The name of the backend environment that is part of the Amplify app.
|
1980
2131
|
# @return [String]
|
@@ -1983,13 +2134,17 @@ module Aws::AmplifyUIBuilder
|
|
1983
2134
|
# The name of the feature associated with the metadata.
|
1984
2135
|
# @return [String]
|
1985
2136
|
#
|
2137
|
+
# @!attribute [rw] body
|
2138
|
+
# The metadata information to store.
|
2139
|
+
# @return [Types::PutMetadataFlagBody]
|
2140
|
+
#
|
1986
2141
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/PutMetadataFlagRequest AWS API Documentation
|
1987
2142
|
#
|
1988
2143
|
class PutMetadataFlagRequest < Struct.new(
|
1989
2144
|
:app_id,
|
1990
|
-
:body,
|
1991
2145
|
:environment_name,
|
1992
|
-
:feature_name
|
2146
|
+
:feature_name,
|
2147
|
+
:body)
|
1993
2148
|
SENSITIVE = []
|
1994
2149
|
include Aws::Structure
|
1995
2150
|
end
|
@@ -2019,11 +2174,16 @@ module Aws::AmplifyUIBuilder
|
|
2019
2174
|
# might have expired.
|
2020
2175
|
# @return [String]
|
2021
2176
|
#
|
2177
|
+
# @!attribute [rw] client_id
|
2178
|
+
# The ID of the client to request the token from.
|
2179
|
+
# @return [String]
|
2180
|
+
#
|
2022
2181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/RefreshTokenRequestBody AWS API Documentation
|
2023
2182
|
#
|
2024
2183
|
class RefreshTokenRequestBody < Struct.new(
|
2025
|
-
:token
|
2026
|
-
|
2184
|
+
:token,
|
2185
|
+
:client_id)
|
2186
|
+
SENSITIVE = [:token, :client_id]
|
2027
2187
|
include Aws::Structure
|
2028
2188
|
end
|
2029
2189
|
|
@@ -2075,14 +2235,9 @@ module Aws::AmplifyUIBuilder
|
|
2075
2235
|
# form. A sectional element can be a header, a text block, or a divider.
|
2076
2236
|
# These elements are static and not associated with any data.
|
2077
2237
|
#
|
2078
|
-
# @!attribute [rw]
|
2079
|
-
#
|
2080
|
-
#
|
2081
|
-
# @return [Integer]
|
2082
|
-
#
|
2083
|
-
# @!attribute [rw] orientation
|
2084
|
-
# Specifies the orientation for a `Divider` sectional element. Valid
|
2085
|
-
# values are `horizontal` or `vertical`.
|
2238
|
+
# @!attribute [rw] type
|
2239
|
+
# The type of sectional element. Valid values are `Heading`, `Text`,
|
2240
|
+
# and `Divider`.
|
2086
2241
|
# @return [String]
|
2087
2242
|
#
|
2088
2243
|
# @!attribute [rw] position
|
@@ -2094,19 +2249,30 @@ module Aws::AmplifyUIBuilder
|
|
2094
2249
|
# The text for a `Text` sectional element.
|
2095
2250
|
# @return [String]
|
2096
2251
|
#
|
2097
|
-
# @!attribute [rw]
|
2098
|
-
#
|
2099
|
-
#
|
2252
|
+
# @!attribute [rw] level
|
2253
|
+
# Specifies the size of the font for a `Heading` sectional element.
|
2254
|
+
# Valid values are `1 | 2 | 3 | 4 | 5 | 6`.
|
2255
|
+
# @return [Integer]
|
2256
|
+
#
|
2257
|
+
# @!attribute [rw] orientation
|
2258
|
+
# Specifies the orientation for a `Divider` sectional element. Valid
|
2259
|
+
# values are `horizontal` or `vertical`.
|
2100
2260
|
# @return [String]
|
2101
2261
|
#
|
2262
|
+
# @!attribute [rw] excluded
|
2263
|
+
# Excludes a sectional element that was generated by default for a
|
2264
|
+
# specified data model.
|
2265
|
+
# @return [Boolean]
|
2266
|
+
#
|
2102
2267
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/SectionalElement AWS API Documentation
|
2103
2268
|
#
|
2104
2269
|
class SectionalElement < Struct.new(
|
2105
|
-
:
|
2106
|
-
:orientation,
|
2270
|
+
:type,
|
2107
2271
|
:position,
|
2108
2272
|
:text,
|
2109
|
-
:
|
2273
|
+
:level,
|
2274
|
+
:orientation,
|
2275
|
+
:excluded)
|
2110
2276
|
SENSITIVE = []
|
2111
2277
|
include Aws::Structure
|
2112
2278
|
end
|
@@ -2128,19 +2294,19 @@ module Aws::AmplifyUIBuilder
|
|
2128
2294
|
|
2129
2295
|
# Describes how to sort the data that you bind to a component.
|
2130
2296
|
#
|
2131
|
-
# @!attribute [rw] direction
|
2132
|
-
# The direction of the sort, either ascending or descending.
|
2133
|
-
# @return [String]
|
2134
|
-
#
|
2135
2297
|
# @!attribute [rw] field
|
2136
2298
|
# The field to perform the sort on.
|
2137
2299
|
# @return [String]
|
2138
2300
|
#
|
2301
|
+
# @!attribute [rw] direction
|
2302
|
+
# The direction of the sort, either ascending or descending.
|
2303
|
+
# @return [String]
|
2304
|
+
#
|
2139
2305
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/SortProperty AWS API Documentation
|
2140
2306
|
#
|
2141
2307
|
class SortProperty < Struct.new(
|
2142
|
-
:
|
2143
|
-
:
|
2308
|
+
:field,
|
2309
|
+
:direction)
|
2144
2310
|
SENSITIVE = []
|
2145
2311
|
include Aws::Structure
|
2146
2312
|
end
|
@@ -2152,10 +2318,6 @@ module Aws::AmplifyUIBuilder
|
|
2152
2318
|
# The unique ID for the Amplify app associated with the theme.
|
2153
2319
|
# @return [String]
|
2154
2320
|
#
|
2155
|
-
# @!attribute [rw] created_at
|
2156
|
-
# The time that the theme was created.
|
2157
|
-
# @return [Time]
|
2158
|
-
#
|
2159
2321
|
# @!attribute [rw] environment_name
|
2160
2322
|
# The name of the backend environment that is a part of the Amplify
|
2161
2323
|
# app.
|
@@ -2165,13 +2327,21 @@ module Aws::AmplifyUIBuilder
|
|
2165
2327
|
# The ID for the theme.
|
2166
2328
|
# @return [String]
|
2167
2329
|
#
|
2330
|
+
# @!attribute [rw] name
|
2331
|
+
# The name of the theme.
|
2332
|
+
# @return [String]
|
2333
|
+
#
|
2334
|
+
# @!attribute [rw] created_at
|
2335
|
+
# The time that the theme was created.
|
2336
|
+
# @return [Time]
|
2337
|
+
#
|
2168
2338
|
# @!attribute [rw] modified_at
|
2169
2339
|
# The time that the theme was modified.
|
2170
2340
|
# @return [Time]
|
2171
2341
|
#
|
2172
|
-
# @!attribute [rw]
|
2173
|
-
#
|
2174
|
-
# @return [
|
2342
|
+
# @!attribute [rw] values
|
2343
|
+
# A list of key-value pairs that defines the properties of the theme.
|
2344
|
+
# @return [Array<Types::ThemeValues>]
|
2175
2345
|
#
|
2176
2346
|
# @!attribute [rw] overrides
|
2177
2347
|
# Describes the properties that can be overriden to customize a theme.
|
@@ -2181,22 +2351,18 @@ module Aws::AmplifyUIBuilder
|
|
2181
2351
|
# One or more key-value pairs to use when tagging the theme.
|
2182
2352
|
# @return [Hash<String,String>]
|
2183
2353
|
#
|
2184
|
-
# @!attribute [rw] values
|
2185
|
-
# A list of key-value pairs that defines the properties of the theme.
|
2186
|
-
# @return [Array<Types::ThemeValues>]
|
2187
|
-
#
|
2188
2354
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/Theme AWS API Documentation
|
2189
2355
|
#
|
2190
2356
|
class Theme < Struct.new(
|
2191
2357
|
:app_id,
|
2192
|
-
:created_at,
|
2193
2358
|
:environment_name,
|
2194
2359
|
:id,
|
2195
|
-
:modified_at,
|
2196
2360
|
:name,
|
2361
|
+
:created_at,
|
2362
|
+
:modified_at,
|
2363
|
+
:values,
|
2197
2364
|
:overrides,
|
2198
|
-
:tags
|
2199
|
-
:values)
|
2365
|
+
:tags)
|
2200
2366
|
SENSITIVE = []
|
2201
2367
|
include Aws::Structure
|
2202
2368
|
end
|
@@ -2232,19 +2398,19 @@ module Aws::AmplifyUIBuilder
|
|
2232
2398
|
|
2233
2399
|
# Describes the configuration of a theme's properties.
|
2234
2400
|
#
|
2235
|
-
# @!attribute [rw] children
|
2236
|
-
# A list of key-value pairs that define the theme's properties.
|
2237
|
-
# @return [Array<Types::ThemeValues>]
|
2238
|
-
#
|
2239
2401
|
# @!attribute [rw] value
|
2240
2402
|
# The value of a theme property.
|
2241
2403
|
# @return [String]
|
2242
2404
|
#
|
2405
|
+
# @!attribute [rw] children
|
2406
|
+
# A list of key-value pairs that define the theme's properties.
|
2407
|
+
# @return [Array<Types::ThemeValues>]
|
2408
|
+
#
|
2243
2409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ThemeValue AWS API Documentation
|
2244
2410
|
#
|
2245
2411
|
class ThemeValue < Struct.new(
|
2246
|
-
:
|
2247
|
-
:
|
2412
|
+
:value,
|
2413
|
+
:children)
|
2248
2414
|
SENSITIVE = []
|
2249
2415
|
include Aws::Structure
|
2250
2416
|
end
|
@@ -2284,75 +2450,75 @@ module Aws::AmplifyUIBuilder
|
|
2284
2450
|
# Updates and saves all of the information about a component, based on
|
2285
2451
|
# component ID.
|
2286
2452
|
#
|
2287
|
-
# @!attribute [rw]
|
2288
|
-
# The
|
2289
|
-
# @return [
|
2453
|
+
# @!attribute [rw] id
|
2454
|
+
# The unique ID of the component to update.
|
2455
|
+
# @return [String]
|
2290
2456
|
#
|
2291
|
-
# @!attribute [rw]
|
2292
|
-
# The
|
2293
|
-
# @return [
|
2457
|
+
# @!attribute [rw] name
|
2458
|
+
# The name of the component to update.
|
2459
|
+
# @return [String]
|
2294
2460
|
#
|
2295
|
-
# @!attribute [rw]
|
2296
|
-
# The
|
2297
|
-
#
|
2298
|
-
# @return [
|
2461
|
+
# @!attribute [rw] source_id
|
2462
|
+
# The unique ID of the component in its original source system, such
|
2463
|
+
# as Figma.
|
2464
|
+
# @return [String]
|
2299
2465
|
#
|
2300
2466
|
# @!attribute [rw] component_type
|
2301
2467
|
# The type of the component. This can be an Amplify custom UI
|
2302
2468
|
# component or another custom component.
|
2303
2469
|
# @return [String]
|
2304
2470
|
#
|
2305
|
-
# @!attribute [rw]
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
# to components.
|
2309
|
-
# @return [Hash<String,Types::ComponentEvent>]
|
2471
|
+
# @!attribute [rw] properties
|
2472
|
+
# Describes the component's properties.
|
2473
|
+
# @return [Hash<String,Types::ComponentProperty>]
|
2310
2474
|
#
|
2311
|
-
# @!attribute [rw]
|
2312
|
-
# The
|
2313
|
-
# @return [
|
2475
|
+
# @!attribute [rw] children
|
2476
|
+
# The components that are instances of the main component.
|
2477
|
+
# @return [Array<Types::ComponentChild>]
|
2314
2478
|
#
|
2315
|
-
# @!attribute [rw]
|
2316
|
-
#
|
2317
|
-
# @return [
|
2479
|
+
# @!attribute [rw] variants
|
2480
|
+
# A list of the unique variants of the main component being updated.
|
2481
|
+
# @return [Array<Types::ComponentVariant>]
|
2318
2482
|
#
|
2319
2483
|
# @!attribute [rw] overrides
|
2320
2484
|
# Describes the properties that can be overriden to customize the
|
2321
2485
|
# component.
|
2322
2486
|
# @return [Hash<String,Hash<String,String>>]
|
2323
2487
|
#
|
2324
|
-
# @!attribute [rw]
|
2325
|
-
#
|
2326
|
-
# @return [Hash<String,Types::
|
2488
|
+
# @!attribute [rw] binding_properties
|
2489
|
+
# The data binding information for the component's properties.
|
2490
|
+
# @return [Hash<String,Types::ComponentBindingPropertiesValue>]
|
2491
|
+
#
|
2492
|
+
# @!attribute [rw] collection_properties
|
2493
|
+
# The configuration for binding a component's properties to a data
|
2494
|
+
# model. Use this for a collection component.
|
2495
|
+
# @return [Hash<String,Types::ComponentDataConfiguration>]
|
2496
|
+
#
|
2497
|
+
# @!attribute [rw] events
|
2498
|
+
# The event configuration for the component. Use for the workflow
|
2499
|
+
# feature in Amplify Studio that allows you to bind events and actions
|
2500
|
+
# to components.
|
2501
|
+
# @return [Hash<String,Types::ComponentEvent>]
|
2327
2502
|
#
|
2328
2503
|
# @!attribute [rw] schema_version
|
2329
2504
|
# The schema version of the component when it was imported.
|
2330
2505
|
# @return [String]
|
2331
2506
|
#
|
2332
|
-
# @!attribute [rw] source_id
|
2333
|
-
# The unique ID of the component in its original source system, such
|
2334
|
-
# as Figma.
|
2335
|
-
# @return [String]
|
2336
|
-
#
|
2337
|
-
# @!attribute [rw] variants
|
2338
|
-
# A list of the unique variants of the main component being updated.
|
2339
|
-
# @return [Array<Types::ComponentVariant>]
|
2340
|
-
#
|
2341
2507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateComponentData AWS API Documentation
|
2342
2508
|
#
|
2343
2509
|
class UpdateComponentData < Struct.new(
|
2344
|
-
:binding_properties,
|
2345
|
-
:children,
|
2346
|
-
:collection_properties,
|
2347
|
-
:component_type,
|
2348
|
-
:events,
|
2349
2510
|
:id,
|
2350
2511
|
:name,
|
2351
|
-
:overrides,
|
2352
|
-
:properties,
|
2353
|
-
:schema_version,
|
2354
2512
|
:source_id,
|
2355
|
-
:
|
2513
|
+
:component_type,
|
2514
|
+
:properties,
|
2515
|
+
:children,
|
2516
|
+
:variants,
|
2517
|
+
:overrides,
|
2518
|
+
:binding_properties,
|
2519
|
+
:collection_properties,
|
2520
|
+
:events,
|
2521
|
+
:schema_version)
|
2356
2522
|
SENSITIVE = []
|
2357
2523
|
include Aws::Structure
|
2358
2524
|
end
|
@@ -2361,13 +2527,6 @@ module Aws::AmplifyUIBuilder
|
|
2361
2527
|
# The unique ID for the Amplify app.
|
2362
2528
|
# @return [String]
|
2363
2529
|
#
|
2364
|
-
# @!attribute [rw] client_token
|
2365
|
-
# The unique client token.
|
2366
|
-
#
|
2367
|
-
# **A suitable default value is auto-generated.** You should normally
|
2368
|
-
# not need to pass this option.
|
2369
|
-
# @return [String]
|
2370
|
-
#
|
2371
2530
|
# @!attribute [rw] environment_name
|
2372
2531
|
# The name of the backend environment that is part of the Amplify app.
|
2373
2532
|
# @return [String]
|
@@ -2376,6 +2535,13 @@ module Aws::AmplifyUIBuilder
|
|
2376
2535
|
# The unique ID for the component.
|
2377
2536
|
# @return [String]
|
2378
2537
|
#
|
2538
|
+
# @!attribute [rw] client_token
|
2539
|
+
# The unique client token.
|
2540
|
+
#
|
2541
|
+
# **A suitable default value is auto-generated.** You should normally
|
2542
|
+
# not need to pass this option.
|
2543
|
+
# @return [String]
|
2544
|
+
#
|
2379
2545
|
# @!attribute [rw] updated_component
|
2380
2546
|
# The configuration of the updated component.
|
2381
2547
|
# @return [Types::UpdateComponentData]
|
@@ -2384,9 +2550,9 @@ module Aws::AmplifyUIBuilder
|
|
2384
2550
|
#
|
2385
2551
|
class UpdateComponentRequest < Struct.new(
|
2386
2552
|
:app_id,
|
2387
|
-
:client_token,
|
2388
2553
|
:environment_name,
|
2389
2554
|
:id,
|
2555
|
+
:client_token,
|
2390
2556
|
:updated_component)
|
2391
2557
|
SENSITIVE = []
|
2392
2558
|
include Aws::Structure
|
@@ -2407,51 +2573,56 @@ module Aws::AmplifyUIBuilder
|
|
2407
2573
|
# Updates and saves all of the information about a form, based on form
|
2408
2574
|
# ID.
|
2409
2575
|
#
|
2410
|
-
# @!attribute [rw]
|
2411
|
-
# The
|
2412
|
-
#
|
2413
|
-
# @return [Types::FormCTA]
|
2576
|
+
# @!attribute [rw] name
|
2577
|
+
# The name of the form.
|
2578
|
+
# @return [String]
|
2414
2579
|
#
|
2415
2580
|
# @!attribute [rw] data_type
|
2416
2581
|
# The type of data source to use to create the form.
|
2417
2582
|
# @return [Types::FormDataTypeConfig]
|
2418
2583
|
#
|
2419
|
-
# @!attribute [rw] fields
|
2420
|
-
# The configuration information for the form's fields.
|
2421
|
-
# @return [Hash<String,Types::FieldConfig>]
|
2422
|
-
#
|
2423
2584
|
# @!attribute [rw] form_action_type
|
2424
2585
|
# Specifies whether to perform a create or update action on the form.
|
2425
2586
|
# @return [String]
|
2426
2587
|
#
|
2427
|
-
# @!attribute [rw]
|
2428
|
-
# The
|
2429
|
-
# @return [String]
|
2588
|
+
# @!attribute [rw] fields
|
2589
|
+
# The configuration information for the form's fields.
|
2590
|
+
# @return [Hash<String,Types::FieldConfig>]
|
2430
2591
|
#
|
2431
|
-
# @!attribute [rw]
|
2432
|
-
# The
|
2433
|
-
# @return [
|
2592
|
+
# @!attribute [rw] style
|
2593
|
+
# The configuration for the form's style.
|
2594
|
+
# @return [Types::FormStyle]
|
2434
2595
|
#
|
2435
2596
|
# @!attribute [rw] sectional_elements
|
2436
2597
|
# The configuration information for the visual helper elements for the
|
2437
2598
|
# form. These elements are not associated with any data.
|
2438
2599
|
# @return [Hash<String,Types::SectionalElement>]
|
2439
2600
|
#
|
2440
|
-
# @!attribute [rw]
|
2441
|
-
# The
|
2442
|
-
# @return [
|
2601
|
+
# @!attribute [rw] schema_version
|
2602
|
+
# The schema version of the form.
|
2603
|
+
# @return [String]
|
2604
|
+
#
|
2605
|
+
# @!attribute [rw] cta
|
2606
|
+
# The `FormCTA` object that stores the call to action configuration
|
2607
|
+
# for the form.
|
2608
|
+
# @return [Types::FormCTA]
|
2609
|
+
#
|
2610
|
+
# @!attribute [rw] label_decorator
|
2611
|
+
# Specifies an icon or decoration to display on the form.
|
2612
|
+
# @return [String]
|
2443
2613
|
#
|
2444
2614
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateFormData AWS API Documentation
|
2445
2615
|
#
|
2446
2616
|
class UpdateFormData < Struct.new(
|
2447
|
-
:
|
2617
|
+
:name,
|
2448
2618
|
:data_type,
|
2449
|
-
:fields,
|
2450
2619
|
:form_action_type,
|
2451
|
-
:
|
2452
|
-
:
|
2620
|
+
:fields,
|
2621
|
+
:style,
|
2453
2622
|
:sectional_elements,
|
2454
|
-
:
|
2623
|
+
:schema_version,
|
2624
|
+
:cta,
|
2625
|
+
:label_decorator)
|
2455
2626
|
SENSITIVE = []
|
2456
2627
|
include Aws::Structure
|
2457
2628
|
end
|
@@ -2460,13 +2631,6 @@ module Aws::AmplifyUIBuilder
|
|
2460
2631
|
# The unique ID for the Amplify app.
|
2461
2632
|
# @return [String]
|
2462
2633
|
#
|
2463
|
-
# @!attribute [rw] client_token
|
2464
|
-
# The unique client token.
|
2465
|
-
#
|
2466
|
-
# **A suitable default value is auto-generated.** You should normally
|
2467
|
-
# not need to pass this option.
|
2468
|
-
# @return [String]
|
2469
|
-
#
|
2470
2634
|
# @!attribute [rw] environment_name
|
2471
2635
|
# The name of the backend environment that is part of the Amplify app.
|
2472
2636
|
# @return [String]
|
@@ -2475,6 +2639,13 @@ module Aws::AmplifyUIBuilder
|
|
2475
2639
|
# The unique ID for the form.
|
2476
2640
|
# @return [String]
|
2477
2641
|
#
|
2642
|
+
# @!attribute [rw] client_token
|
2643
|
+
# The unique client token.
|
2644
|
+
#
|
2645
|
+
# **A suitable default value is auto-generated.** You should normally
|
2646
|
+
# not need to pass this option.
|
2647
|
+
# @return [String]
|
2648
|
+
#
|
2478
2649
|
# @!attribute [rw] updated_form
|
2479
2650
|
# The request accepts the following data in JSON format.
|
2480
2651
|
# @return [Types::UpdateFormData]
|
@@ -2483,9 +2654,9 @@ module Aws::AmplifyUIBuilder
|
|
2483
2654
|
#
|
2484
2655
|
class UpdateFormRequest < Struct.new(
|
2485
2656
|
:app_id,
|
2486
|
-
:client_token,
|
2487
2657
|
:environment_name,
|
2488
2658
|
:id,
|
2659
|
+
:client_token,
|
2489
2660
|
:updated_form)
|
2490
2661
|
SENSITIVE = []
|
2491
2662
|
include Aws::Structure
|
@@ -2513,22 +2684,22 @@ module Aws::AmplifyUIBuilder
|
|
2513
2684
|
# The name of the theme to update.
|
2514
2685
|
# @return [String]
|
2515
2686
|
#
|
2687
|
+
# @!attribute [rw] values
|
2688
|
+
# A list of key-value pairs that define the theme's properties.
|
2689
|
+
# @return [Array<Types::ThemeValues>]
|
2690
|
+
#
|
2516
2691
|
# @!attribute [rw] overrides
|
2517
2692
|
# Describes the properties that can be overriden to customize the
|
2518
2693
|
# theme.
|
2519
2694
|
# @return [Array<Types::ThemeValues>]
|
2520
2695
|
#
|
2521
|
-
# @!attribute [rw] values
|
2522
|
-
# A list of key-value pairs that define the theme's properties.
|
2523
|
-
# @return [Array<Types::ThemeValues>]
|
2524
|
-
#
|
2525
2696
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/UpdateThemeData AWS API Documentation
|
2526
2697
|
#
|
2527
2698
|
class UpdateThemeData < Struct.new(
|
2528
2699
|
:id,
|
2529
2700
|
:name,
|
2530
|
-
:
|
2531
|
-
:
|
2701
|
+
:values,
|
2702
|
+
:overrides)
|
2532
2703
|
SENSITIVE = []
|
2533
2704
|
include Aws::Structure
|
2534
2705
|
end
|
@@ -2537,13 +2708,6 @@ module Aws::AmplifyUIBuilder
|
|
2537
2708
|
# The unique ID for the Amplify app.
|
2538
2709
|
# @return [String]
|
2539
2710
|
#
|
2540
|
-
# @!attribute [rw] client_token
|
2541
|
-
# The unique client token.
|
2542
|
-
#
|
2543
|
-
# **A suitable default value is auto-generated.** You should normally
|
2544
|
-
# not need to pass this option.
|
2545
|
-
# @return [String]
|
2546
|
-
#
|
2547
2711
|
# @!attribute [rw] environment_name
|
2548
2712
|
# The name of the backend environment that is part of the Amplify app.
|
2549
2713
|
# @return [String]
|
@@ -2552,6 +2716,13 @@ module Aws::AmplifyUIBuilder
|
|
2552
2716
|
# The unique ID for the theme.
|
2553
2717
|
# @return [String]
|
2554
2718
|
#
|
2719
|
+
# @!attribute [rw] client_token
|
2720
|
+
# The unique client token.
|
2721
|
+
#
|
2722
|
+
# **A suitable default value is auto-generated.** You should normally
|
2723
|
+
# not need to pass this option.
|
2724
|
+
# @return [String]
|
2725
|
+
#
|
2555
2726
|
# @!attribute [rw] updated_theme
|
2556
2727
|
# The configuration of the updated theme.
|
2557
2728
|
# @return [Types::UpdateThemeData]
|
@@ -2560,9 +2731,9 @@ module Aws::AmplifyUIBuilder
|
|
2560
2731
|
#
|
2561
2732
|
class UpdateThemeRequest < Struct.new(
|
2562
2733
|
:app_id,
|
2563
|
-
:client_token,
|
2564
2734
|
:environment_name,
|
2565
2735
|
:id,
|
2736
|
+
:client_token,
|
2566
2737
|
:updated_theme)
|
2567
2738
|
SENSITIVE = []
|
2568
2739
|
include Aws::Structure
|
@@ -2606,10 +2777,15 @@ module Aws::AmplifyUIBuilder
|
|
2606
2777
|
# The value and display value pairs.
|
2607
2778
|
# @return [Array<Types::ValueMapping>]
|
2608
2779
|
#
|
2780
|
+
# @!attribute [rw] binding_properties
|
2781
|
+
# The information to bind fields to data at runtime.
|
2782
|
+
# @return [Hash<String,Types::FormInputBindingPropertiesValue>]
|
2783
|
+
#
|
2609
2784
|
# @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ValueMappings AWS API Documentation
|
2610
2785
|
#
|
2611
2786
|
class ValueMappings < Struct.new(
|
2612
|
-
:values
|
2787
|
+
:values,
|
2788
|
+
:binding_properties)
|
2613
2789
|
SENSITIVE = []
|
2614
2790
|
include Aws::Structure
|
2615
2791
|
end
|