aws-sdk-amplifyuibuilder 1.12.0 → 1.13.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -77,6 +77,355 @@ module Aws::AmplifyUIBuilder
77
77
  include Aws::Structure
78
78
  end
79
79
 
80
+ # Describes the feature flags that you can specify for a code generation
81
+ # job.
82
+ #
83
+ # @!attribute [rw] is_relationship_supported
84
+ # Specifes whether a code generation job supports data relationships.
85
+ # @return [Boolean]
86
+ #
87
+ # @!attribute [rw] is_non_model_supported
88
+ # Specifies whether a code generation job supports non models.
89
+ # @return [Boolean]
90
+ #
91
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenFeatureFlags AWS API Documentation
92
+ #
93
+ class CodegenFeatureFlags < Struct.new(
94
+ :is_relationship_supported,
95
+ :is_non_model_supported)
96
+ SENSITIVE = []
97
+ include Aws::Structure
98
+ end
99
+
100
+ # Describes the enums in a generic data schema.
101
+ #
102
+ # @!attribute [rw] values
103
+ # The list of enum values in the generic data schema.
104
+ # @return [Array<String>]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenGenericDataEnum AWS API Documentation
107
+ #
108
+ class CodegenGenericDataEnum < Struct.new(
109
+ :values)
110
+ SENSITIVE = []
111
+ include Aws::Structure
112
+ end
113
+
114
+ # Describes a field in a generic data schema.
115
+ #
116
+ # @!attribute [rw] data_type
117
+ # The data type for the generic data field.
118
+ # @return [String]
119
+ #
120
+ # @!attribute [rw] data_type_value
121
+ # The value of the data type for the generic data field.
122
+ # @return [String]
123
+ #
124
+ # @!attribute [rw] required
125
+ # Specifies whether the generic data field is required.
126
+ # @return [Boolean]
127
+ #
128
+ # @!attribute [rw] read_only
129
+ # Specifies whether the generic data field is read-only.
130
+ # @return [Boolean]
131
+ #
132
+ # @!attribute [rw] is_array
133
+ # Specifies whether the generic data field is an array.
134
+ # @return [Boolean]
135
+ #
136
+ # @!attribute [rw] relationship
137
+ # The relationship of the generic data schema.
138
+ # @return [Types::CodegenGenericDataRelationshipType]
139
+ #
140
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenGenericDataField AWS API Documentation
141
+ #
142
+ class CodegenGenericDataField < Struct.new(
143
+ :data_type,
144
+ :data_type_value,
145
+ :required,
146
+ :read_only,
147
+ :is_array,
148
+ :relationship)
149
+ SENSITIVE = []
150
+ include Aws::Structure
151
+ end
152
+
153
+ # Describes a model in a generic data schema.
154
+ #
155
+ # @!attribute [rw] fields
156
+ # The fields in the generic data model.
157
+ # @return [Hash<String,Types::CodegenGenericDataField>]
158
+ #
159
+ # @!attribute [rw] is_join_table
160
+ # Specifies whether the generic data model is a join table.
161
+ # @return [Boolean]
162
+ #
163
+ # @!attribute [rw] primary_keys
164
+ # The primary keys of the generic data model.
165
+ # @return [Array<String>]
166
+ #
167
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenGenericDataModel AWS API Documentation
168
+ #
169
+ class CodegenGenericDataModel < Struct.new(
170
+ :fields,
171
+ :is_join_table,
172
+ :primary_keys)
173
+ SENSITIVE = []
174
+ include Aws::Structure
175
+ end
176
+
177
+ # Describes a non-model in a generic data schema.
178
+ #
179
+ # @!attribute [rw] fields
180
+ # The fields in a generic data schema non model.
181
+ # @return [Hash<String,Types::CodegenGenericDataField>]
182
+ #
183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenGenericDataNonModel AWS API Documentation
184
+ #
185
+ class CodegenGenericDataNonModel < Struct.new(
186
+ :fields)
187
+ SENSITIVE = []
188
+ include Aws::Structure
189
+ end
190
+
191
+ # Describes the relationship between generic data models.
192
+ #
193
+ # @!attribute [rw] type
194
+ # The data relationship type.
195
+ # @return [String]
196
+ #
197
+ # @!attribute [rw] related_model_name
198
+ # The name of the related model in the data relationship.
199
+ # @return [String]
200
+ #
201
+ # @!attribute [rw] related_model_fields
202
+ # The related model fields in the data relationship.
203
+ # @return [Array<String>]
204
+ #
205
+ # @!attribute [rw] can_unlink_associated_model
206
+ # Specifies whether the relationship can unlink the associated model.
207
+ # @return [Boolean]
208
+ #
209
+ # @!attribute [rw] related_join_field_name
210
+ # The name of the related join field in the data relationship.
211
+ # @return [String]
212
+ #
213
+ # @!attribute [rw] related_join_table_name
214
+ # The name of the related join table in the data relationship.
215
+ # @return [String]
216
+ #
217
+ # @!attribute [rw] belongs_to_field_on_related_model
218
+ # The value of the `belongsTo` field on the related data model.
219
+ # @return [String]
220
+ #
221
+ # @!attribute [rw] associated_fields
222
+ # The associated fields of the data relationship.
223
+ # @return [Array<String>]
224
+ #
225
+ # @!attribute [rw] is_has_many_index
226
+ # Specifies whether the `@index` directive is supported for a
227
+ # `hasMany` data relationship.
228
+ # @return [Boolean]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenGenericDataRelationshipType AWS API Documentation
231
+ #
232
+ class CodegenGenericDataRelationshipType < Struct.new(
233
+ :type,
234
+ :related_model_name,
235
+ :related_model_fields,
236
+ :can_unlink_associated_model,
237
+ :related_join_field_name,
238
+ :related_join_table_name,
239
+ :belongs_to_field_on_related_model,
240
+ :associated_fields,
241
+ :is_has_many_index)
242
+ SENSITIVE = []
243
+ include Aws::Structure
244
+ end
245
+
246
+ # Describes the configuration for a code generation job that is
247
+ # associated with an Amplify app.
248
+ #
249
+ # @!attribute [rw] id
250
+ # The unique ID for the code generation job.
251
+ # @return [String]
252
+ #
253
+ # @!attribute [rw] app_id
254
+ # The ID of the Amplify app associated with the code generation job.
255
+ # @return [String]
256
+ #
257
+ # @!attribute [rw] environment_name
258
+ # The name of the backend environment associated with the code
259
+ # generation job.
260
+ # @return [String]
261
+ #
262
+ # @!attribute [rw] render_config
263
+ # Describes the configuration information for rendering the UI
264
+ # component associated the code generation job.
265
+ # @return [Types::CodegenJobRenderConfig]
266
+ #
267
+ # @!attribute [rw] generic_data_schema
268
+ # Describes the data schema for a code generation job.
269
+ # @return [Types::CodegenJobGenericDataSchema]
270
+ #
271
+ # @!attribute [rw] auto_generate_forms
272
+ # Specifies whether to autogenerate forms in the code generation job.
273
+ # @return [Boolean]
274
+ #
275
+ # @!attribute [rw] features
276
+ # Describes the feature flags that you can specify for a code
277
+ # generation job.
278
+ # @return [Types::CodegenFeatureFlags]
279
+ #
280
+ # @!attribute [rw] status
281
+ # The status of the code generation job.
282
+ # @return [String]
283
+ #
284
+ # @!attribute [rw] status_message
285
+ # The customized status message for the code generation job.
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] asset
289
+ # The `CodegenJobAsset` to use for the code generation job.
290
+ # @return [Types::CodegenJobAsset]
291
+ #
292
+ # @!attribute [rw] tags
293
+ # One or more key-value pairs to use when tagging the code generation
294
+ # job.
295
+ # @return [Hash<String,String>]
296
+ #
297
+ # @!attribute [rw] created_at
298
+ # The time that the code generation job was created.
299
+ # @return [Time]
300
+ #
301
+ # @!attribute [rw] modified_at
302
+ # The time that the code generation job was modified.
303
+ # @return [Time]
304
+ #
305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenJob AWS API Documentation
306
+ #
307
+ class CodegenJob < Struct.new(
308
+ :id,
309
+ :app_id,
310
+ :environment_name,
311
+ :render_config,
312
+ :generic_data_schema,
313
+ :auto_generate_forms,
314
+ :features,
315
+ :status,
316
+ :status_message,
317
+ :asset,
318
+ :tags,
319
+ :created_at,
320
+ :modified_at)
321
+ SENSITIVE = []
322
+ include Aws::Structure
323
+ end
324
+
325
+ # Describes an asset for a code generation job.
326
+ #
327
+ # @!attribute [rw] download_url
328
+ # The URL to use to access the asset.
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenJobAsset AWS API Documentation
332
+ #
333
+ class CodegenJobAsset < Struct.new(
334
+ :download_url)
335
+ SENSITIVE = []
336
+ include Aws::Structure
337
+ end
338
+
339
+ # Describes the data schema for a code generation job.
340
+ #
341
+ # @!attribute [rw] data_source_type
342
+ # The type of the data source for the schema. Currently, the only
343
+ # valid value is an Amplify `DataStore`.
344
+ # @return [String]
345
+ #
346
+ # @!attribute [rw] models
347
+ # The name of a `CodegenGenericDataModel`.
348
+ # @return [Hash<String,Types::CodegenGenericDataModel>]
349
+ #
350
+ # @!attribute [rw] enums
351
+ # The name of a `CodegenGenericDataEnum`.
352
+ # @return [Hash<String,Types::CodegenGenericDataEnum>]
353
+ #
354
+ # @!attribute [rw] non_models
355
+ # The name of a `CodegenGenericDataNonModel`.
356
+ # @return [Hash<String,Types::CodegenGenericDataNonModel>]
357
+ #
358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenJobGenericDataSchema AWS API Documentation
359
+ #
360
+ class CodegenJobGenericDataSchema < Struct.new(
361
+ :data_source_type,
362
+ :models,
363
+ :enums,
364
+ :non_models)
365
+ SENSITIVE = []
366
+ include Aws::Structure
367
+ end
368
+
369
+ # Describes the configuration information for rendering the UI component
370
+ # associated the code generation job.
371
+ #
372
+ # @note CodegenJobRenderConfig is a union - when making an API calls you must set exactly one of the members.
373
+ #
374
+ # @note CodegenJobRenderConfig is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CodegenJobRenderConfig corresponding to the set member.
375
+ #
376
+ # @!attribute [rw] react
377
+ # The name of the `ReactStartCodegenJobData` object.
378
+ # @return [Types::ReactStartCodegenJobData]
379
+ #
380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenJobRenderConfig AWS API Documentation
381
+ #
382
+ class CodegenJobRenderConfig < Struct.new(
383
+ :react,
384
+ :unknown)
385
+ SENSITIVE = []
386
+ include Aws::Structure
387
+ include Aws::Structure::Union
388
+
389
+ class React < CodegenJobRenderConfig; end
390
+ class Unknown < CodegenJobRenderConfig; end
391
+ end
392
+
393
+ # A summary of the basic information about the code generation job.
394
+ #
395
+ # @!attribute [rw] app_id
396
+ # The unique ID of the Amplify app associated with the code generation
397
+ # job.
398
+ # @return [String]
399
+ #
400
+ # @!attribute [rw] environment_name
401
+ # The name of the backend environment associated with the code
402
+ # generation job.
403
+ # @return [String]
404
+ #
405
+ # @!attribute [rw] id
406
+ # The unique ID for the code generation job summary.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] created_at
410
+ # The time that the code generation job summary was created.
411
+ # @return [Time]
412
+ #
413
+ # @!attribute [rw] modified_at
414
+ # The time that the code generation job summary was modified.
415
+ # @return [Time]
416
+ #
417
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/CodegenJobSummary AWS API Documentation
418
+ #
419
+ class CodegenJobSummary < Struct.new(
420
+ :app_id,
421
+ :environment_name,
422
+ :id,
423
+ :created_at,
424
+ :modified_at)
425
+ SENSITIVE = []
426
+ include Aws::Structure
427
+ end
428
+
80
429
  # Contains the configuration settings for a user interface (UI) element
