@aws-sdk/client-amplifyuibuilder 3.321.1 → 3.326.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.
@@ -33,6 +33,231 @@ export interface ExportComponentsCommandOutput extends ExportComponentsResponse,
33
33
  * };
34
34
  * const command = new ExportComponentsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ExportComponentsResponse
37
+ * // entities: [ // ComponentList // required
38
+ * // { // Component
39
+ * // appId: "STRING_VALUE", // required
40
+ * // environmentName: "STRING_VALUE", // required
41
+ * // sourceId: "STRING_VALUE",
42
+ * // id: "STRING_VALUE", // required
43
+ * // name: "STRING_VALUE", // required
44
+ * // componentType: "STRING_VALUE", // required
45
+ * // properties: { // ComponentProperties // required
46
+ * // "<keys>": { // ComponentProperty
47
+ * // value: "STRING_VALUE",
48
+ * // bindingProperties: { // ComponentPropertyBindingProperties
49
+ * // property: "STRING_VALUE", // required
50
+ * // field: "STRING_VALUE",
51
+ * // },
52
+ * // collectionBindingProperties: {
53
+ * // property: "STRING_VALUE", // required
54
+ * // field: "STRING_VALUE",
55
+ * // },
56
+ * // defaultValue: "STRING_VALUE",
57
+ * // model: "STRING_VALUE",
58
+ * // bindings: { // FormBindings
59
+ * // "<keys>": { // FormBindingElement
60
+ * // element: "STRING_VALUE", // required
61
+ * // property: "STRING_VALUE", // required
62
+ * // },
63
+ * // },
64
+ * // event: "STRING_VALUE",
65
+ * // userAttribute: "STRING_VALUE",
66
+ * // concat: [ // ComponentPropertyList
67
+ * // {
68
+ * // value: "STRING_VALUE",
69
+ * // bindingProperties: {
70
+ * // property: "STRING_VALUE", // required
71
+ * // field: "STRING_VALUE",
72
+ * // },
73
+ * // collectionBindingProperties: {
74
+ * // property: "STRING_VALUE", // required
75
+ * // field: "STRING_VALUE",
76
+ * // },
77
+ * // defaultValue: "STRING_VALUE",
78
+ * // model: "STRING_VALUE",
79
+ * // bindings: {
80
+ * // "<keys>": {
81
+ * // element: "STRING_VALUE", // required
82
+ * // property: "STRING_VALUE", // required
83
+ * // },
84
+ * // },
85
+ * // event: "STRING_VALUE",
86
+ * // userAttribute: "STRING_VALUE",
87
+ * // concat: [
88
+ * // "<ComponentProperty>",
89
+ * // ],
90
+ * // condition: { // ComponentConditionProperty
91
+ * // property: "STRING_VALUE",
92
+ * // field: "STRING_VALUE",
93
+ * // operator: "STRING_VALUE",
94
+ * // operand: "STRING_VALUE",
95
+ * // then: "<ComponentProperty>",
96
+ * // else: "<ComponentProperty>",
97
+ * // operandType: "STRING_VALUE",
98
+ * // },
99
+ * // configured: true || false,
100
+ * // type: "STRING_VALUE",
101
+ * // importedValue: "STRING_VALUE",
102
+ * // componentName: "STRING_VALUE",
103
+ * // property: "STRING_VALUE",
104
+ * // },
105
+ * // ],
106
+ * // condition: {
107
+ * // property: "STRING_VALUE",
108
+ * // field: "STRING_VALUE",
109
+ * // operator: "STRING_VALUE",
110
+ * // operand: "STRING_VALUE",
111
+ * // then: "<ComponentProperty>",
112
+ * // else: "<ComponentProperty>",
113
+ * // operandType: "STRING_VALUE",
114
+ * // },
115
+ * // configured: true || false,
116
+ * // type: "STRING_VALUE",
117
+ * // importedValue: "STRING_VALUE",
118
+ * // componentName: "STRING_VALUE",
119
+ * // property: "STRING_VALUE",
120
+ * // },
121
+ * // },
122
+ * // children: [ // ComponentChildList
123
+ * // { // ComponentChild
124
+ * // componentType: "STRING_VALUE", // required
125
+ * // name: "STRING_VALUE", // required
126
+ * // properties: { // required
127
+ * // "<keys>": "<ComponentProperty>",
128
+ * // },
129
+ * // children: [
130
+ * // {
131
+ * // componentType: "STRING_VALUE", // required
132
+ * // name: "STRING_VALUE", // required
133
+ * // properties: "<ComponentProperties>", // required
134
+ * // children: "<ComponentChildList>",
135
+ * // events: { // ComponentEvents
136
+ * // "<keys>": { // ComponentEvent
137
+ * // action: "STRING_VALUE",
138
+ * // parameters: { // ActionParameters
139
+ * // type: "<ComponentProperty>",
140
+ * // url: "<ComponentProperty>",
141
+ * // anchor: "<ComponentProperty>",
142
+ * // target: "<ComponentProperty>",
143
+ * // global: "<ComponentProperty>",
144
+ * // model: "STRING_VALUE",
145
+ * // id: "<ComponentProperty>",
146
+ * // fields: "<ComponentProperties>",
147
+ * // state: { // MutationActionSetStateParameter
148
+ * // componentName: "STRING_VALUE", // required
149
+ * // property: "STRING_VALUE", // required
150
+ * // set: "<ComponentProperty>", // required
151
+ * // },
152
+ * // },
153
+ * // bindingEvent: "STRING_VALUE",
154
+ * // },
155
+ * // },
156
+ * // sourceId: "STRING_VALUE",
157
+ * // },
158
+ * // ],
159
+ * // events: {
160
+ * // "<keys>": {
161
+ * // action: "STRING_VALUE",
162
+ * // parameters: {
163
+ * // type: "<ComponentProperty>",
164
+ * // url: "<ComponentProperty>",
165
+ * // anchor: "<ComponentProperty>",
166
+ * // target: "<ComponentProperty>",
167
+ * // global: "<ComponentProperty>",
168
+ * // model: "STRING_VALUE",
169
+ * // id: "<ComponentProperty>",
170
+ * // fields: "<ComponentProperties>",
171
+ * // state: {
172
+ * // componentName: "STRING_VALUE", // required
173
+ * // property: "STRING_VALUE", // required
174
+ * // set: "<ComponentProperty>", // required
175
+ * // },
176
+ * // },
177
+ * // bindingEvent: "STRING_VALUE",
178
+ * // },
179
+ * // },
180
+ * // sourceId: "STRING_VALUE",
181
+ * // },
182
+ * // ],
183
+ * // variants: [ // ComponentVariants // required
184
+ * // { // ComponentVariant
185
+ * // variantValues: { // ComponentVariantValues
186
+ * // "<keys>": "STRING_VALUE",
187
+ * // },
188
+ * // overrides: { // ComponentOverrides
189
+ * // "<keys>": { // ComponentOverridesValue
190
+ * // "<keys>": "STRING_VALUE",
191
+ * // },
192
+ * // },
193
+ * // },
194
+ * // ],
195
+ * // overrides: { // required
196
+ * // "<keys>": {
197
+ * // "<keys>": "STRING_VALUE",
198
+ * // },
199
+ * // },
200
+ * // bindingProperties: { // ComponentBindingProperties // required
201
+ * // "<keys>": { // ComponentBindingPropertiesValue
202
+ * // type: "STRING_VALUE",
203
+ * // bindingProperties: { // ComponentBindingPropertiesValueProperties
204
+ * // model: "STRING_VALUE",
205
+ * // field: "STRING_VALUE",
206
+ * // predicates: [ // PredicateList
207
+ * // { // Predicate
208
+ * // or: [
209
+ * // {
210
+ * // or: "<PredicateList>",
211
+ * // and: "<PredicateList>",
212
+ * // field: "STRING_VALUE",
213
+ * // operator: "STRING_VALUE",
214
+ * // operand: "STRING_VALUE",
215
+ * // operandType: "STRING_VALUE",
216
+ * // },
217
+ * // ],
218
+ * // and: "<PredicateList>",
219
+ * // field: "STRING_VALUE",
220
+ * // operator: "STRING_VALUE",
221
+ * // operand: "STRING_VALUE",
222
+ * // operandType: "STRING_VALUE",
223
+ * // },
224
+ * // ],
225
+ * // userAttribute: "STRING_VALUE",
226
+ * // bucket: "STRING_VALUE",
227
+ * // key: "STRING_VALUE",
228
+ * // defaultValue: "STRING_VALUE",
229
+ * // slotName: "STRING_VALUE",
230
+ * // },
231
+ * // defaultValue: "STRING_VALUE",
232
+ * // },
233
+ * // },
234
+ * // collectionProperties: { // ComponentCollectionProperties
235
+ * // "<keys>": { // ComponentDataConfiguration
236
+ * // model: "STRING_VALUE", // required
237
+ * // sort: [ // SortPropertyList
238
+ * // { // SortProperty
239
+ * // field: "STRING_VALUE", // required
240
+ * // direction: "STRING_VALUE", // required
241
+ * // },
242
+ * // ],
243
+ * // predicate: "<Predicate>",
244
+ * // identifiers: [ // IdentifierList
245
+ * // "STRING_VALUE",
246
+ * // ],
247
+ * // },
248
+ * // },
249
+ * // createdAt: new Date("TIMESTAMP"), // required
250
+ * // modifiedAt: new Date("TIMESTAMP"),
251
+ * // tags: { // Tags
252
+ * // "<keys>": "STRING_VALUE",
253
+ * // },
254
+ * // events: "<ComponentEvents>",
255
+ * // schemaVersion: "STRING_VALUE",
256
+ * // },
257
+ * // ],
258
+ * // nextToken: "STRING_VALUE",
259
+ * // };
260
+ *
36
261
  * ```
37
262
  *
38
263
  * @param ExportComponentsCommandInput - {@link ExportComponentsCommandInput}
@@ -47,6 +272,8 @@ export interface ExportComponentsCommandOutput extends ExportComponentsResponse,
47
272
  * @throws {@link InvalidParameterException} (client fault)
48
273
  * <p>An invalid or out-of-range value was supplied for the input parameter.</p>
49
274
  *
275
+ * @throws {@link AmplifyUIBuilderServiceException}
276
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
50
277
  *
51
278
  */
52
279
  export declare class ExportComponentsCommand extends $Command<ExportComponentsCommandInput, ExportComponentsCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -33,6 +33,169 @@ export interface ExportFormsCommandOutput extends ExportFormsResponse, __Metadat
33
33
  * };
34
34
  * const command = new ExportFormsCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ExportFormsResponse
37
+ * // entities: [ // FormList // required
38
+ * // { // Form
39
+ * // appId: "STRING_VALUE", // required
40
+ * // environmentName: "STRING_VALUE", // required
41
+ * // id: "STRING_VALUE", // required
42
+ * // name: "STRING_VALUE", // required
43
+ * // formActionType: "STRING_VALUE", // required
44
+ * // style: { // FormStyle
45
+ * // horizontalGap: { // FormStyleConfig Union: only one key present
46
+ * // tokenReference: "STRING_VALUE",
47
+ * // value: "STRING_VALUE",
48
+ * // },
49
+ * // verticalGap: {// Union: only one key present
50
+ * // tokenReference: "STRING_VALUE",
51
+ * // value: "STRING_VALUE",
52
+ * // },
53
+ * // outerPadding: {// Union: only one key present
54
+ * // tokenReference: "STRING_VALUE",
55
+ * // value: "STRING_VALUE",
56
+ * // },
57
+ * // },
58
+ * // dataType: { // FormDataTypeConfig
59
+ * // dataSourceType: "STRING_VALUE", // required
60
+ * // dataTypeName: "STRING_VALUE", // required
61
+ * // },
62
+ * // fields: { // FieldsMap // required
63
+ * // "<keys>": { // FieldConfig
64
+ * // label: "STRING_VALUE",
65
+ * // position: { // FieldPosition Union: only one key present
66
+ * // fixed: "STRING_VALUE",
67
+ * // rightOf: "STRING_VALUE",
68
+ * // below: "STRING_VALUE",
69
+ * // },
70
+ * // excluded: true || false,
71
+ * // inputType: { // FieldInputConfig
72
+ * // type: "STRING_VALUE", // required
73
+ * // required: true || false,
74
+ * // readOnly: true || false,
75
+ * // placeholder: "STRING_VALUE",
76
+ * // defaultValue: "STRING_VALUE",
77
+ * // descriptiveText: "STRING_VALUE",
78
+ * // defaultChecked: true || false,
79
+ * // defaultCountryCode: "STRING_VALUE",
80
+ * // valueMappings: { // ValueMappings
81
+ * // values: [ // ValueMappingList // required
82
+ * // { // ValueMapping
83
+ * // displayValue: { // FormInputValueProperty
84
+ * // value: "STRING_VALUE",
85
+ * // bindingProperties: { // FormInputValuePropertyBindingProperties
86
+ * // property: "STRING_VALUE", // required
87
+ * // field: "STRING_VALUE",
88
+ * // },
89
+ * // concat: [ // FormInputValuePropertyList
90
+ * // {
91
+ * // value: "STRING_VALUE",
92
+ * // bindingProperties: {
93
+ * // property: "STRING_VALUE", // required
94
+ * // field: "STRING_VALUE",
95
+ * // },
96
+ * // concat: [
97
+ * // "<FormInputValueProperty>",
98
+ * // ],
99
+ * // },
100
+ * // ],
101
+ * // },
102
+ * // value: "<FormInputValueProperty>", // required
103
+ * // },
104
+ * // ],
105
+ * // bindingProperties: { // FormInputBindingProperties
106
+ * // "<keys>": { // FormInputBindingPropertiesValue
107
+ * // type: "STRING_VALUE",
108
+ * // bindingProperties: { // FormInputBindingPropertiesValueProperties
109
+ * // model: "STRING_VALUE",
110
+ * // },
111
+ * // },
112
+ * // },
113
+ * // },
114
+ * // name: "STRING_VALUE",
115
+ * // minValue: Number("float"),
116
+ * // maxValue: Number("float"),
117
+ * // step: Number("float"),
118
+ * // value: "STRING_VALUE",
119
+ * // isArray: true || false,
120
+ * // fileUploaderConfig: { // FileUploaderFieldConfig
121
+ * // accessLevel: "STRING_VALUE", // required
122
+ * // acceptedFileTypes: [ // StrValues // required
123
+ * // "STRING_VALUE",
124
+ * // ],
125
+ * // showThumbnails: true || false,
126
+ * // isResumable: true || false,
127
+ * // maxFileCount: Number("int"),
128
+ * // maxSize: Number("int"),
129
+ * // },
130
+ * // },
131
+ * // validations: [ // ValidationsList
132
+ * // { // FieldValidationConfiguration
133
+ * // type: "STRING_VALUE", // required
134
+ * // strValues: [
135
+ * // "STRING_VALUE",
136
+ * // ],
137
+ * // numValues: [ // NumValues
138
+ * // Number("int"),
139
+ * // ],
140
+ * // validationMessage: "STRING_VALUE",
141
+ * // },
142
+ * // ],
143
+ * // },
144
+ * // },
145
+ * // sectionalElements: { // SectionalElementMap // required
146
+ * // "<keys>": { // SectionalElement
147
+ * // type: "STRING_VALUE", // required
148
+ * // position: {// Union: only one key present
149
+ * // fixed: "STRING_VALUE",
150
+ * // rightOf: "STRING_VALUE",
151
+ * // below: "STRING_VALUE",
152
+ * // },
153
+ * // text: "STRING_VALUE",
154
+ * // level: Number("int"),
155
+ * // orientation: "STRING_VALUE",
156
+ * // excluded: true || false,
157
+ * // },
158
+ * // },
159
+ * // schemaVersion: "STRING_VALUE", // required
160
+ * // tags: { // Tags
161
+ * // "<keys>": "STRING_VALUE",
162
+ * // },
163
+ * // cta: { // FormCTA
164
+ * // position: "STRING_VALUE",
165
+ * // clear: { // FormButton
166
+ * // excluded: true || false,
167
+ * // children: "STRING_VALUE",
168
+ * // position: {// Union: only one key present
169
+ * // fixed: "STRING_VALUE",
170
+ * // rightOf: "STRING_VALUE",
171
+ * // below: "STRING_VALUE",
172
+ * // },
173
+ * // },
174
+ * // cancel: {
175
+ * // excluded: true || false,
176
+ * // children: "STRING_VALUE",
177
+ * // position: {// Union: only one key present
178
+ * // fixed: "STRING_VALUE",
179
+ * // rightOf: "STRING_VALUE",
180
+ * // below: "STRING_VALUE",
181
+ * // },
182
+ * // },
183
+ * // submit: {
184
+ * // excluded: true || false,
185
+ * // children: "STRING_VALUE",
186
+ * // position: {// Union: only one key present
187
+ * // fixed: "STRING_VALUE",
188
+ * // rightOf: "STRING_VALUE",
189
+ * // below: "STRING_VALUE",
190
+ * // },
191
+ * // },
192
+ * // },
193
+ * // labelDecorator: "STRING_VALUE",
194
+ * // },
195
+ * // ],
196
+ * // nextToken: "STRING_VALUE",
197
+ * // };
198
+ *
36
199
  * ```
