@aws-sdk/client-amplifyuibuilder 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -247,6 +247,228 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
247
247
  * };
248
248
  * const command = new CreateComponentCommand(input);
249
249
  * const response = await client.send(command);
250
+ * // { // CreateComponentResponse
251
+ * // entity: { // Component
252
+ * // appId: "STRING_VALUE", // required
253
+ * // environmentName: "STRING_VALUE", // required
254
+ * // sourceId: "STRING_VALUE",
255
+ * // id: "STRING_VALUE", // required
256
+ * // name: "STRING_VALUE", // required
257
+ * // componentType: "STRING_VALUE", // required
258
+ * // properties: { // ComponentProperties // required
259
+ * // "<keys>": { // ComponentProperty
260
+ * // value: "STRING_VALUE",
261
+ * // bindingProperties: { // ComponentPropertyBindingProperties
262
+ * // property: "STRING_VALUE", // required
263
+ * // field: "STRING_VALUE",
264
+ * // },
265
+ * // collectionBindingProperties: {
266
+ * // property: "STRING_VALUE", // required
267
+ * // field: "STRING_VALUE",
268
+ * // },
269
+ * // defaultValue: "STRING_VALUE",
270
+ * // model: "STRING_VALUE",
271
+ * // bindings: { // FormBindings
272
+ * // "<keys>": { // FormBindingElement
273
+ * // element: "STRING_VALUE", // required
274
+ * // property: "STRING_VALUE", // required
275
+ * // },
276
+ * // },
277
+ * // event: "STRING_VALUE",
278
+ * // userAttribute: "STRING_VALUE",
279
+ * // concat: [ // ComponentPropertyList
280
+ * // {
281
+ * // value: "STRING_VALUE",
282
+ * // bindingProperties: {
283
+ * // property: "STRING_VALUE", // required
284
+ * // field: "STRING_VALUE",
285
+ * // },
286
+ * // collectionBindingProperties: {
287
+ * // property: "STRING_VALUE", // required
288
+ * // field: "STRING_VALUE",
289
+ * // },
290
+ * // defaultValue: "STRING_VALUE",
291
+ * // model: "STRING_VALUE",
292
+ * // bindings: {
293
+ * // "<keys>": {
294
+ * // element: "STRING_VALUE", // required
295
+ * // property: "STRING_VALUE", // required
296
+ * // },
297
+ * // },
298
+ * // event: "STRING_VALUE",
299
+ * // userAttribute: "STRING_VALUE",
300
+ * // concat: [
301
+ * // "<ComponentProperty>",
302
+ * // ],
303
+ * // condition: { // ComponentConditionProperty
304
+ * // property: "STRING_VALUE",
305
+ * // field: "STRING_VALUE",
306
+ * // operator: "STRING_VALUE",
307
+ * // operand: "STRING_VALUE",
308
+ * // then: "<ComponentProperty>",
309
+ * // else: "<ComponentProperty>",
310
+ * // operandType: "STRING_VALUE",
311
+ * // },
312
+ * // configured: true || false,
313
+ * // type: "STRING_VALUE",
314
+ * // importedValue: "STRING_VALUE",
315
+ * // componentName: "STRING_VALUE",
316
+ * // property: "STRING_VALUE",
317
+ * // },
318
+ * // ],
319
+ * // condition: {
320
+ * // property: "STRING_VALUE",
321
+ * // field: "STRING_VALUE",
322
+ * // operator: "STRING_VALUE",
323
+ * // operand: "STRING_VALUE",
324
+ * // then: "<ComponentProperty>",
325
+ * // else: "<ComponentProperty>",
326
+ * // operandType: "STRING_VALUE",
327
+ * // },
328
+ * // configured: true || false,
329
+ * // type: "STRING_VALUE",
330
+ * // importedValue: "STRING_VALUE",
331
+ * // componentName: "STRING_VALUE",
332
+ * // property: "STRING_VALUE",
333
+ * // },
334
+ * // },
335
+ * // children: [ // ComponentChildList
336
+ * // { // ComponentChild
337
+ * // componentType: "STRING_VALUE", // required
338
+ * // name: "STRING_VALUE", // required
339
+ * // properties: { // required
340
+ * // "<keys>": "<ComponentProperty>",
341
+ * // },
342
+ * // children: [
343
+ * // {
344
+ * // componentType: "STRING_VALUE", // required
345
+ * // name: "STRING_VALUE", // required
346
+ * // properties: "<ComponentProperties>", // required
347
+ * // children: "<ComponentChildList>",
348
+ * // events: { // ComponentEvents
349
+ * // "<keys>": { // ComponentEvent
350
+ * // action: "STRING_VALUE",
351
+ * // parameters: { // ActionParameters
352
+ * // type: "<ComponentProperty>",
353
+ * // url: "<ComponentProperty>",
354
+ * // anchor: "<ComponentProperty>",
355
+ * // target: "<ComponentProperty>",
356
+ * // global: "<ComponentProperty>",
357
+ * // model: "STRING_VALUE",
358
+ * // id: "<ComponentProperty>",
359
+ * // fields: "<ComponentProperties>",
360
+ * // state: { // MutationActionSetStateParameter
361
+ * // componentName: "STRING_VALUE", // required
362
+ * // property: "STRING_VALUE", // required
363
+ * // set: "<ComponentProperty>", // required
364
+ * // },
365
+ * // },
366
+ * // bindingEvent: "STRING_VALUE",
367
+ * // },
368
+ * // },
369
+ * // sourceId: "STRING_VALUE",
370
+ * // },
371
+ * // ],
372
+ * // events: {
373
+ * // "<keys>": {
374
+ * // action: "STRING_VALUE",
375
+ * // parameters: {
376
+ * // type: "<ComponentProperty>",
377
+ * // url: "<ComponentProperty>",
378
+ * // anchor: "<ComponentProperty>",
379
+ * // target: "<ComponentProperty>",
380
+ * // global: "<ComponentProperty>",
381
+ * // model: "STRING_VALUE",
382
+ * // id: "<ComponentProperty>",
383
+ * // fields: "<ComponentProperties>",
384
+ * // state: {
385
+ * // componentName: "STRING_VALUE", // required
386
+ * // property: "STRING_VALUE", // required
387
+ * // set: "<ComponentProperty>", // required
388
+ * // },
389
+ * // },
390
+ * // bindingEvent: "STRING_VALUE",
391
+ * // },
392
+ * // },
393
+ * // sourceId: "STRING_VALUE",
394
+ * // },
395
+ * // ],
396
+ * // variants: [ // ComponentVariants // required
397
+ * // { // ComponentVariant
398
+ * // variantValues: { // ComponentVariantValues
399
+ * // "<keys>": "STRING_VALUE",
400
+ * // },
401
+ * // overrides: { // ComponentOverrides
402
+ * // "<keys>": { // ComponentOverridesValue
403
+ * // "<keys>": "STRING_VALUE",
404
+ * // },
405
+ * // },
406
+ * // },
407
+ * // ],
408
+ * // overrides: { // required
409
+ * // "<keys>": {
410
+ * // "<keys>": "STRING_VALUE",
411
+ * // },
412
+ * // },
413
+ * // bindingProperties: { // ComponentBindingProperties // required
414
+ * // "<keys>": { // ComponentBindingPropertiesValue
415
+ * // type: "STRING_VALUE",
416
+ * // bindingProperties: { // ComponentBindingPropertiesValueProperties
417
+ * // model: "STRING_VALUE",
418
+ * // field: "STRING_VALUE",
419
+ * // predicates: [ // PredicateList
420
+ * // { // Predicate
421
+ * // or: [
422
+ * // {
423
+ * // or: "<PredicateList>",
424
+ * // and: "<PredicateList>",
425
+ * // field: "STRING_VALUE",
426
+ * // operator: "STRING_VALUE",
427
+ * // operand: "STRING_VALUE",
428
+ * // operandType: "STRING_VALUE",
429
+ * // },
430
+ * // ],
431
+ * // and: "<PredicateList>",
432
+ * // field: "STRING_VALUE",
433
+ * // operator: "STRING_VALUE",
434
+ * // operand: "STRING_VALUE",
435
+ * // operandType: "STRING_VALUE",
436
+ * // },
437
+ * // ],
438
+ * // userAttribute: "STRING_VALUE",
439
+ * // bucket: "STRING_VALUE",
440
+ * // key: "STRING_VALUE",
441
+ * // defaultValue: "STRING_VALUE",
442
+ * // slotName: "STRING_VALUE",
443
+ * // },
444
+ * // defaultValue: "STRING_VALUE",
445
+ * // },
446
+ * // },
447
+ * // collectionProperties: { // ComponentCollectionProperties
448
+ * // "<keys>": { // ComponentDataConfiguration
449
+ * // model: "STRING_VALUE", // required
450
+ * // sort: [ // SortPropertyList
451
+ * // { // SortProperty
452
+ * // field: "STRING_VALUE", // required
453
+ * // direction: "STRING_VALUE", // required
454
+ * // },
455
+ * // ],
456
+ * // predicate: "<Predicate>",
457
+ * // identifiers: [ // IdentifierList
458
+ * // "STRING_VALUE",
459
+ * // ],
460
+ * // },
461
+ * // },
462
+ * // createdAt: new Date("TIMESTAMP"), // required
463
+ * // modifiedAt: new Date("TIMESTAMP"),
464
+ * // tags: { // Tags
465
+ * // "<keys>": "STRING_VALUE",
466
+ * // },
467
+ * // events: "<ComponentEvents>",
468
+ * // schemaVersion: "STRING_VALUE",
469
+ * // },
470
+ * // };
471
+ *
250
472
  * ```
251
473
  *
252
474
  * @param CreateComponentCommandInput - {@link CreateComponentCommandInput}
@@ -268,6 +490,8 @@ export interface CreateComponentCommandOutput extends CreateComponentResponse, _
268
490
  * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
269
491
  * maximum number of service resources or operations for your Amazon Web Services account. </p>
270
492
  *
493
+ * @throws {@link AmplifyUIBuilderServiceException}
494
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
271
495
  *
272
496
  */
273
497
  export declare class CreateComponentCommand extends $Command<CreateComponentCommandInput, CreateComponentCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -187,6 +187,166 @@ export interface CreateFormCommandOutput extends CreateFormResponse, __MetadataB
187
187
  * };
188
188
  * const command = new CreateFormCommand(input);
189
189
  * const response = await client.send(command);
190
+ * // { // CreateFormResponse
191
+ * // entity: { // Form
192
+ * // appId: "STRING_VALUE", // required
193
+ * // environmentName: "STRING_VALUE", // required
194
+ * // id: "STRING_VALUE", // required
195
+ * // name: "STRING_VALUE", // required
196
+ * // formActionType: "STRING_VALUE", // required
197
+ * // style: { // FormStyle
198
+ * // horizontalGap: { // FormStyleConfig Union: only one key present
199
+ * // tokenReference: "STRING_VALUE",
200
+ * // value: "STRING_VALUE",
201
+ * // },
202
+ * // verticalGap: {// Union: only one key present
203
+ * // tokenReference: "STRING_VALUE",
204
+ * // value: "STRING_VALUE",
205
+ * // },
206
+ * // outerPadding: {// Union: only one key present
207
+ * // tokenReference: "STRING_VALUE",
208
+ * // value: "STRING_VALUE",
209
+ * // },
210
+ * // },
211
+ * // dataType: { // FormDataTypeConfig
212
+ * // dataSourceType: "STRING_VALUE", // required
213
+ * // dataTypeName: "STRING_VALUE", // required
214
+ * // },
215
+ * // fields: { // FieldsMap // required
216
+ * // "<keys>": { // FieldConfig
217
+ * // label: "STRING_VALUE",
218
+ * // position: { // FieldPosition Union: only one key present
219
+ * // fixed: "STRING_VALUE",
220
+ * // rightOf: "STRING_VALUE",
221
+ * // below: "STRING_VALUE",
222
+ * // },
223
+ * // excluded: true || false,
224
+ * // inputType: { // FieldInputConfig
225
+ * // type: "STRING_VALUE", // required
226
+ * // required: true || false,
227
+ * // readOnly: true || false,
228
+ * // placeholder: "STRING_VALUE",
229
+ * // defaultValue: "STRING_VALUE",
230
+ * // descriptiveText: "STRING_VALUE",
231
+ * // defaultChecked: true || false,
232
+ * // defaultCountryCode: "STRING_VALUE",
233
+ * // valueMappings: { // ValueMappings
234
+ * // values: [ // ValueMappingList // required
235
+ * // { // ValueMapping
236
+ * // displayValue: { // FormInputValueProperty
237
+ * // value: "STRING_VALUE",
238
+ * // bindingProperties: { // FormInputValuePropertyBindingProperties
239
+ * // property: "STRING_VALUE", // required
240
+ * // field: "STRING_VALUE",
241
+ * // },
242
+ * // concat: [ // FormInputValuePropertyList
243
+ * // {
244
+ * // value: "STRING_VALUE",
245
+ * // bindingProperties: {
246
+ * // property: "STRING_VALUE", // required
247
+ * // field: "STRING_VALUE",
248
+ * // },
249
+ * // concat: [
250
+ * // "<FormInputValueProperty>",
251
+ * // ],
252
+ * // },
253
+ * // ],
254
+ * // },
255
+ * // value: "<FormInputValueProperty>", // required
256
+ * // },
257
+ * // ],
258
+ * // bindingProperties: { // FormInputBindingProperties
259
+ * // "<keys>": { // FormInputBindingPropertiesValue
260
+ * // type: "STRING_VALUE",
261
+ * // bindingProperties: { // FormInputBindingPropertiesValueProperties
262
+ * // model: "STRING_VALUE",
263
+ * // },
264
+ * // },
265
+ * // },
266
+ * // },
267
+ * // name: "STRING_VALUE",
268
+ * // minValue: Number("float"),
269
+ * // maxValue: Number("float"),
270
+ * // step: Number("float"),
271
+ * // value: "STRING_VALUE",
272
+ * // isArray: true || false,
273
+ * // fileUploaderConfig: { // FileUploaderFieldConfig
274
+ * // accessLevel: "STRING_VALUE", // required
275
+ * // acceptedFileTypes: [ // StrValues // required
276
+ * // "STRING_VALUE",
277
+ * // ],
278
+ * // showThumbnails: true || false,
279
+ * // isResumable: true || false,
280
+ * // maxFileCount: Number("int"),
281
+ * // maxSize: Number("int"),
282
+ * // },
283
+ * // },
284
+ * // validations: [ // ValidationsList
285
+ * // { // FieldValidationConfiguration
286
+ * // type: "STRING_VALUE", // required
287
+ * // strValues: [
288
+ * // "STRING_VALUE",
289
+ * // ],
290
+ * // numValues: [ // NumValues
291
+ * // Number("int"),
292
+ * // ],
293
+ * // validationMessage: "STRING_VALUE",
294
+ * // },
295
+ * // ],
296
+ * // },
297
+ * // },
298
+ * // sectionalElements: { // SectionalElementMap // required
299
+ * // "<keys>": { // SectionalElement
300
+ * // type: "STRING_VALUE", // required
301
+ * // position: {// Union: only one key present
302
+ * // fixed: "STRING_VALUE",
303
+ * // rightOf: "STRING_VALUE",
304
+ * // below: "STRING_VALUE",
305
+ * // },
306
+ * // text: "STRING_VALUE",
307
+ * // level: Number("int"),
308
+ * // orientation: "STRING_VALUE",
309
+ * // excluded: true || false,
310
+ * // },
311
+ * // },
312
+ * // schemaVersion: "STRING_VALUE", // required
313
+ * // tags: { // Tags
314
+ * // "<keys>": "STRING_VALUE",
315
+ * // },
316
+ * // cta: { // FormCTA
317
+ * // position: "STRING_VALUE",
318
+ * // clear: { // FormButton
319
+ * // excluded: true || false,
320
+ * // children: "STRING_VALUE",
321
+ * // position: {// Union: only one key present
322
+ * // fixed: "STRING_VALUE",
323
+ * // rightOf: "STRING_VALUE",
324
+ * // below: "STRING_VALUE",
325
+ * // },
326
+ * // },
327
+ * // cancel: {
328
+ * // excluded: true || false,
329
+ * // children: "STRING_VALUE",
330
+ * // position: {// Union: only one key present
331
+ * // fixed: "STRING_VALUE",
332
+ * // rightOf: "STRING_VALUE",
333
+ * // below: "STRING_VALUE",
334
+ * // },
335
+ * // },
336
+ * // submit: {
337
+ * // excluded: true || false,
338
+ * // children: "STRING_VALUE",
339
+ * // position: {// Union: only one key present
340
+ * // fixed: "STRING_VALUE",
341
+ * // rightOf: "STRING_VALUE",
342
+ * // below: "STRING_VALUE",
343
+ * // },
344
+ * // },
345
+ * // },
346
+ * // labelDecorator: "STRING_VALUE",
347
+ * // },
348
+ * // };
349
+ *
190
350
  * ```
