@aws-sdk/client-amplifyuibuilder 3.53.0 → 3.55.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.
- package/CHANGELOG.md +27 -0
- package/README.md +8 -9
- package/dist-cjs/AmplifyUIBuilderClient.js +13 -13
- package/dist-cjs/commands/CreateComponentCommand.js +3 -3
- package/dist-cjs/commands/CreateThemeCommand.js +3 -3
- package/dist-cjs/commands/DeleteComponentCommand.js +3 -3
- package/dist-cjs/commands/DeleteThemeCommand.js +3 -3
- package/dist-cjs/commands/ExchangeCodeForTokenCommand.js +3 -3
- package/dist-cjs/commands/ExportComponentsCommand.js +3 -3
- package/dist-cjs/commands/ExportThemesCommand.js +3 -3
- package/dist-cjs/commands/GetComponentCommand.js +3 -3
- package/dist-cjs/commands/GetThemeCommand.js +3 -3
- package/dist-cjs/commands/ListComponentsCommand.js +3 -3
- package/dist-cjs/commands/ListThemesCommand.js +3 -3
- package/dist-cjs/commands/RefreshTokenCommand.js +3 -3
- package/dist-cjs/commands/UpdateComponentCommand.js +3 -3
- package/dist-cjs/commands/UpdateThemeCommand.js +3 -3
- package/dist-cjs/endpoints.js +1 -1
- package/dist-cjs/models/models_0.js +20 -2
- package/dist-cjs/pagination/ExportComponentsPaginator.js +34 -0
- package/dist-cjs/pagination/ExportThemesPaginator.js +34 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +277 -136
- package/dist-cjs/runtimeConfig.browser.js +4 -4
- package/dist-cjs/runtimeConfig.js +9 -9
- package/dist-cjs/runtimeConfig.native.js +1 -1
- package/dist-es/AmplifyUIBuilder.js +14 -14
- package/dist-es/models/models_0.js +12 -0
- package/dist-es/pagination/ExportComponentsPaginator.js +73 -0
- package/dist-es/pagination/ExportThemesPaginator.js +73 -0
- package/dist-es/pagination/ListComponentsPaginator.js +4 -4
- package/dist-es/pagination/ListThemesPaginator.js +4 -4
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +139 -29
- package/dist-types/AmplifyUIBuilder.d.ts +14 -15
- package/dist-types/AmplifyUIBuilderClient.d.ts +10 -11
- package/dist-types/commands/ExportComponentsCommand.d.ts +1 -2
- package/dist-types/commands/ExportThemesCommand.d.ts +1 -2
- package/dist-types/commands/ListComponentsCommand.d.ts +2 -1
- package/dist-types/commands/ListThemesCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +233 -42
- package/dist-types/pagination/ExportComponentsPaginator.d.ts +4 -0
- package/dist-types/pagination/ExportThemesPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +3 -3
- package/dist-types/ts3.4/AmplifyUIBuilderClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +87 -0
- package/dist-types/ts3.4/pagination/ExportComponentsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/ExportThemesPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +3 -3
- package/package.json +34 -34
|
@@ -7,7 +7,8 @@ export interface ListThemesCommandInput extends ListThemesRequest {
|
|
|
7
7
|
export interface ListThemesCommandOutput extends ListThemesResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves a list of themes for a specified Amplify app and backend
|
|
10
|
+
* <p>Retrieves a list of themes for a specified Amplify app and backend
|
|
11
|
+
* environment.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -64,14 +64,16 @@ export declare namespace SortProperty {
|
|
|
64
64
|
*/
|
|
65
65
|
export interface ComponentVariant {
|
|
66
66
|
/**
|
|
67
|
-
* <p>The combination of variants that comprise this variant
|
|
67
|
+
* <p>The combination of variants that comprise this variant. You can't specify
|
|
68
|
+
* <code>tags</code> as a valid property for <code>variantValues</code>.</p>
|
|
68
69
|
*/
|
|
69
70
|
variantValues?: {
|
|
70
71
|
[key: string]: string;
|
|
71
72
|
};
|
|
72
73
|
/**
|
|
73
74
|
* <p>The properties of the component variant that can be overriden when customizing an instance
|
|
74
|
-
* of the component
|
|
75
|
+
* of the component. You can't specify <code>tags</code> as a valid property for
|
|
76
|
+
* <code>overrides</code>.</p>
|
|
75
77
|
*/
|
|
76
78
|
overrides?: {
|
|
77
79
|
[key: string]: {
|
|
@@ -132,11 +134,13 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
132
134
|
}
|
|
133
135
|
export interface DeleteComponentRequest {
|
|
134
136
|
/**
|
|
135
|
-
* <p>The unique ID of the Amplify app associated with the component to
|
|
137
|
+
* <p>The unique ID of the Amplify app associated with the component to
|
|
138
|
+
* delete.</p>
|
|
136
139
|
*/
|
|
137
140
|
appId: string | undefined;
|
|
138
141
|
/**
|
|
139
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
142
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
143
|
+
* app.</p>
|
|
140
144
|
*/
|
|
141
145
|
environmentName: string | undefined;
|
|
142
146
|
/**
|
|
@@ -167,9 +171,14 @@ export interface ExportComponentsRequest {
|
|
|
167
171
|
*/
|
|
168
172
|
appId: string | undefined;
|
|
169
173
|
/**
|
|
170
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
174
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
175
|
+
* app.</p>
|
|
171
176
|
*/
|
|
172
177
|
environmentName: string | undefined;
|
|
178
|
+
/**
|
|
179
|
+
* <p>The token to request the next page of results.</p>
|
|
180
|
+
*/
|
|
181
|
+
nextToken?: string;
|
|
173
182
|
}
|
|
174
183
|
export declare namespace ExportComponentsRequest {
|
|
175
184
|
/**
|
|
@@ -203,7 +212,8 @@ export interface ListComponentsRequest {
|
|
|
203
212
|
*/
|
|
204
213
|
appId: string | undefined;
|
|
205
214
|
/**
|
|
206
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
215
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
216
|
+
* app.</p>
|
|
207
217
|
*/
|
|
208
218
|
environmentName: string | undefined;
|
|
209
219
|
/**
|
|
@@ -231,7 +241,8 @@ export interface ComponentSummary {
|
|
|
231
241
|
*/
|
|
232
242
|
appId: string | undefined;
|
|
233
243
|
/**
|
|
234
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
244
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
245
|
+
* app.</p>
|
|
235
246
|
*/
|
|
236
247
|
environmentName: string | undefined;
|
|
237
248
|
/**
|
|
@@ -381,11 +392,13 @@ export declare namespace RefreshTokenResponse {
|
|
|
381
392
|
}
|
|
382
393
|
export interface DeleteThemeRequest {
|
|
383
394
|
/**
|
|
384
|
-
* <p>The unique ID of the Amplify app associated with the theme to
|
|
395
|
+
* <p>The unique ID of the Amplify app associated with the theme to
|
|
396
|
+
* delete.</p>
|
|
385
397
|
*/
|
|
386
398
|
appId: string | undefined;
|
|
387
399
|
/**
|
|
388
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
400
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
401
|
+
* app.</p>
|
|
389
402
|
*/
|
|
390
403
|
environmentName: string | undefined;
|
|
391
404
|
/**
|
|
@@ -408,6 +421,10 @@ export interface ExportThemesRequest {
|
|
|
408
421
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
409
422
|
*/
|
|
410
423
|
environmentName: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The token to request the next page of results.</p>
|
|
426
|
+
*/
|
|
427
|
+
nextToken?: string;
|
|
411
428
|
}
|
|
412
429
|
export declare namespace ExportThemesRequest {
|
|
413
430
|
/**
|
|
@@ -441,7 +458,8 @@ export interface ListThemesRequest {
|
|
|
441
458
|
*/
|
|
442
459
|
appId: string | undefined;
|
|
443
460
|
/**
|
|
444
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
461
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
462
|
+
* app.</p>
|
|
445
463
|
*/
|
|
446
464
|
environmentName: string | undefined;
|
|
447
465
|
/**
|
|
@@ -541,8 +559,8 @@ export declare namespace ThemeValues {
|
|
|
541
559
|
const filterSensitiveLog: (obj: ThemeValues) => any;
|
|
542
560
|
}
|
|
543
561
|
/**
|
|
544
|
-
* <p>Stores information for generating Amplify DataStore queries. Use a
|
|
545
|
-
*
|
|
562
|
+
* <p>Stores information for generating Amplify DataStore queries. Use a
|
|
563
|
+
* <code>Predicate</code> to retrieve a subset of the data in a collection.</p>
|
|
546
564
|
*/
|
|
547
565
|
export interface Predicate {
|
|
548
566
|
/**
|
|
@@ -645,8 +663,7 @@ export declare namespace ComponentDataConfiguration {
|
|
|
645
663
|
}
|
|
646
664
|
/**
|
|
647
665
|
* <p>Describes the configuration for all of a component's properties. Use
|
|
648
|
-
* <code>ComponentProperty</code> to specify the values to render or bind by
|
|
649
|
-
* default.</p>
|
|
666
|
+
* <code>ComponentProperty</code> to specify the values to render or bind by default.</p>
|
|
650
667
|
*/
|
|
651
668
|
export interface ComponentProperty {
|
|
652
669
|
/**
|
|
@@ -658,7 +675,8 @@ export interface ComponentProperty {
|
|
|
658
675
|
*/
|
|
659
676
|
bindingProperties?: ComponentPropertyBindingProperties;
|
|
660
677
|
/**
|
|
661
|
-
* <p>The information to bind the component property to data at runtime. Use this for collection
|
|
678
|
+
* <p>The information to bind the component property to data at runtime. Use this for collection
|
|
679
|
+
* components.</p>
|
|
662
680
|
*/
|
|
663
681
|
collectionBindingProperties?: ComponentPropertyBindingProperties;
|
|
664
682
|
/**
|
|
@@ -684,15 +702,17 @@ export interface ComponentProperty {
|
|
|
684
702
|
*/
|
|
685
703
|
userAttribute?: string;
|
|
686
704
|
/**
|
|
687
|
-
* <p>A list of component properties to concatenate to create the value to assign to this
|
|
705
|
+
* <p>A list of component properties to concatenate to create the value to assign to this
|
|
706
|
+
* component property.</p>
|
|
688
707
|
*/
|
|
689
708
|
concat?: ComponentProperty[];
|
|
690
709
|
/**
|
|
691
|
-
* <p>The conditional expression to use to assign a value to the component property
|
|
710
|
+
* <p>The conditional expression to use to assign a value to the component property.</p>
|
|
692
711
|
*/
|
|
693
712
|
condition?: ComponentConditionProperty;
|
|
694
713
|
/**
|
|
695
|
-
* <p>Specifies whether the user configured the property in Amplify Studio after
|
|
714
|
+
* <p>Specifies whether the user configured the property in Amplify Studio after
|
|
715
|
+
* importing it.</p>
|
|
696
716
|
*/
|
|
697
717
|
configured?: boolean;
|
|
698
718
|
/**
|
|
@@ -700,9 +720,18 @@ export interface ComponentProperty {
|
|
|
700
720
|
*/
|
|
701
721
|
type?: string;
|
|
702
722
|
/**
|
|
703
|
-
* <p>The default value assigned to property when the component is imported into an
|
|
723
|
+
* <p>The default value assigned to the property when the component is imported into an
|
|
724
|
+
* app.</p>
|
|
704
725
|
*/
|
|
705
726
|
importedValue?: string;
|
|
727
|
+
/**
|
|
728
|
+
* <p>The name of the component that is affected by an event.</p>
|
|
729
|
+
*/
|
|
730
|
+
componentName?: string;
|
|
731
|
+
/**
|
|
732
|
+
* <p>The name of the component's property that is affected by an event.</p>
|
|
733
|
+
*/
|
|
734
|
+
property?: string;
|
|
706
735
|
}
|
|
707
736
|
export declare namespace ComponentProperty {
|
|
708
737
|
/**
|
|
@@ -776,7 +805,8 @@ export interface Theme {
|
|
|
776
805
|
*/
|
|
777
806
|
appId: string | undefined;
|
|
778
807
|
/**
|
|
779
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
808
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
809
|
+
* app.</p>
|
|
780
810
|
*/
|
|
781
811
|
environmentName: string | undefined;
|
|
782
812
|
/**
|
|
@@ -843,6 +873,30 @@ export declare namespace UpdateThemeData {
|
|
|
843
873
|
*/
|
|
844
874
|
const filterSensitiveLog: (obj: UpdateThemeData) => any;
|
|
845
875
|
}
|
|
876
|
+
/**
|
|
877
|
+
* <p>Represents the state configuration when an action modifies a property of another
|
|
878
|
+
* element within the same component.</p>
|
|
879
|
+
*/
|
|
880
|
+
export interface MutationActionSetStateParameter {
|
|
881
|
+
/**
|
|
882
|
+
* <p>The name of the component that is being modified.</p>
|
|
883
|
+
*/
|
|
884
|
+
componentName: string | undefined;
|
|
885
|
+
/**
|
|
886
|
+
* <p>The name of the component property to apply the state configuration to.</p>
|
|
887
|
+
*/
|
|
888
|
+
property: string | undefined;
|
|
889
|
+
/**
|
|
890
|
+
* <p>The state configuration to assign to the property.</p>
|
|
891
|
+
*/
|
|
892
|
+
set: ComponentProperty | undefined;
|
|
893
|
+
}
|
|
894
|
+
export declare namespace MutationActionSetStateParameter {
|
|
895
|
+
/**
|
|
896
|
+
* @internal
|
|
897
|
+
*/
|
|
898
|
+
const filterSensitiveLog: (obj: MutationActionSetStateParameter) => any;
|
|
899
|
+
}
|
|
846
900
|
/**
|
|
847
901
|
* <p>Represents a conditional expression to set a component property. Use
|
|
848
902
|
* <code>ComponentConditionProperty</code> to set a property to different values conditionally,
|
|
@@ -874,6 +928,10 @@ export interface ComponentConditionProperty {
|
|
|
874
928
|
* <p>The value to assign to the property if the condition is not met.</p>
|
|
875
929
|
*/
|
|
876
930
|
else?: ComponentProperty;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The type of the property to evaluate.</p>
|
|
933
|
+
*/
|
|
934
|
+
operandType?: string;
|
|
877
935
|
}
|
|
878
936
|
export declare namespace ComponentConditionProperty {
|
|
879
937
|
/**
|
|
@@ -887,7 +945,8 @@ export interface CreateThemeRequest {
|
|
|
887
945
|
*/
|
|
888
946
|
appId: string | undefined;
|
|
889
947
|
/**
|
|
890
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
948
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
949
|
+
* app.</p>
|
|
891
950
|
*/
|
|
892
951
|
environmentName: string | undefined;
|
|
893
952
|
/**
|
|
@@ -974,6 +1033,10 @@ export interface ExportThemesResponse {
|
|
|
974
1033
|
* <p>Represents the configuration of the exported themes.</p>
|
|
975
1034
|
*/
|
|
976
1035
|
entities: Theme[] | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The pagination token that's included if more results are available.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
nextToken?: string;
|
|
977
1040
|
}
|
|
978
1041
|
export declare namespace ExportThemesResponse {
|
|
979
1042
|
/**
|
|
@@ -981,6 +1044,81 @@ export declare namespace ExportThemesResponse {
|
|
|
981
1044
|
*/
|
|
982
1045
|
const filterSensitiveLog: (obj: ExportThemesResponse) => any;
|
|
983
1046
|
}
|
|
1047
|
+
/**
|
|
1048
|
+
* <p>Represents the event action configuration for an element of a <code>Component</code>
|
|
1049
|
+
* or <code>ComponentChild</code>. Use for the workflow feature in Amplify Studio
|
|
1050
|
+
* that allows you to bind events and actions to components. <code>ActionParameters</code>
|
|
1051
|
+
* defines the action that is performed when an event occurs on the component.</p>
|
|
1052
|
+
*/
|
|
1053
|
+
export interface ActionParameters {
|
|
1054
|
+
/**
|
|
1055
|
+
* <p>The type of navigation action. Valid values are <code>url</code> and <code>anchor</code>. This value is required for a navigation action.</p>
|
|
1056
|
+
*/
|
|
1057
|
+
type?: ComponentProperty;
|
|
1058
|
+
/**
|
|
1059
|
+
* <p>The URL to the location to open. Specify this value for a navigation action.</p>
|
|
1060
|
+
*/
|
|
1061
|
+
url?: ComponentProperty;
|
|
1062
|
+
/**
|
|
1063
|
+
* <p>The HTML anchor link to the location to open. Specify this value for a navigation action.</p>
|
|
1064
|
+
*/
|
|
1065
|
+
anchor?: ComponentProperty;
|
|
1066
|
+
/**
|
|
1067
|
+
* <p>The element within the same component to modify when the action occurs.</p>
|
|
1068
|
+
*/
|
|
1069
|
+
target?: ComponentProperty;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>Specifies whether the user should be signed out globally. Specify this value for an auth sign out action.</p>
|
|
1072
|
+
*/
|
|
1073
|
+
global?: ComponentProperty;
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>The name of the data model. Use when the action performs an operation on an Amplify DataStore
|
|
1076
|
+
* model.</p>
|
|
1077
|
+
*/
|
|
1078
|
+
model?: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* <p>The unique ID of the component that the <code>ActionParameters</code> apply to.</p>
|
|
1081
|
+
*/
|
|
1082
|
+
id?: ComponentProperty;
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model. Use when the action
|
|
1085
|
+
* performs an operation on an Amplify DataStore model.</p>
|
|
1086
|
+
*/
|
|
1087
|
+
fields?: {
|
|
1088
|
+
[key: string]: ComponentProperty;
|
|
1089
|
+
};
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>A key-value pair that specifies the state property name and its initial value.</p>
|
|
1092
|
+
*/
|
|
1093
|
+
state?: MutationActionSetStateParameter;
|
|
1094
|
+
}
|
|
1095
|
+
export declare namespace ActionParameters {
|
|
1096
|
+
/**
|
|
1097
|
+
* @internal
|
|
1098
|
+
*/
|
|
1099
|
+
const filterSensitiveLog: (obj: ActionParameters) => any;
|
|
1100
|
+
}
|
|
1101
|
+
/**
|
|
1102
|
+
* <p>Describes the configuration of an event. You can bind an event and a corresponding
|
|
1103
|
+
* action to a <code>Component</code> or a <code>ComponentChild</code>. A button click
|
|
1104
|
+
* is an example of an event. </p>
|
|
1105
|
+
*/
|
|
1106
|
+
export interface ComponentEvent {
|
|
1107
|
+
/**
|
|
1108
|
+
* <p>The action to perform when a specific event is raised.</p>
|
|
1109
|
+
*/
|
|
1110
|
+
action?: string;
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>Describes information about the action.</p>
|
|
1113
|
+
*/
|
|
1114
|
+
parameters?: ActionParameters;
|
|
1115
|
+
}
|
|
1116
|
+
export declare namespace ComponentEvent {
|
|
1117
|
+
/**
|
|
1118
|
+
* @internal
|
|
1119
|
+
*/
|
|
1120
|
+
const filterSensitiveLog: (obj: ComponentEvent) => any;
|
|
1121
|
+
}
|
|
984
1122
|
/**
|
|
985
1123
|
* <p>A nested UI configuration within a parent <code>Component</code>.</p>
|
|
986
1124
|
*/
|
|
@@ -994,7 +1132,8 @@ export interface ComponentChild {
|
|
|
994
1132
|
*/
|
|
995
1133
|
name: string | undefined;
|
|
996
1134
|
/**
|
|
997
|
-
* <p>Describes the properties of the child component
|
|
1135
|
+
* <p>Describes the properties of the child component. You can't specify <code>tags</code> as a
|
|
1136
|
+
* valid property for <code>properties</code>.</p>
|
|
998
1137
|
*/
|
|
999
1138
|
properties: {
|
|
1000
1139
|
[key: string]: ComponentProperty;
|
|
@@ -1003,6 +1142,13 @@ export interface ComponentChild {
|
|
|
1003
1142
|
* <p>The list of <code>ComponentChild</code> instances for this component.</p>
|
|
1004
1143
|
*/
|
|
1005
1144
|
children?: ComponentChild[];
|
|
1145
|
+
/**
|
|
1146
|
+
* <p>Describes the events that can be raised on the child component. Use for the workflow feature in Amplify Studio that allows you to
|
|
1147
|
+
* bind events and actions to components.</p>
|
|
1148
|
+
*/
|
|
1149
|
+
events?: {
|
|
1150
|
+
[key: string]: ComponentEvent;
|
|
1151
|
+
};
|
|
1006
1152
|
}
|
|
1007
1153
|
export declare namespace ComponentChild {
|
|
1008
1154
|
/**
|
|
@@ -1011,10 +1157,10 @@ export declare namespace ComponentChild {
|
|
|
1011
1157
|
const filterSensitiveLog: (obj: ComponentChild) => any;
|
|
1012
1158
|
}
|
|
1013
1159
|
/**
|
|
1014
|
-
* <p>Contains the configuration settings for a user interface (UI) element for an Amplify app. A
|
|
1015
|
-
*
|
|
1016
|
-
*
|
|
1017
|
-
*
|
|
1160
|
+
* <p>Contains the configuration settings for a user interface (UI) element for an Amplify app. A component is configured as a primary, stand-alone UI element. Use
|
|
1161
|
+
* <code>ComponentChild</code> to configure an instance of a <code>Component</code>. A
|
|
1162
|
+
* <code>ComponentChild</code> instance inherits the configuration of the main
|
|
1163
|
+
* <code>Component</code>.</p>
|
|
1018
1164
|
*/
|
|
1019
1165
|
export interface Component {
|
|
1020
1166
|
/**
|
|
@@ -1022,7 +1168,8 @@ export interface Component {
|
|
|
1022
1168
|
*/
|
|
1023
1169
|
appId: string | undefined;
|
|
1024
1170
|
/**
|
|
1025
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
1171
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
1172
|
+
* app.</p>
|
|
1026
1173
|
*/
|
|
1027
1174
|
environmentName: string | undefined;
|
|
1028
1175
|
/**
|
|
@@ -1038,12 +1185,13 @@ export interface Component {
|
|
|
1038
1185
|
*/
|
|
1039
1186
|
name: string | undefined;
|
|
1040
1187
|
/**
|
|
1041
|
-
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1042
|
-
* component.</p>
|
|
1188
|
+
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1189
|
+
* another custom component.</p>
|
|
1043
1190
|
*/
|
|
1044
1191
|
componentType: string | undefined;
|
|
1045
1192
|
/**
|
|
1046
|
-
* <p>Describes the component's properties
|
|
1193
|
+
* <p>Describes the component's properties. You can't specify <code>tags</code> as a valid
|
|
1194
|
+
* property for <code>properties</code>.</p>
|
|
1047
1195
|
*/
|
|
1048
1196
|
properties: {
|
|
1049
1197
|
[key: string]: ComponentProperty;
|
|
@@ -1053,13 +1201,14 @@ export interface Component {
|
|
|
1053
1201
|
*/
|
|
1054
1202
|
children?: ComponentChild[];
|
|
1055
1203
|
/**
|
|
1056
|
-
* <p>A list of the component's variants. A variant is a unique style configuration of a
|
|
1057
|
-
*
|
|
1204
|
+
* <p>A list of the component's variants. A variant is a unique style configuration of a main
|
|
1205
|
+
* component.</p>
|
|
1058
1206
|
*/
|
|
1059
1207
|
variants: ComponentVariant[] | undefined;
|
|
1060
1208
|
/**
|
|
1061
1209
|
* <p>Describes the component's properties that can be overriden in a customized instance of the
|
|
1062
|
-
* component
|
|
1210
|
+
* component. You can't specify <code>tags</code> as a valid property for
|
|
1211
|
+
* <code>overrides</code>.</p>
|
|
1063
1212
|
*/
|
|
1064
1213
|
overrides: {
|
|
1065
1214
|
[key: string]: {
|
|
@@ -1067,13 +1216,17 @@ export interface Component {
|
|
|
1067
1216
|
};
|
|
1068
1217
|
} | undefined;
|
|
1069
1218
|
/**
|
|
1070
|
-
* <p>The information to connect a component's properties to data at runtime
|
|
1219
|
+
* <p>The information to connect a component's properties to data at runtime. You can't specify
|
|
1220
|
+
* <code>tags</code> as a valid property for <code>bindingProperties</code>.</p>
|
|
1221
|
+
* <p/>
|
|
1071
1222
|
*/
|
|
1072
1223
|
bindingProperties: {
|
|
1073
1224
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1074
1225
|
} | undefined;
|
|
1075
1226
|
/**
|
|
1076
|
-
* <p>The data binding configuration for the component's properties. Use this for a collection
|
|
1227
|
+
* <p>The data binding configuration for the component's properties. Use this for a collection
|
|
1228
|
+
* component. You can't specify <code>tags</code> as a valid property for
|
|
1229
|
+
* <code>collectionProperties</code>.</p>
|
|
1077
1230
|
*/
|
|
1078
1231
|
collectionProperties?: {
|
|
1079
1232
|
[key: string]: ComponentDataConfiguration;
|
|
@@ -1092,6 +1245,17 @@ export interface Component {
|
|
|
1092
1245
|
tags?: {
|
|
1093
1246
|
[key: string]: string;
|
|
1094
1247
|
};
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>Describes the events that can be raised on the component. Use for the workflow feature in Amplify Studio that allows you to
|
|
1250
|
+
* bind events and actions to components.</p>
|
|
1251
|
+
*/
|
|
1252
|
+
events?: {
|
|
1253
|
+
[key: string]: ComponentEvent;
|
|
1254
|
+
};
|
|
1255
|
+
/**
|
|
1256
|
+
* <p>The schema version of the component when it was imported.</p>
|
|
1257
|
+
*/
|
|
1258
|
+
schemaVersion?: string;
|
|
1095
1259
|
}
|
|
1096
1260
|
export declare namespace Component {
|
|
1097
1261
|
/**
|
|
@@ -1112,8 +1276,8 @@ export interface CreateComponentData {
|
|
|
1112
1276
|
*/
|
|
1113
1277
|
sourceId?: string;
|
|
1114
1278
|
/**
|
|
1115
|
-
* <p>The component type. This can be an Amplify custom UI component or another
|
|
1116
|
-
* component.</p>
|
|
1279
|
+
* <p>The component type. This can be an Amplify custom UI component or another
|
|
1280
|
+
* custom component.</p>
|
|
1117
1281
|
*/
|
|
1118
1282
|
componentType: string | undefined;
|
|
1119
1283
|
/**
|
|
@@ -1146,7 +1310,8 @@ export interface CreateComponentData {
|
|
|
1146
1310
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1147
1311
|
} | undefined;
|
|
1148
1312
|
/**
|
|
1149
|
-
* <p>The data binding configuration for customizing a component's properties. Use this for a
|
|
1313
|
+
* <p>The data binding configuration for customizing a component's properties. Use this for a
|
|
1314
|
+
* collection component.</p>
|
|
1150
1315
|
*/
|
|
1151
1316
|
collectionProperties?: {
|
|
1152
1317
|
[key: string]: ComponentDataConfiguration;
|
|
@@ -1157,6 +1322,16 @@ export interface CreateComponentData {
|
|
|
1157
1322
|
tags?: {
|
|
1158
1323
|
[key: string]: string;
|
|
1159
1324
|
};
|
|
1325
|
+
/**
|
|
1326
|
+
* <p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>
|
|
1327
|
+
*/
|
|
1328
|
+
events?: {
|
|
1329
|
+
[key: string]: ComponentEvent;
|
|
1330
|
+
};
|
|
1331
|
+
/**
|
|
1332
|
+
* <p>The schema version of the component when it was imported.</p>
|
|
1333
|
+
*/
|
|
1334
|
+
schemaVersion?: string;
|
|
1160
1335
|
}
|
|
1161
1336
|
export declare namespace CreateComponentData {
|
|
1162
1337
|
/**
|
|
@@ -1181,8 +1356,8 @@ export interface UpdateComponentData {
|
|
|
1181
1356
|
*/
|
|
1182
1357
|
sourceId?: string;
|
|
1183
1358
|
/**
|
|
1184
|
-
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1185
|
-
* component.</p>
|
|
1359
|
+
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1360
|
+
* another custom component.</p>
|
|
1186
1361
|
*/
|
|
1187
1362
|
componentType?: string;
|
|
1188
1363
|
/**
|
|
@@ -1214,11 +1389,22 @@ export interface UpdateComponentData {
|
|
|
1214
1389
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1215
1390
|
};
|
|
1216
1391
|
/**
|
|
1217
|
-
* <p>The configuration for binding a component's properties to a data model. Use this for a
|
|
1392
|
+
* <p>The configuration for binding a component's properties to a data model. Use this for a
|
|
1393
|
+
* collection component.</p>
|
|
1218
1394
|
*/
|
|
1219
1395
|
collectionProperties?: {
|
|
1220
1396
|
[key: string]: ComponentDataConfiguration;
|
|
1221
1397
|
};
|
|
1398
|
+
/**
|
|
1399
|
+
* <p>The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.</p>
|
|
1400
|
+
*/
|
|
1401
|
+
events?: {
|
|
1402
|
+
[key: string]: ComponentEvent;
|
|
1403
|
+
};
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>The schema version of the component when it was imported.</p>
|
|
1406
|
+
*/
|
|
1407
|
+
schemaVersion?: string;
|
|
1222
1408
|
}
|
|
1223
1409
|
export declare namespace UpdateComponentData {
|
|
1224
1410
|
/**
|
|
@@ -1232,7 +1418,8 @@ export interface CreateComponentRequest {
|
|
|
1232
1418
|
*/
|
|
1233
1419
|
appId: string | undefined;
|
|
1234
1420
|
/**
|
|
1235
|
-
* <p>The name of the backend environment that is a part of the Amplify
|
|
1421
|
+
* <p>The name of the backend environment that is a part of the Amplify
|
|
1422
|
+
* app.</p>
|
|
1236
1423
|
*/
|
|
1237
1424
|
environmentName: string | undefined;
|
|
1238
1425
|
/**
|
|
@@ -1319,6 +1506,10 @@ export interface ExportComponentsResponse {
|
|
|
1319
1506
|
* <p>Represents the configuration of the exported components.</p>
|
|
1320
1507
|
*/
|
|
1321
1508
|
entities: Component[] | undefined;
|
|
1509
|
+
/**
|
|
1510
|
+
* <p>The pagination token that's included if more results are available.</p>
|
|
1511
|
+
*/
|
|
1512
|
+
nextToken?: string;
|
|
1322
1513
|
}
|
|
1323
1514
|
export declare namespace ExportComponentsResponse {
|
|
1324
1515
|
/**
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ExportComponentsCommandInput, ExportComponentsCommandOutput } from "../commands/ExportComponentsCommand";
|
|
3
|
+
import { AmplifyUIBuilderPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateExportComponents(config: AmplifyUIBuilderPaginationConfiguration, input: ExportComponentsCommandInput, ...additionalArguments: any): Paginator<ExportComponentsCommandOutput>;
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import { Paginator } from "@aws-sdk/types";
|
|
2
|
+
import { ExportThemesCommandInput, ExportThemesCommandOutput } from "../commands/ExportThemesCommand";
|
|
3
|
+
import { AmplifyUIBuilderPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
export declare function paginateExportThemes(config: AmplifyUIBuilderPaginationConfiguration, input: ExportThemesCommandInput, ...additionalArguments: any): Paginator<ExportThemesCommandOutput>;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: AmplifyUIBuilderClientConfig) =>
|
|
|
8
8
|
defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
10
10
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
13
13
|
defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
|
|
14
14
|
maxAttempts: number | import("@aws-sdk/types").Provider<number>;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: AmplifyUIBuilderClientConfig) =>
|
|
|
8
8
|
defaultsMode: import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
10
10
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
13
13
|
defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
|
|
14
14
|
maxAttempts: number | import("@aws-sdk/types").Provider<number>;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: AmplifyUIBuilderClientConfig) =>
|
|
|
8
8
|
requestHandler: (import("@aws-sdk/types").RequestHandler<any, any, import("@aws-sdk/types").HttpHandlerOptions> & import("@aws-sdk/protocol-http").HttpHandler) | import("@aws-sdk/fetch-http-handler").FetchHttpHandler;
|
|
9
9
|
apiVersion: string;
|
|
10
10
|
urlParser: import("@aws-sdk/types").UrlParser;
|
|
11
|
-
bodyLengthChecker: (
|
|
11
|
+
bodyLengthChecker: import("@aws-sdk/types").BodyLengthCalculator;
|
|
12
12
|
streamCollector: import("@aws-sdk/types").StreamCollector;
|
|
13
13
|
base64Decoder: import("@aws-sdk/types").Decoder;
|
|
14
14
|
base64Encoder: import("@aws-sdk/types").Encoder;
|
|
@@ -21,11 +21,11 @@ export declare const getRuntimeConfig: (config: AmplifyUIBuilderClientConfig) =>
|
|
|
21
21
|
useDualstackEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
22
22
|
useFipsEndpoint: boolean | import("@aws-sdk/types").Provider<boolean>;
|
|
23
23
|
serviceId: string;
|
|
24
|
-
region: string | import("@aws-sdk/types").Provider<
|
|
24
|
+
region: string | import("@aws-sdk/types").Provider<any>;
|
|
25
25
|
credentialDefaultProvider: (input: any) => import("@aws-sdk/types").Provider<import("@aws-sdk/types").Credentials>;
|
|
26
26
|
regionInfoProvider: import("@aws-sdk/types").RegionInfoProvider;
|
|
27
27
|
defaultUserAgentProvider: import("@aws-sdk/types").Provider<import("@aws-sdk/types").UserAgent>;
|
|
28
|
-
defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode
|
|
28
|
+
defaultsMode: import("@aws-sdk/smithy-client").DefaultsMode | import("@aws-sdk/types").Provider<import("@aws-sdk/smithy-client").DefaultsMode>;
|
|
29
29
|
endpoint?: string | import("@aws-sdk/types").Endpoint | import("@aws-sdk/types").Provider<import("@aws-sdk/types").Endpoint> | undefined;
|
|
30
30
|
tls?: boolean | undefined;
|
|
31
31
|
retryStrategy?: import("@aws-sdk/types").RetryStrategy | undefined;
|
|
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
|
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
7
|
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
|
-
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
8
|
+
import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { CreateComponentCommandInput, CreateComponentCommandOutput } from "./commands/CreateComponentCommand";
|
|
10
10
|
import { CreateThemeCommandInput, CreateThemeCommandOutput } from "./commands/CreateThemeCommand";
|
|
11
11
|
import { DeleteComponentCommandInput, DeleteComponentCommandOutput } from "./commands/DeleteComponentCommand";
|
|
@@ -30,7 +30,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
30
30
|
|
|
31
31
|
urlParser?: __UrlParser;
|
|
32
32
|
|
|
33
|
-
bodyLengthChecker?:
|
|
33
|
+
bodyLengthChecker?: __BodyLengthCalculator;
|
|
34
34
|
|
|
35
35
|
streamCollector?: __StreamCollector;
|
|
36
36
|
|