81
430
  # for an Amplify app. A component is configured as a primary,
82
431
  # stand-alone UI element. Use `ComponentChild` to configure an instance
@@ -1750,6 +2099,42 @@ module Aws::AmplifyUIBuilder
1750
2099
  include Aws::Structure
1751
2100
  end
1752
2101
 
2102
+ # @!attribute [rw] app_id
2103
+ # The unique ID of the Amplify app associated with the code generation
2104
+ # job.
2105
+ # @return [String]
2106
+ #
2107
+ # @!attribute [rw] environment_name
2108
+ # The name of the backend environment that is a part of the Amplify
2109
+ # app associated with the code generation job.
2110
+ # @return [String]
2111
+ #
2112
+ # @!attribute [rw] id
2113
+ # The unique ID of the code generation job.
2114
+ # @return [String]
2115
+ #
2116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetCodegenJobRequest AWS API Documentation
2117
+ #
2118
+ class GetCodegenJobRequest < Struct.new(
2119
+ :app_id,
2120
+ :environment_name,
2121
+ :id)
2122
+ SENSITIVE = []
2123
+ include Aws::Structure
2124
+ end
2125
+
2126
+ # @!attribute [rw] job
2127
+ # The configuration settings for the code generation job.
2128
+ # @return [Types::CodegenJob]
2129
+ #
2130
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/GetCodegenJobResponse AWS API Documentation
2131
+ #
2132
+ class GetCodegenJobResponse < Struct.new(
2133
+ :job)
2134
+ SENSITIVE = []
2135
+ include Aws::Structure
2136
+ end
2137
+
1753
2138
  # @!attribute [rw] app_id