191
351
  *
192
352
  * @param CreateFormCommandInput - {@link CreateFormCommandInput}
@@ -208,6 +368,8 @@ export interface CreateFormCommandOutput extends CreateFormResponse, __MetadataB
208
368
  * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
209
369
  * maximum number of service resources or operations for your Amazon Web Services account. </p>
210
370
  *
371
+ * @throws {@link AmplifyUIBuilderServiceException}
372
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
211
373
  *
212
374
  */
213
375
  export declare class CreateFormCommand extends $Command<CreateFormCommandInput, CreateFormCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -57,6 +57,38 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat
57
57
  * };
58
58
  * const command = new CreateThemeCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // CreateThemeResponse
61
+ * // entity: { // Theme
62
+ * // appId: "STRING_VALUE", // required
63
+ * // environmentName: "STRING_VALUE", // required
64
+ * // id: "STRING_VALUE", // required
65
+ * // name: "STRING_VALUE", // required
66
+ * // createdAt: new Date("TIMESTAMP"), // required
67
+ * // modifiedAt: new Date("TIMESTAMP"),
68
+ * // values: [ // ThemeValuesList // required
69
+ * // { // ThemeValues
70
+ * // key: "STRING_VALUE",
71
+ * // value: { // ThemeValue
72
+ * // value: "STRING_VALUE",
73
+ * // children: [
74
+ * // {
75
+ * // key: "STRING_VALUE",
76
+ * // value: {
77
+ * // value: "STRING_VALUE",
78
+ * // children: "<ThemeValuesList>",
79
+ * // },
80
+ * // },
81
+ * // ],
82
+ * // },
83
+ * // },
84
+ * // ],
85
+ * // overrides: "<ThemeValuesList>",
86
+ * // tags: { // Tags
87
+ * // "<keys>": "STRING_VALUE",
88
+ * // },
89
+ * // },
90
+ * // };
91
+ *
60
92
  * ```
61
93
  *
62
94
  * @param CreateThemeCommandInput - {@link CreateThemeCommandInput}
@@ -78,6 +110,8 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat
78
110
  * <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
79
111
  * maximum number of service resources or operations for your Amazon Web Services account. </p>
80
112
  *
113
+ * @throws {@link AmplifyUIBuilderServiceException}
114
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
81
115
  *
82
116
  */
83
117
  export declare class CreateThemeCommand extends $Command<CreateThemeCommandInput, CreateThemeCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteComponentCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteComponentCommandInput - {@link DeleteComponentCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>The requested resource does not exist, or access was denied.</p>
52
54
  *
55
+ * @throws {@link AmplifyUIBuilderServiceException}
56
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteComponentCommand extends $Command<DeleteComponentCommandInput, DeleteComponentCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteFormCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteFormCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteFormCommandInput - {@link DeleteFormCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteFormCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>The requested resource does not exist, or access was denied.</p>
52
54
  *
55
+ * @throws {@link AmplifyUIBuilderServiceException}
56
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteFormCommand extends $Command<DeleteFormCommandInput, DeleteFormCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -33,6 +33,8 @@ export interface DeleteThemeCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new DeleteThemeCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param DeleteThemeCommandInput - {@link DeleteThemeCommandInput}
@@ -50,6 +52,8 @@ export interface DeleteThemeCommandOutput extends __MetadataBearer {
50
52
  * @throws {@link ResourceNotFoundException} (client fault)
51
53
  * <p>The requested resource does not exist, or access was denied.</p>
52
54
  *
55
+ * @throws {@link AmplifyUIBuilderServiceException}
56
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
53
57
  *
54
58
  */
55
59
  export declare class DeleteThemeCommand extends $Command<DeleteThemeCommandInput, DeleteThemeCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -36,6 +36,12 @@ export interface ExchangeCodeForTokenCommandOutput extends ExchangeCodeForTokenR
36
36
  * };
37
37
  * const command = new ExchangeCodeForTokenCommand(input);
38
38
  * const response = await client.send(command);
39
+ * // { // ExchangeCodeForTokenResponse
40
+ * // accessToken: "STRING_VALUE", // required
41
+ * // expiresIn: Number("int"), // required
42
+ * // refreshToken: "STRING_VALUE", // required
43
+ * // };
44
+ *
39
45
  * ```
40
46
  *
41
47
  * @param ExchangeCodeForTokenCommandInput - {@link ExchangeCodeForTokenCommandInput}
@@ -47,6 +53,8 @@ export interface ExchangeCodeForTokenCommandOutput extends ExchangeCodeForTokenR
47
53
  * @throws {@link InvalidParameterException} (client fault)
48
54
  * <p>An invalid or out-of-range value was supplied for the input parameter.</p>
49
55
  *
56
+ * @throws {@link AmplifyUIBuilderServiceException}
57
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
50
58
  *
51
59
  */
52
60
  export declare class ExchangeCodeForTokenCommand extends $Command<ExchangeCodeForTokenCommandInput, ExchangeCodeForTokenCommandOutput, AmplifyUIBuilderClientResolvedConfig> {