@aws-sdk/client-amplifyuibuilder 3.51.0 → 3.54.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 +30 -0
- package/README.md +8 -9
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/AmplifyUIBuilderServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +86 -1
- 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 +287 -402
- package/dist-es/index.js +1 -0
- package/dist-es/models/AmplifyUIBuilderServiceException.js +12 -0
- package/dist-es/models/models_0.js +74 -1
- package/dist-es/pagination/ExportComponentsPaginator.js +73 -0
- package/dist-es/pagination/ExportThemesPaginator.js +73 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +410 -479
- 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/index.d.ts +1 -0
- package/dist-types/models/AmplifyUIBuilderServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +270 -63
- 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 +1 -1
- package/dist-types/ts3.4/AmplifyUIBuilderClient.d.ts +2 -2
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/AmplifyUIBuilderServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +114 -21
- 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 +1 -1
- package/package.json +33 -33
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { AmplifyUIBuilderServiceException as __BaseException } from "./AmplifyUIBuilderServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>Associates a component property to a binding property. This enables exposed properties on
|
|
4
5
|
* the top level component to propagate data to the component's property values.</p>
|
|
@@ -63,14 +64,16 @@ export declare namespace SortProperty {
|
|
|
63
64
|
*/
|
|
64
65
|
export interface ComponentVariant {
|
|
65
66
|
/**
|
|
66
|
-
* <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>
|
|
67
69
|
*/
|
|
68
70
|
variantValues?: {
|
|
69
71
|
[key: string]: string;
|
|
70
72
|
};
|
|
71
73
|
/**
|
|
72
74
|
* <p>The properties of the component variant that can be overriden when customizing an instance
|
|
73
|
-
* of the component
|
|
75
|
+
* of the component. You can't specify <code>tags</code> as a valid property for
|
|
76
|
+
* <code>overrides</code>.</p>
|
|
74
77
|
*/
|
|
75
78
|
overrides?: {
|
|
76
79
|
[key: string]: {
|
|
@@ -87,43 +90,57 @@ export declare namespace ComponentVariant {
|
|
|
87
90
|
/**
|
|
88
91
|
* <p>An internal error has occurred. Please retry your request.</p>
|
|
89
92
|
*/
|
|
90
|
-
export
|
|
91
|
-
name: "InternalServerException";
|
|
92
|
-
$fault: "server";
|
|
93
|
-
|
|
93
|
+
export declare class InternalServerException extends __BaseException {
|
|
94
|
+
readonly name: "InternalServerException";
|
|
95
|
+
readonly $fault: "server";
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
94
100
|
}
|
|
95
101
|
/**
|
|
96
102
|
* <p>An invalid or out-of-range value was supplied for the input parameter.</p>
|
|
97
103
|
*/
|
|
98
|
-
export
|
|
99
|
-
name: "InvalidParameterException";
|
|
100
|
-
$fault: "client";
|
|
101
|
-
|
|
104
|
+
export declare class InvalidParameterException extends __BaseException {
|
|
105
|
+
readonly name: "InvalidParameterException";
|
|
106
|
+
readonly $fault: "client";
|
|
107
|
+
/**
|
|
108
|
+
* @internal
|
|
109
|
+
*/
|
|
110
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterException, __BaseException>);
|
|
102
111
|
}
|
|
103
112
|
/**
|
|
104
113
|
* <p>The resource specified in the request conflicts with an existing resource.</p>
|
|
105
114
|
*/
|
|
106
|
-
export
|
|
107
|
-
name: "ResourceConflictException";
|
|
108
|
-
$fault: "client";
|
|
109
|
-
|
|
115
|
+
export declare class ResourceConflictException extends __BaseException {
|
|
116
|
+
readonly name: "ResourceConflictException";
|
|
117
|
+
readonly $fault: "client";
|
|
118
|
+
/**
|
|
119
|
+
* @internal
|
|
120
|
+
*/
|
|
121
|
+
constructor(opts: __ExceptionOptionType<ResourceConflictException, __BaseException>);
|
|
110
122
|
}
|
|
111
123
|
/**
|
|
112
124
|
* <p>You exceeded your service quota. Service quotas, also referred to as limits, are the
|
|
113
125
|
* maximum number of service resources or operations for your Amazon Web Services account. </p>
|
|
114
126
|
*/
|
|
115
|
-
export
|
|
116
|
-
name: "ServiceQuotaExceededException";
|
|
117
|
-
$fault: "client";
|
|
118
|
-
|
|
127
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
128
|
+
readonly name: "ServiceQuotaExceededException";
|
|
129
|
+
readonly $fault: "client";
|
|
130
|
+
/**
|
|
131
|
+
* @internal
|
|
132
|
+
*/
|
|
133
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
119
134
|
}
|
|
120
135
|
export interface DeleteComponentRequest {
|
|
121
136
|
/**
|
|
122
|
-
* <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>
|
|
123
139
|
*/
|
|
124
140
|
appId: string | undefined;
|
|
125
141
|
/**
|
|
126
|
-
* <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>
|
|
127
144
|
*/
|
|
128
145
|
environmentName: string | undefined;
|
|
129
146
|
/**
|
|
@@ -140,10 +157,13 @@ export declare namespace DeleteComponentRequest {
|
|
|
140
157
|
/**
|
|
141
158
|
* <p>The requested resource does not exist, or access was denied.</p>
|
|
142
159
|
*/
|
|
143
|
-
export
|
|
144
|
-
name: "ResourceNotFoundException";
|
|
145
|
-
$fault: "client";
|
|
146
|
-
|
|
160
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
161
|
+
readonly name: "ResourceNotFoundException";
|
|
162
|
+
readonly $fault: "client";
|
|
163
|
+
/**
|
|
164
|
+
* @internal
|
|
165
|
+
*/
|
|
166
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
147
167
|
}
|
|
148
168
|
export interface ExportComponentsRequest {
|
|
149
169
|
/**
|
|
@@ -151,9 +171,14 @@ export interface ExportComponentsRequest {
|
|
|
151
171
|
*/
|
|
152
172
|
appId: string | undefined;
|
|
153
173
|
/**
|
|
154
|
-
* <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>
|
|
155
176
|
*/
|
|
156
177
|
environmentName: string | undefined;
|
|
178
|
+
/**
|
|
179
|
+
* <p>The token to request the next page of results.</p>
|
|
180
|
+
*/
|
|
181
|
+
nextToken?: string;
|
|
157
182
|
}
|
|
158
183
|
export declare namespace ExportComponentsRequest {
|
|
159
184
|
/**
|
|
@@ -187,7 +212,8 @@ export interface ListComponentsRequest {
|
|
|
187
212
|
*/
|
|
188
213
|
appId: string | undefined;
|
|
189
214
|
/**
|
|
190
|
-
* <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>
|
|
191
217
|
*/
|
|
192
218
|
environmentName: string | undefined;
|
|
193
219
|
/**
|
|
@@ -215,7 +241,8 @@ export interface ComponentSummary {
|
|
|
215
241
|
*/
|
|
216
242
|
appId: string | undefined;
|
|
217
243
|
/**
|
|
218
|
-
* <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>
|
|
219
246
|
*/
|
|
220
247
|
environmentName: string | undefined;
|
|
221
248
|
/**
|
|
@@ -365,11 +392,13 @@ export declare namespace RefreshTokenResponse {
|
|
|
365
392
|
}
|
|
366
393
|
export interface DeleteThemeRequest {
|
|
367
394
|
/**
|
|
368
|
-
* <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>
|
|
369
397
|
*/
|
|
370
398
|
appId: string | undefined;
|
|
371
399
|
/**
|
|
372
|
-
* <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>
|
|
373
402
|
*/
|
|
374
403
|
environmentName: string | undefined;
|
|
375
404
|
/**
|
|
@@ -392,6 +421,10 @@ export interface ExportThemesRequest {
|
|
|
392
421
|
* <p>The name of the backend environment that is part of the Amplify app.</p>
|
|
393
422
|
*/
|
|
394
423
|
environmentName: string | undefined;
|
|
424
|
+
/**
|
|
425
|
+
* <p>The token to request the next page of results.</p>
|
|
426
|
+
*/
|
|
427
|
+
nextToken?: string;
|
|
395
428
|
}
|
|
396
429
|
export declare namespace ExportThemesRequest {
|
|
397
430
|
/**
|
|
@@ -425,7 +458,8 @@ export interface ListThemesRequest {
|
|
|
425
458
|
*/
|
|
426
459
|
appId: string | undefined;
|
|
427
460
|
/**
|
|
428
|
-
* <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>
|
|
429
463
|
*/
|
|
430
464
|
environmentName: string | undefined;
|
|
431
465
|
/**
|
|
@@ -525,8 +559,8 @@ export declare namespace ThemeValues {
|
|
|
525
559
|
const filterSensitiveLog: (obj: ThemeValues) => any;
|
|
526
560
|
}
|
|
527
561
|
/**
|
|
528
|
-
* <p>Stores information for generating Amplify DataStore queries. Use a
|
|
529
|
-
*
|
|
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>
|
|
530
564
|
*/
|
|
531
565
|
export interface Predicate {
|
|
532
566
|
/**
|
|
@@ -629,8 +663,7 @@ export declare namespace ComponentDataConfiguration {
|
|
|
629
663
|
}
|
|
630
664
|
/**
|
|
631
665
|
* <p>Describes the configuration for all of a component's properties. Use
|
|
632
|
-
* <code>ComponentProperty</code> to specify the values to render or bind by
|
|
633
|
-
* default.</p>
|
|
666
|
+
* <code>ComponentProperty</code> to specify the values to render or bind by default.</p>
|
|
634
667
|
*/
|
|
635
668
|
export interface ComponentProperty {
|
|
636
669
|
/**
|
|
@@ -642,7 +675,8 @@ export interface ComponentProperty {
|
|
|
642
675
|
*/
|
|
643
676
|
bindingProperties?: ComponentPropertyBindingProperties;
|
|
644
677
|
/**
|
|
645
|
-
* <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>
|
|
646
680
|
*/
|
|
647
681
|
collectionBindingProperties?: ComponentPropertyBindingProperties;
|
|
648
682
|
/**
|
|
@@ -668,15 +702,17 @@ export interface ComponentProperty {
|
|
|
668
702
|
*/
|
|
669
703
|
userAttribute?: string;
|
|
670
704
|
/**
|
|
671
|
-
* <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>
|
|
672
707
|
*/
|
|
673
708
|
concat?: ComponentProperty[];
|
|
674
709
|
/**
|
|
675
|
-
* <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>
|
|
676
711
|
*/
|
|
677
712
|
condition?: ComponentConditionProperty;
|
|
678
713
|
/**
|
|
679
|
-
* <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>
|
|
680
716
|
*/
|
|
681
717
|
configured?: boolean;
|
|
682
718
|
/**
|
|
@@ -684,9 +720,18 @@ export interface ComponentProperty {
|
|
|
684
720
|
*/
|
|
685
721
|
type?: string;
|
|
686
722
|
/**
|
|
687
|
-
* <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>
|
|
688
725
|
*/
|
|
689
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;
|
|
690
735
|
}
|
|
691
736
|
export declare namespace ComponentProperty {
|
|
692
737
|
/**
|
|
@@ -760,7 +805,8 @@ export interface Theme {
|
|
|
760
805
|
*/
|
|
761
806
|
appId: string | undefined;
|
|
762
807
|
/**
|
|
763
|
-
* <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>
|
|
764
810
|
*/
|
|
765
811
|
environmentName: string | undefined;
|
|
766
812
|
/**
|
|
@@ -827,6 +873,30 @@ export declare namespace UpdateThemeData {
|
|
|
827
873
|
*/
|
|
828
874
|
const filterSensitiveLog: (obj: UpdateThemeData) => any;
|
|
829
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
|
+
}
|
|
830
900
|
/**
|
|
831
901
|
* <p>Represents a conditional expression to set a component property. Use
|
|
832
902
|
* <code>ComponentConditionProperty</code> to set a property to different values conditionally,
|
|
@@ -858,6 +928,10 @@ export interface ComponentConditionProperty {
|
|
|
858
928
|
* <p>The value to assign to the property if the condition is not met.</p>
|
|
859
929
|
*/
|
|
860
930
|
else?: ComponentProperty;
|
|
931
|
+
/**
|
|
932
|
+
* <p>The type of the property to evaluate.</p>
|
|
933
|
+
*/
|
|
934
|
+
operandType?: string;
|
|
861
935
|
}
|
|
862
936
|
export declare namespace ComponentConditionProperty {
|
|
863
937
|
/**
|
|
@@ -871,7 +945,8 @@ export interface CreateThemeRequest {
|
|
|
871
945
|
*/
|
|
872
946
|
appId: string | undefined;
|
|
873
947
|
/**
|
|
874
|
-
* <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>
|
|
875
950
|
*/
|
|
876
951
|
environmentName: string | undefined;
|
|
877
952
|
/**
|
|
@@ -958,6 +1033,10 @@ export interface ExportThemesResponse {
|
|
|
958
1033
|
* <p>Represents the configuration of the exported themes.</p>
|
|
959
1034
|
*/
|
|
960
1035
|
entities: Theme[] | undefined;
|
|
1036
|
+
/**
|
|
1037
|
+
* <p>The pagination token that's included if more results are available.</p>
|
|
1038
|
+
*/
|
|
1039
|
+
nextToken?: string;
|
|
961
1040
|
}
|
|
962
1041
|
export declare namespace ExportThemesResponse {
|
|
963
1042
|
/**
|
|
@@ -965,6 +1044,81 @@ export declare namespace ExportThemesResponse {
|
|
|
965
1044
|
*/
|
|
966
1045
|
const filterSensitiveLog: (obj: ExportThemesResponse) => any;
|
|
967
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
|
+
}
|
|
968
1122
|
/**
|
|
969
1123
|
* <p>A nested UI configuration within a parent <code>Component</code>.</p>
|
|
970
1124
|
*/
|
|
@@ -978,7 +1132,8 @@ export interface ComponentChild {
|
|
|
978
1132
|
*/
|
|
979
1133
|
name: string | undefined;
|
|
980
1134
|
/**
|
|
981
|
-
* <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>
|
|
982
1137
|
*/
|
|
983
1138
|
properties: {
|
|
984
1139
|
[key: string]: ComponentProperty;
|
|
@@ -987,6 +1142,13 @@ export interface ComponentChild {
|
|
|
987
1142
|
* <p>The list of <code>ComponentChild</code> instances for this component.</p>
|
|
988
1143
|
*/
|
|
989
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
|
+
};
|
|
990
1152
|
}
|
|
991
1153
|
export declare namespace ComponentChild {
|
|
992
1154
|
/**
|
|
@@ -995,10 +1157,10 @@ export declare namespace ComponentChild {
|
|
|
995
1157
|
const filterSensitiveLog: (obj: ComponentChild) => any;
|
|
996
1158
|
}
|
|
997
1159
|
/**
|
|
998
|
-
* <p>Contains the configuration settings for a user interface (UI) element for an Amplify app. A
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
1001
|
-
*
|
|
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>
|
|
1002
1164
|
*/
|
|
1003
1165
|
export interface Component {
|
|
1004
1166
|
/**
|
|
@@ -1006,7 +1168,8 @@ export interface Component {
|
|
|
1006
1168
|
*/
|
|
1007
1169
|
appId: string | undefined;
|
|
1008
1170
|
/**
|
|
1009
|
-
* <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>
|
|
1010
1173
|
*/
|
|
1011
1174
|
environmentName: string | undefined;
|
|
1012
1175
|
/**
|
|
@@ -1022,12 +1185,13 @@ export interface Component {
|
|
|
1022
1185
|
*/
|
|
1023
1186
|
name: string | undefined;
|
|
1024
1187
|
/**
|
|
1025
|
-
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1026
|
-
* component.</p>
|
|
1188
|
+
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1189
|
+
* another custom component.</p>
|
|
1027
1190
|
*/
|
|
1028
1191
|
componentType: string | undefined;
|
|
1029
1192
|
/**
|
|
1030
|
-
* <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>
|
|
1031
1195
|
*/
|
|
1032
1196
|
properties: {
|
|
1033
1197
|
[key: string]: ComponentProperty;
|
|
@@ -1037,13 +1201,14 @@ export interface Component {
|
|
|
1037
1201
|
*/
|
|
1038
1202
|
children?: ComponentChild[];
|
|
1039
1203
|
/**
|
|
1040
|
-
* <p>A list of the component's variants. A variant is a unique style configuration of a
|
|
1041
|
-
*
|
|
1204
|
+
* <p>A list of the component's variants. A variant is a unique style configuration of a main
|
|
1205
|
+
* component.</p>
|
|
1042
1206
|
*/
|
|
1043
1207
|
variants: ComponentVariant[] | undefined;
|
|
1044
1208
|
/**
|
|
1045
1209
|
* <p>Describes the component's properties that can be overriden in a customized instance of the
|
|
1046
|
-
* component
|
|
1210
|
+
* component. You can't specify <code>tags</code> as a valid property for
|
|
1211
|
+
* <code>overrides</code>.</p>
|
|
1047
1212
|
*/
|
|
1048
1213
|
overrides: {
|
|
1049
1214
|
[key: string]: {
|
|
@@ -1051,13 +1216,17 @@ export interface Component {
|
|
|
1051
1216
|
};
|
|
1052
1217
|
} | undefined;
|
|
1053
1218
|
/**
|
|
1054
|
-
* <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/>
|
|
1055
1222
|
*/
|
|
1056
1223
|
bindingProperties: {
|
|
1057
1224
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1058
1225
|
} | undefined;
|
|
1059
1226
|
/**
|
|
1060
|
-
* <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>
|
|
1061
1230
|
*/
|
|
1062
1231
|
collectionProperties?: {
|
|
1063
1232
|
[key: string]: ComponentDataConfiguration;
|
|
@@ -1076,6 +1245,17 @@ export interface Component {
|
|
|
1076
1245
|
tags?: {
|
|
1077
1246
|
[key: string]: string;
|
|
1078
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;
|
|
1079
1259
|
}
|
|
1080
1260
|
export declare namespace Component {
|
|
1081
1261
|
/**
|
|
@@ -1096,8 +1276,8 @@ export interface CreateComponentData {
|
|
|
1096
1276
|
*/
|
|
1097
1277
|
sourceId?: string;
|
|
1098
1278
|
/**
|
|
1099
|
-
* <p>The component type. This can be an Amplify custom UI component or another
|
|
1100
|
-
* component.</p>
|
|
1279
|
+
* <p>The component type. This can be an Amplify custom UI component or another
|
|
1280
|
+
* custom component.</p>
|
|
1101
1281
|
*/
|
|
1102
1282
|
componentType: string | undefined;
|
|
1103
1283
|
/**
|
|
@@ -1130,7 +1310,8 @@ export interface CreateComponentData {
|
|
|
1130
1310
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1131
1311
|
} | undefined;
|
|
1132
1312
|
/**
|
|
1133
|
-
* <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>
|
|
1134
1315
|
*/
|
|
1135
1316
|
collectionProperties?: {
|
|
1136
1317
|
[key: string]: ComponentDataConfiguration;
|
|
@@ -1141,6 +1322,16 @@ export interface CreateComponentData {
|
|
|
1141
1322
|
tags?: {
|
|
1142
1323
|
[key: string]: string;
|
|
1143
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;
|
|
1144
1335
|
}
|
|
1145
1336
|
export declare namespace CreateComponentData {
|
|
1146
1337
|
/**
|
|
@@ -1165,8 +1356,8 @@ export interface UpdateComponentData {
|
|
|
1165
1356
|
*/
|
|
1166
1357
|
sourceId?: string;
|
|
1167
1358
|
/**
|
|
1168
|
-
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1169
|
-
* component.</p>
|
|
1359
|
+
* <p>The type of the component. This can be an Amplify custom UI component or
|
|
1360
|
+
* another custom component.</p>
|
|
1170
1361
|
*/
|
|
1171
1362
|
componentType?: string;
|
|
1172
1363
|
/**
|
|
@@ -1198,11 +1389,22 @@ export interface UpdateComponentData {
|
|
|
1198
1389
|
[key: string]: ComponentBindingPropertiesValue;
|
|
1199
1390
|
};
|
|
1200
1391
|
/**
|
|
1201
|
-
* <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>
|
|
1202
1394
|
*/
|
|
1203
1395
|
collectionProperties?: {
|
|
1204
1396
|
[key: string]: ComponentDataConfiguration;
|
|
1205
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;
|
|
1206
1408
|
}
|
|
1207
1409
|
export declare namespace UpdateComponentData {
|
|
1208
1410
|
/**
|
|
@@ -1216,7 +1418,8 @@ export interface CreateComponentRequest {
|
|
|
1216
1418
|
*/
|
|
1217
1419
|
appId: string | undefined;
|
|
1218
1420
|
/**
|
|
1219
|
-
* <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>
|
|
1220
1423
|
*/
|
|
1221
1424
|
environmentName: string | undefined;
|
|
1222
1425
|
/**
|
|
@@ -1303,6 +1506,10 @@ export interface ExportComponentsResponse {
|
|
|
1303
1506
|
* <p>Represents the configuration of the exported components.</p>
|
|
1304
1507
|
*/
|
|
1305
1508
|
entities: Component[] | undefined;
|
|
1509
|
+
/**
|
|
1510
|
+
* <p>The pagination token that's included if more results are available.</p>
|
|
1511
|
+
*/
|
|
1512
|
+
nextToken?: string;
|
|
1306
1513
|
}
|
|
1307
1514
|
export declare namespace ExportComponentsResponse {
|
|
1308
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;
|