1754
2139
  # The unique ID of the Amplify app.
1755
2140
  # @return [String]
@@ -1907,6 +2292,51 @@ module Aws::AmplifyUIBuilder
1907
2292
  include Aws::Structure
1908
2293
  end
1909
2294
 
2295
+ # @!attribute [rw] app_id
2296
+ # The unique ID for the Amplify app.
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] environment_name
2300
+ # The name of the backend environment that is a part of the Amplify
2301
+ # app.
2302
+ # @return [String]
2303
+ #
2304
+ # @!attribute [rw] next_token
2305
+ # The token to request the next page of results.
2306
+ # @return [String]
2307
+ #
2308
+ # @!attribute [rw] max_results
2309
+ # The maximum number of jobs to retrieve.
2310
+ # @return [Integer]
2311
+ #
2312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListCodegenJobsRequest AWS API Documentation
2313
+ #
2314
+ class ListCodegenJobsRequest < Struct.new(
2315
+ :app_id,
2316
+ :environment_name,
2317
+ :next_token,
2318
+ :max_results)
2319
+ SENSITIVE = []
2320
+ include Aws::Structure
2321
+ end
2322
+
2323
+ # @!attribute [rw] entities
2324
+ # The list of code generation jobs for the Amplify app.
2325
+ # @return [Array<Types::CodegenJobSummary>]
2326
+ #
2327
+ # @!attribute [rw] next_token
2328
+ # The pagination token that's included if more results are available.
2329
+ # @return [String]
2330
+ #
2331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ListCodegenJobsResponse AWS API Documentation
2332
+ #
2333
+ class ListCodegenJobsResponse < Struct.new(
2334
+ :entities,
2335
+ :next_token)
2336
+ SENSITIVE = []
2337
+ include Aws::Structure
2338
+ end
2339
+
1910
2340
  # @!attribute [rw] app_id
