@aws-sdk/client-amplifyuibuilder 3.299.0 → 3.300.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.
@@ -26,6 +26,131 @@ export interface CreateFormCommandOutput extends CreateFormResponse, __MetadataB
26
26
  * import { AmplifyUIBuilderClient, CreateFormCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, CreateFormCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * clientToken: "STRING_VALUE",
33
+ * formToCreate: {
34
+ * name: "STRING_VALUE", // required
35
+ * dataType: {
36
+ * dataSourceType: "STRING_VALUE", // required
37
+ * dataTypeName: "STRING_VALUE", // required
38
+ * },
39
+ * formActionType: "STRING_VALUE", // required
40
+ * fields: { // required
41
+ * "<keys>": {
42
+ * label: "STRING_VALUE",
43
+ * position: { // Union: only one key present
44
+ * fixed: "STRING_VALUE",
45
+ * rightOf: "STRING_VALUE",
46
+ * below: "STRING_VALUE",
47
+ * },
48
+ * excluded: true || false,
49
+ * inputType: {
50
+ * type: "STRING_VALUE", // required
51
+ * required: true || false,
52
+ * readOnly: true || false,
53
+ * placeholder: "STRING_VALUE",
54
+ * defaultValue: "STRING_VALUE",
55
+ * descriptiveText: "STRING_VALUE",
56
+ * defaultChecked: true || false,
57
+ * defaultCountryCode: "STRING_VALUE",
58
+ * valueMappings: {
59
+ * values: [ // required
60
+ * {
61
+ * displayValue: {
62
+ * value: "STRING_VALUE",
63
+ * },
64
+ * value: {
65
+ * value: "STRING_VALUE",
66
+ * },
67
+ * },
68
+ * ],
69
+ * },
70
+ * name: "STRING_VALUE",
71
+ * minValue: Number("float"),
72
+ * maxValue: Number("float"),
73
+ * step: Number("float"),
74
+ * value: "STRING_VALUE",
75
+ * isArray: true || false,
76
+ * },
77
+ * validations: [
78
+ * {
79
+ * type: "STRING_VALUE", // required
80
+ * strValues: [
81
+ * "STRING_VALUE",
82
+ * ],
83
+ * numValues: [
84
+ * Number("int"),
85
+ * ],
86
+ * validationMessage: "STRING_VALUE",
87
+ * },
88
+ * ],
89
+ * },
90
+ * },
91
+ * style: {
92
+ * horizontalGap: { // Union: only one key present
93
+ * tokenReference: "STRING_VALUE",
94
+ * value: "STRING_VALUE",
95
+ * },
96
+ * verticalGap: { // Union: only one key present
97
+ * tokenReference: "STRING_VALUE",
98
+ * value: "STRING_VALUE",
99
+ * },
100
+ * outerPadding: { // Union: only one key present
101
+ * tokenReference: "STRING_VALUE",
102
+ * value: "STRING_VALUE",
103
+ * },
104
+ * },
105
+ * sectionalElements: { // required
106
+ * "<keys>": {
107
+ * type: "STRING_VALUE", // required
108
+ * position: { // Union: only one key present
109
+ * fixed: "STRING_VALUE",
110
+ * rightOf: "STRING_VALUE",
111
+ * below: "STRING_VALUE",
112
+ * },
113
+ * text: "STRING_VALUE",
114
+ * level: Number("int"),
115
+ * orientation: "STRING_VALUE",
116
+ * },
117
+ * },
118
+ * schemaVersion: "STRING_VALUE", // required
119
+ * cta: {
120
+ * position: "STRING_VALUE",
121
+ * clear: {
122
+ * excluded: true || false,
123
+ * children: "STRING_VALUE",
124
+ * position: { // Union: only one key present
125
+ * fixed: "STRING_VALUE",
126
+ * rightOf: "STRING_VALUE",
127
+ * below: "STRING_VALUE",
128
+ * },
129
+ * },
130
+ * cancel: {
131
+ * excluded: true || false,
132
+ * children: "STRING_VALUE",
133
+ * position: { // Union: only one key present
134
+ * fixed: "STRING_VALUE",
135
+ * rightOf: "STRING_VALUE",
136
+ * below: "STRING_VALUE",
137
+ * },
138
+ * },
139
+ * submit: {
140
+ * excluded: true || false,
141
+ * children: "STRING_VALUE",
142
+ * position: { // Union: only one key present
143
+ * fixed: "STRING_VALUE",
144
+ * rightOf: "STRING_VALUE",
145
+ * below: "STRING_VALUE",
146
+ * },
147
+ * },
148
+ * },
149
+ * tags: {
150
+ * "<keys>": "STRING_VALUE",
151
+ * },
152
+ * },
153
+ * };
29
154
  * const command = new CreateFormCommand(input);