37
200
  *
38
201
  * @param ExportFormsCommandInput - {@link ExportFormsCommandInput}
@@ -47,6 +210,8 @@ export interface ExportFormsCommandOutput extends ExportFormsResponse, __Metadat
47
210
  * @throws {@link InvalidParameterException} (client fault)
48
211
  * <p>An invalid or out-of-range value was supplied for the input parameter.</p>
49
212
  *
213
+ * @throws {@link AmplifyUIBuilderServiceException}
214
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
50
215
  *
51
216
  */
52
217
  export declare class ExportFormsCommand extends $Command<ExportFormsCommandInput, ExportFormsCommandOutput, AmplifyUIBuilderClientResolvedConfig> {
@@ -33,6 +33,41 @@ export interface ExportThemesCommandOutput extends ExportThemesResponse, __Metad
33
33
  * };
34
34
  * const command = new ExportThemesCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ExportThemesResponse
37
+ * // entities: [ // ThemeList // required
38
+ * // { // Theme
39
+ * // appId: "STRING_VALUE", // required
40
+ * // environmentName: "STRING_VALUE", // required
41
+ * // id: "STRING_VALUE", // required
42
+ * // name: "STRING_VALUE", // required
43
+ * // createdAt: new Date("TIMESTAMP"), // required
44
+ * // modifiedAt: new Date("TIMESTAMP"),
45
+ * // values: [ // ThemeValuesList // required
46
+ * // { // ThemeValues
47
+ * // key: "STRING_VALUE",
48
+ * // value: { // ThemeValue
49
+ * // value: "STRING_VALUE",
50
+ * // children: [
51
+ * // {
52
+ * // key: "STRING_VALUE",
53
+ * // value: {
54
+ * // value: "STRING_VALUE",
55
+ * // children: "<ThemeValuesList>",
56
+ * // },
57
+ * // },
58
+ * // ],
59
+ * // },
60
+ * // },
61
+ * // ],
62
+ * // overrides: "<ThemeValuesList>",
63
+ * // tags: { // Tags
64
+ * // "<keys>": "STRING_VALUE",
65
+ * // },
66
+ * // },
67
+ * // ],
68
+ * // nextToken: "STRING_VALUE",
69
+ * // };
70
+ *
36
71
  * ```
37
72
  *
38
73
  * @param ExportThemesCommandInput - {@link ExportThemesCommandInput}
@@ -47,6 +82,8 @@ export interface ExportThemesCommandOutput extends ExportThemesResponse, __Metad
47
82
  * @throws {@link InvalidParameterException} (client fault)
48
83
  * <p>An invalid or out-of-range value was supplied for the input parameter.</p>
49
84
  *
85
+ * @throws {@link AmplifyUIBuilderServiceException}
86
+ * <p>Base exception class for all service exceptions from AmplifyUIBuilder service.</p>
50
87
  *
51
88
  */
52
89
  export declare class ExportThemesCommand extends $Command<ExportThemesCommandInput, ExportThemesCommandOutput, AmplifyUIBuilderClientResolvedConfig> {