1911
2341
  # The unique ID for the Amplify app.
1912
2342
  # @return [String]
@@ -2149,6 +2579,42 @@ module Aws::AmplifyUIBuilder
2149
2579
  include Aws::Structure
2150
2580
  end
2151
2581
 
2582
+ # Describes the code generation job configuration for a React project.
2583
+ #
2584
+ # @!attribute [rw] module
2585
+ # The JavaScript module type.
2586
+ # @return [String]
2587
+ #
2588
+ # @!attribute [rw] target
2589
+ # The ECMAScript specification to use.
2590
+ # @return [String]
2591
+ #
2592
+ # @!attribute [rw] script
2593
+ # The file type to use for a JavaScript project.
2594
+ # @return [String]
2595
+ #
2596
+ # @!attribute [rw] render_type_declarations
2597
+ # Specifies whether the code generation job should render type
2598
+ # declaration files.
2599
+ # @return [Boolean]
2600
+ #
2601
+ # @!attribute [rw] inline_source_map
2602
+ # Specifies whether the code generation job should render inline
2603
+ # source maps.
2604
+ # @return [Boolean]
2605
+ #
2606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ReactStartCodegenJobData AWS API Documentation
2607
+ #
2608
+ class ReactStartCodegenJobData < Struct.new(
2609
+ :module,
2610
+ :target,
2611
+ :script,
2612
+ :render_type_declarations,
2613
+ :inline_source_map)
2614
+ SENSITIVE = []
2615
+ include Aws::Structure
2616
+ end
2617
+
2152
2618
  # @!attribute [rw] provider
2153
2619
  # The third-party provider for the token. The only valid value is
2154
2620
  # `figma`.
@@ -2311,6 +2777,86 @@ module Aws::AmplifyUIBuilder
2311
2777
  include Aws::Structure
2312
2778
  end
2313
2779
 