30
155
  * const response = await client.send(command);
31
156
  * ```
@@ -26,6 +26,39 @@ export interface CreateThemeCommandOutput extends CreateThemeResponse, __Metadat
26
26
  * import { AmplifyUIBuilderClient, CreateThemeCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, CreateThemeCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * clientToken: "STRING_VALUE",
33
+ * themeToCreate: {
34
+ * name: "STRING_VALUE", // required
35
+ * values: [ // required
36
+ * {
37
+ * key: "STRING_VALUE",
38
+ * value: {
39
+ * value: "STRING_VALUE",
40
+ * children: [
41
+ * {
42
+ * key: "STRING_VALUE",
43
+ * value: {
44
+ * value: "STRING_VALUE",
45
+ * children: [
46
+ * "<ThemeValuesList>",
47
+ * ],
48
+ * },
49
+ * },
50
+ * ],
51
+ * },
52
+ * },
53
+ * ],
54
+ * overrides: [
55
+ * "<ThemeValuesList>",
56
+ * ],
57
+ * tags: {
58
+ * "<keys>": "STRING_VALUE",
59
+ * },
60
+ * },
61
+ * };
29
62
  * const command = new CreateThemeCommand(input);
30
63
  * const response = await client.send(command);
31
64
  * ```
@@ -26,6 +26,11 @@ export interface DeleteComponentCommandOutput extends __MetadataBearer {
26
26
  * import { AmplifyUIBuilderClient, DeleteComponentCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, DeleteComponentCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteComponentCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface DeleteFormCommandOutput extends __MetadataBearer {
26
26
  * import { AmplifyUIBuilderClient, DeleteFormCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, DeleteFormCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteFormCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface DeleteThemeCommandOutput extends __MetadataBearer {
26
26
  * import { AmplifyUIBuilderClient, DeleteThemeCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, DeleteThemeCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new DeleteThemeCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,13 @@ export interface ExchangeCodeForTokenCommandOutput extends ExchangeCodeForTokenR
26
26
  * import { AmplifyUIBuilderClient, ExchangeCodeForTokenCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, ExchangeCodeForTokenCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * provider: "STRING_VALUE", // required
31
+ * request: {
32
+ * code: "STRING_VALUE", // required
33
+ * redirectUri: "STRING_VALUE", // required
34
+ * },
35
+ * };
29
36
  * const command = new ExchangeCodeForTokenCommand(input);
30
37
  * const response = await client.send(command);
31
38
  * ```
@@ -26,6 +26,11 @@ export interface ExportComponentsCommandOutput extends ExportComponentsResponse,
26
26
  * import { AmplifyUIBuilderClient, ExportComponentsCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, ExportComponentsCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * nextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ExportComponentsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface ExportFormsCommandOutput extends ExportFormsResponse, __Metadat
26
26
  * import { AmplifyUIBuilderClient, ExportFormsCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, ExportFormsCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * nextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ExportFormsCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface ExportThemesCommandOutput extends ExportThemesResponse, __Metad
26
26
  * import { AmplifyUIBuilderClient, ExportThemesCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, ExportThemesCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * nextToken: "STRING_VALUE",
33
+ * };
29
34
  * const command = new ExportThemesCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface GetComponentCommandOutput extends GetComponentResponse, __Metad
26
26
  * import { AmplifyUIBuilderClient, GetComponentCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, GetComponentCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetComponentCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,11 @@ export interface GetFormCommandOutput extends GetFormResponse, __MetadataBearer
26
26
  * import { AmplifyUIBuilderClient, GetFormCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, GetFormCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetFormCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -26,6 +26,10 @@ export interface GetMetadataCommandOutput extends GetMetadataResponse, __Metadat
26
26
  * import { AmplifyUIBuilderClient, GetMetadataCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, GetMetadataCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * };
29
33
  * const command = new GetMetadataCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,11 @@ export interface GetThemeCommandOutput extends GetThemeResponse, __MetadataBeare
26
26
  * import { AmplifyUIBuilderClient, GetThemeCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, GetThemeCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * id: "STRING_VALUE", // required
33
+ * };
29
34
  * const command = new GetThemeCommand(input);
30
35
  * const response = await client.send(command);
31
36
  * ```
@@ -27,6 +27,12 @@ export interface ListComponentsCommandOutput extends ListComponentsResponse, __M
27
27
  * import { AmplifyUIBuilderClient, ListComponentsCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
28
28
  * // const { AmplifyUIBuilderClient, ListComponentsCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
29
29
  * const client = new AmplifyUIBuilderClient(config);
30
+ * const input = {
31
+ * appId: "STRING_VALUE", // required
32
+ * environmentName: "STRING_VALUE", // required
33
+ * nextToken: "STRING_VALUE",
34
+ * maxResults: Number("int"),
35
+ * };
30
36
  * const command = new ListComponentsCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -26,6 +26,12 @@ export interface ListFormsCommandOutput extends ListFormsResponse, __MetadataBea
26
26
  * import { AmplifyUIBuilderClient, ListFormsCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, ListFormsCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * nextToken: "STRING_VALUE",
33
+ * maxResults: Number("int"),
34
+ * };
29
35
  * const command = new ListFormsCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -27,6 +27,12 @@ export interface ListThemesCommandOutput extends ListThemesResponse, __MetadataB
27
27
  * import { AmplifyUIBuilderClient, ListThemesCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
28
28
  * // const { AmplifyUIBuilderClient, ListThemesCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
29
29
  * const client = new AmplifyUIBuilderClient(config);
30
+ * const input = {
31
+ * appId: "STRING_VALUE", // required
32
+ * environmentName: "STRING_VALUE", // required
33
+ * nextToken: "STRING_VALUE",
34
+ * maxResults: Number("int"),
35
+ * };
30
36
  * const command = new ListThemesCommand(input);
31
37
  * const response = await client.send(command);
32
38
  * ```
@@ -26,6 +26,14 @@ export interface PutMetadataFlagCommandOutput extends __MetadataBearer {
26
26
  * import { AmplifyUIBuilderClient, PutMetadataFlagCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, PutMetadataFlagCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * appId: "STRING_VALUE", // required
31
+ * environmentName: "STRING_VALUE", // required
32
+ * featureName: "STRING_VALUE", // required
33
+ * body: {
34
+ * newValue: "STRING_VALUE", // required
35
+ * },
36
+ * };
29
37
  * const command = new PutMetadataFlagCommand(input);
30
38
  * const response = await client.send(command);
31
39
  * ```
@@ -26,6 +26,12 @@ export interface RefreshTokenCommandOutput extends RefreshTokenResponse, __Metad
26
26
  * import { AmplifyUIBuilderClient, RefreshTokenCommand } from "@aws-sdk/client-amplifyuibuilder"; // ES Modules import
27
27
  * // const { AmplifyUIBuilderClient, RefreshTokenCommand } = require("@aws-sdk/client-amplifyuibuilder"); // CommonJS import
28
28
  * const client = new AmplifyUIBuilderClient(config);
29
+ * const input = {
30
+ * provider: "STRING_VALUE", // required
31
+ * refreshTokenBody: {
32
+ * token: "STRING_VALUE", // required
33
+ * },
34
+ * };
29
35
  * const command = new RefreshTokenCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```