2780
+ # The code generation job resource configuration.
2781
+ #
2782
+ # @!attribute [rw] render_config
2783
+ # The code generation configuration for the codegen job.
2784
+ # @return [Types::CodegenJobRenderConfig]
2785
+ #
2786
+ # @!attribute [rw] generic_data_schema
2787
+ # The data schema to use for a code generation job.
2788
+ # @return [Types::CodegenJobGenericDataSchema]
2789
+ #
2790
+ # @!attribute [rw] auto_generate_forms
2791
+ # Specifies whether to autogenerate forms in the code generation job.
2792
+ # @return [Boolean]
2793
+ #
2794
+ # @!attribute [rw] features
2795
+ # The feature flags for a code generation job.
2796
+ # @return [Types::CodegenFeatureFlags]
2797
+ #
2798
+ # @!attribute [rw] tags
2799
+ # One or more key-value pairs to use when tagging the code generation
2800
+ # job data.
2801
+ # @return [Hash<String,String>]
2802
+ #
2803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/StartCodegenJobData AWS API Documentation
2804
+ #
2805
+ class StartCodegenJobData < Struct.new(
2806
+ :render_config,
2807
+ :generic_data_schema,
2808
+ :auto_generate_forms,
2809
+ :features,
2810
+ :tags)
2811
+ SENSITIVE = []
2812
+ include Aws::Structure
2813
+ end
2814
+
2815
+ # @!attribute [rw] app_id
2816
+ # The unique ID for the Amplify app.
2817
+ # @return [String]
2818
+ #
2819
+ # @!attribute [rw] environment_name
2820
+ # The name of the backend environment that is a part of the Amplify
2821
+ # app.
2822
+ # @return [String]
2823
+ #
2824
+ # @!attribute [rw] client_token
2825
+ # The idempotency token used to ensure that the code generation job
2826
+ # request completes only once.
2827
+ #
2828
+ # **A suitable default value is auto-generated.** You should normally
2829
+ # not need to pass this option.
2830
+ # @return [String]
2831
+ #
2832
+ # @!attribute [rw] codegen_job_to_create
2833
+ # The code generation job resource configuration.
2834
+ # @return [Types::StartCodegenJobData]
2835
+ #
2836
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/StartCodegenJobRequest AWS API Documentation
2837
+ #
2838
+ class StartCodegenJobRequest < Struct.new(
2839
+ :app_id,
2840
+ :environment_name,
2841
+ :client_token,
2842
+ :codegen_job_to_create)
2843
+ SENSITIVE = []
2844
+ include Aws::Structure
2845
+ end
2846
+
2847
+ # @!attribute [rw] entity
2848
+ # The code generation job for a UI component that is associated with
2849
+ # an Amplify app.
2850
+ # @return [Types::CodegenJob]
2851
+ #
2852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/StartCodegenJobResponse AWS API Documentation
2853
+ #
2854
+ class StartCodegenJobResponse < Struct.new(
2855
+ :entity)
2856
+ SENSITIVE = []
2857
+ include Aws::Structure
2858
+ end
2859
+
2314
2860
  # A theme is a collection of style settings that apply globally to the
2315
2861
  # components associated with an Amplify application.
2316
2862
  #
@@ -2434,6 +2980,19 @@ module Aws::AmplifyUIBuilder
2434
2980
  include Aws::Structure
2435
2981
  end
2436
2982
 
2983
+ # The request was denied due to request throttling.
2984
+ #
2985
+ # @!attribute [rw] message
2986
+ # @return [String]
2987
+ #
2988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/amplifyuibuilder-2021-08-11/ThrottlingException AWS API Documentation
2989
+ #
2990
+ class ThrottlingException < Struct.new(
2991
+ :message)
2992
+ SENSITIVE = []
2993
+ include Aws::Structure
2994
+ end
2995
+
2437
2996
  # You don't have permission to perform this operation.
2438
2997
  #
2439
2998
  # @!attribute [rw] message
@@ -53,6 +53,6 @@ require_relative 'aws-sdk-amplifyuibuilder/customizations'
53
53
  # @!group service
54
54
  module Aws::AmplifyUIBuilder
55
55
 
56
- GEM_VERSION = '1.12.0'
56
+ GEM_VERSION = '1.13.0'
57
57
 
58
58
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-amplifyuibuilder
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.12.0
4
+ version: 1.13.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-31 00:00:00.000000000 Z
11
+ date: 2023-06-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core