@aws-sdk/client-appflow 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.
Files changed (24) hide show
  1. package/dist-types/commands/CreateConnectorProfileCommand.d.ts +244 -0
  2. package/dist-types/commands/CreateFlowCommand.d.ts +287 -0
  3. package/dist-types/commands/DeleteConnectorProfileCommand.d.ts +4 -0
  4. package/dist-types/commands/DeleteFlowCommand.d.ts +4 -0
  5. package/dist-types/commands/DescribeConnectorCommand.d.ts +4 -0
  6. package/dist-types/commands/DescribeConnectorEntityCommand.d.ts +6 -0
  7. package/dist-types/commands/DescribeConnectorProfilesCommand.d.ts +9 -0
  8. package/dist-types/commands/DescribeConnectorsCommand.d.ts +7 -0
  9. package/dist-types/commands/DescribeFlowCommand.d.ts +3 -0
  10. package/dist-types/commands/DescribeFlowExecutionRecordsCommand.d.ts +5 -0
  11. package/dist-types/commands/ListConnectorEntitiesCommand.d.ts +8 -0
  12. package/dist-types/commands/ListConnectorsCommand.d.ts +4 -0
  13. package/dist-types/commands/ListFlowsCommand.d.ts +4 -0
  14. package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -0
  15. package/dist-types/commands/RegisterConnectorCommand.d.ts +10 -0
  16. package/dist-types/commands/StartFlowCommand.d.ts +3 -0
  17. package/dist-types/commands/StopFlowCommand.d.ts +3 -0
  18. package/dist-types/commands/TagResourceCommand.d.ts +6 -0
  19. package/dist-types/commands/UnregisterConnectorCommand.d.ts +4 -0
  20. package/dist-types/commands/UntagResourceCommand.d.ts +6 -0
  21. package/dist-types/commands/UpdateConnectorProfileCommand.d.ts +241 -0
  22. package/dist-types/commands/UpdateConnectorRegistrationCommand.d.ts +9 -0
  23. package/dist-types/commands/UpdateFlowCommand.d.ts +283 -0
  24. package/package.json +8 -8
@@ -29,6 +29,14 @@ export interface ListConnectorEntitiesCommandOutput extends ListConnectorEntitie
29
29
  * import { AppflowClient, ListConnectorEntitiesCommand } from "@aws-sdk/client-appflow"; // ES Modules import
30
30
  * // const { AppflowClient, ListConnectorEntitiesCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
31
31
  * const client = new AppflowClient(config);
32
+ * const input = {
33
+ * connectorProfileName: "STRING_VALUE",
34
+ * connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
35
+ * entitiesPath: "STRING_VALUE",
36
+ * apiVersion: "STRING_VALUE",
37
+ * maxResults: Number("int"),
38
+ * nextToken: "STRING_VALUE",
39
+ * };
32
40
  * const command = new ListConnectorEntitiesCommand(input);
33
41
  * const response = await client.send(command);
34
42
  * ```
@@ -28,6 +28,10 @@ export interface ListConnectorsCommandOutput extends ListConnectorsResponse, __M
28
28
  * import { AppflowClient, ListConnectorsCommand } from "@aws-sdk/client-appflow"; // ES Modules import
29
29
  * // const { AppflowClient, ListConnectorsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
30
30
  * const client = new AppflowClient(config);
31
+ * const input = {
32
+ * maxResults: Number("int"),
33
+ * nextToken: "STRING_VALUE",
34
+ * };
31
35
  * const command = new ListConnectorsCommand(input);
32
36
  * const response = await client.send(command);
33
37
  * ```
@@ -26,6 +26,10 @@ export interface ListFlowsCommandOutput extends ListFlowsResponse, __MetadataBea
26
26
  * import { AppflowClient, ListFlowsCommand } from "@aws-sdk/client-appflow"; // ES Modules import
27
27
  * // const { AppflowClient, ListFlowsCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
28
28
  * const client = new AppflowClient(config);
29
+ * const input = {
30
+ * maxResults: Number("int"),
31
+ * nextToken: "STRING_VALUE",
32
+ * };
29
33
  * const command = new ListFlowsCommand(input);
30
34
  * const response = await client.send(command);
31
35
  * ```
@@ -26,6 +26,9 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
26
26
  * import { AppflowClient, ListTagsForResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import
27
27
  * // const { AppflowClient, ListTagsForResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
28
28
  * const client = new AppflowClient(config);
29
+ * const input = {
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * };
29
32
  * const command = new ListTagsForResourceCommand(input);
30
33
  * const response = await client.send(command);
31
34
  * ```
@@ -28,6 +28,16 @@ export interface RegisterConnectorCommandOutput extends RegisterConnectorRespons
28
28
  * import { AppflowClient, RegisterConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import
29
29
  * // const { AppflowClient, RegisterConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
30
30
  * const client = new AppflowClient(config);
31
+ * const input = {
32
+ * connectorLabel: "STRING_VALUE",
33
+ * description: "STRING_VALUE",
34
+ * connectorProvisioningType: "LAMBDA",
35
+ * connectorProvisioningConfig: {
36
+ * lambda: {
37
+ * lambdaArn: "STRING_VALUE", // required
38
+ * },
39
+ * },
40
+ * };
31
41
  * const command = new RegisterConnectorCommand(input);
32
42
  * const response = await client.send(command);
33
43
  * ```
@@ -27,6 +27,9 @@ export interface StartFlowCommandOutput extends StartFlowResponse, __MetadataBea
27
27
  * import { AppflowClient, StartFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import
28
28
  * // const { AppflowClient, StartFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
29
29
  * const client = new AppflowClient(config);
30
+ * const input = {
31
+ * flowName: "STRING_VALUE", // required
32
+ * };
30
33
  * const command = new StartFlowCommand(input);
31
34
  * const response = await client.send(command);
32
35
  * ```
@@ -28,6 +28,9 @@ export interface StopFlowCommandOutput extends StopFlowResponse, __MetadataBeare
28
28
  * import { AppflowClient, StopFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import
29
29
  * // const { AppflowClient, StopFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
30
30
  * const client = new AppflowClient(config);
31
+ * const input = {
32
+ * flowName: "STRING_VALUE", // required
33
+ * };
31
34
  * const command = new StopFlowCommand(input);
32
35
  * const response = await client.send(command);
33
36
  * ```
@@ -26,6 +26,12 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
26
26
  * import { AppflowClient, TagResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import
27
27
  * // const { AppflowClient, TagResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
28
28
  * const client = new AppflowClient(config);
29
+ * const input = {
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * tags: { // required
32
+ * "<keys>": "STRING_VALUE",
33
+ * },
34
+ * };
29
35
  * const command = new TagResourceCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -27,6 +27,10 @@ export interface UnregisterConnectorCommandOutput extends UnregisterConnectorRes
27
27
  * import { AppflowClient, UnregisterConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import
28
28
  * // const { AppflowClient, UnregisterConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
29
29
  * const client = new AppflowClient(config);
30
+ * const input = {
31
+ * connectorLabel: "STRING_VALUE", // required
32
+ * forceDelete: true || false,
33
+ * };
30
34
  * const command = new UnregisterConnectorCommand(input);
31
35
  * const response = await client.send(command);
32
36
  * ```
@@ -26,6 +26,12 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
26
26
  * import { AppflowClient, UntagResourceCommand } from "@aws-sdk/client-appflow"; // ES Modules import
27
27
  * // const { AppflowClient, UntagResourceCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
28
28
  * const client = new AppflowClient(config);
29
+ * const input = {
30
+ * resourceArn: "STRING_VALUE", // required
31
+ * tagKeys: [ // required
32
+ * "STRING_VALUE",
33
+ * ],
34
+ * };
29
35
  * const command = new UntagResourceCommand(input);
30
36
  * const response = await client.send(command);
31
37
  * ```
@@ -26,6 +26,247 @@ export interface UpdateConnectorProfileCommandOutput extends UpdateConnectorProf
26
26
  * import { AppflowClient, UpdateConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import
27
27
  * // const { AppflowClient, UpdateConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
28
28
  * const client = new AppflowClient(config);
29
+ * const input = {
30
+ * connectorProfileName: "STRING_VALUE", // required
31
+ * connectionMode: "Public" || "Private", // required
32
+ * connectorProfileConfig: {
33
+ * connectorProfileProperties: {
34
+ * Amplitude: {},
35
+ * Datadog: {
36
+ * instanceUrl: "STRING_VALUE", // required
37
+ * },
38
+ * Dynatrace: {
39
+ * instanceUrl: "STRING_VALUE", // required
40
+ * },
41
+ * GoogleAnalytics: {},
42
+ * Honeycode: {},
43
+ * InforNexus: {
44
+ * instanceUrl: "STRING_VALUE", // required
45
+ * },
46
+ * Marketo: {
47
+ * instanceUrl: "STRING_VALUE", // required
48
+ * },
49
+ * Redshift: {
50
+ * databaseUrl: "STRING_VALUE",
51
+ * bucketName: "STRING_VALUE", // required
52
+ * bucketPrefix: "STRING_VALUE",
53
+ * roleArn: "STRING_VALUE", // required
54
+ * dataApiRoleArn: "STRING_VALUE",
55
+ * isRedshiftServerless: true || false,
56
+ * clusterIdentifier: "STRING_VALUE",
57
+ * workgroupName: "STRING_VALUE",
58
+ * databaseName: "STRING_VALUE",
59
+ * },
60
+ * Salesforce: {
61
+ * instanceUrl: "STRING_VALUE",
62
+ * isSandboxEnvironment: true || false,
63
+ * usePrivateLinkForMetadataAndAuthorization: true || false,
64
+ * },
65
+ * ServiceNow: {
66
+ * instanceUrl: "STRING_VALUE", // required
67
+ * },
68
+ * Singular: {},
69
+ * Slack: {
70
+ * instanceUrl: "STRING_VALUE", // required
71
+ * },
72
+ * Snowflake: {
73
+ * warehouse: "STRING_VALUE", // required
74
+ * stage: "STRING_VALUE", // required
75
+ * bucketName: "STRING_VALUE", // required
76
+ * bucketPrefix: "STRING_VALUE",
77
+ * privateLinkServiceName: "STRING_VALUE",
78
+ * accountName: "STRING_VALUE",
79
+ * region: "STRING_VALUE",
80
+ * },
81
+ * Trendmicro: {},
82
+ * Veeva: {
83
+ * instanceUrl: "STRING_VALUE", // required
84
+ * },
85
+ * Zendesk: {
86
+ * instanceUrl: "STRING_VALUE", // required
87
+ * },
88
+ * SAPOData: {
89
+ * applicationHostUrl: "STRING_VALUE", // required
90
+ * applicationServicePath: "STRING_VALUE", // required
91
+ * portNumber: Number("int"), // required
92
+ * clientNumber: "STRING_VALUE", // required
93
+ * logonLanguage: "STRING_VALUE",
94
+ * privateLinkServiceName: "STRING_VALUE",
95
+ * oAuthProperties: {
96
+ * tokenUrl: "STRING_VALUE", // required
97
+ * authCodeUrl: "STRING_VALUE", // required
98
+ * oAuthScopes: [ // required
99
+ * "STRING_VALUE",
100
+ * ],
101
+ * },
102
+ * },
103
+ * CustomConnector: {
104
+ * profileProperties: {
105
+ * "<keys>": "STRING_VALUE",
106
+ * },
107
+ * oAuth2Properties: {
108
+ * tokenUrl: "STRING_VALUE", // required
109
+ * oAuth2GrantType: "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE", // required
110
+ * tokenUrlCustomProperties: {
111
+ * "<keys>": "STRING_VALUE",
112
+ * },
113
+ * },
114
+ * },
115
+ * Pardot: {
116
+ * instanceUrl: "STRING_VALUE",
117
+ * isSandboxEnvironment: true || false,
118
+ * businessUnitId: "STRING_VALUE",
119
+ * },
120
+ * },
121
+ * connectorProfileCredentials: {
122
+ * Amplitude: {
123
+ * apiKey: "STRING_VALUE", // required
124
+ * secretKey: "STRING_VALUE", // required
125
+ * },
126
+ * Datadog: {
127
+ * apiKey: "STRING_VALUE", // required
128
+ * applicationKey: "STRING_VALUE", // required
129
+ * },
130
+ * Dynatrace: {
131
+ * apiToken: "STRING_VALUE", // required
132
+ * },
133
+ * GoogleAnalytics: {
134
+ * clientId: "STRING_VALUE", // required
135
+ * clientSecret: "STRING_VALUE", // required
136
+ * accessToken: "STRING_VALUE",
137
+ * refreshToken: "STRING_VALUE",
138
+ * oAuthRequest: {
139
+ * authCode: "STRING_VALUE",
140
+ * redirectUri: "STRING_VALUE",
141
+ * },
142
+ * },
143
+ * Honeycode: {
144
+ * accessToken: "STRING_VALUE",
145
+ * refreshToken: "STRING_VALUE",
146
+ * oAuthRequest: {
147
+ * authCode: "STRING_VALUE",
148
+ * redirectUri: "STRING_VALUE",
149
+ * },
150
+ * },
151
+ * InforNexus: {
152
+ * accessKeyId: "STRING_VALUE", // required
153
+ * userId: "STRING_VALUE", // required
154
+ * secretAccessKey: "STRING_VALUE", // required
155
+ * datakey: "STRING_VALUE", // required
156
+ * },
157
+ * Marketo: {
158
+ * clientId: "STRING_VALUE", // required
159
+ * clientSecret: "STRING_VALUE", // required
160
+ * accessToken: "STRING_VALUE",
161
+ * oAuthRequest: {
162
+ * authCode: "STRING_VALUE",
163
+ * redirectUri: "STRING_VALUE",
164
+ * },
165
+ * },
166
+ * Redshift: {
167
+ * username: "STRING_VALUE",
168
+ * password: "STRING_VALUE",
169
+ * },
170
+ * Salesforce: {
171
+ * accessToken: "STRING_VALUE",
172
+ * refreshToken: "STRING_VALUE",
173
+ * oAuthRequest: {
174
+ * authCode: "STRING_VALUE",
175
+ * redirectUri: "STRING_VALUE",
176
+ * },
177
+ * clientCredentialsArn: "STRING_VALUE",
178
+ * },
179
+ * ServiceNow: {
180
+ * username: "STRING_VALUE", // required
181
+ * password: "STRING_VALUE", // required
182
+ * },
183
+ * Singular: {
184
+ * apiKey: "STRING_VALUE", // required
185
+ * },
186
+ * Slack: {
187
+ * clientId: "STRING_VALUE", // required
188
+ * clientSecret: "STRING_VALUE", // required
189
+ * accessToken: "STRING_VALUE",
190
+ * oAuthRequest: {
191
+ * authCode: "STRING_VALUE",
192
+ * redirectUri: "STRING_VALUE",
193
+ * },
194
+ * },
195
+ * Snowflake: {
196
+ * username: "STRING_VALUE", // required
197
+ * password: "STRING_VALUE", // required
198
+ * },
199
+ * Trendmicro: {
200
+ * apiSecretKey: "STRING_VALUE", // required
201
+ * },
202
+ * Veeva: {
203
+ * username: "STRING_VALUE", // required
204
+ * password: "STRING_VALUE", // required
205
+ * },
206
+ * Zendesk: {
207
+ * clientId: "STRING_VALUE", // required
208
+ * clientSecret: "STRING_VALUE", // required
209
+ * accessToken: "STRING_VALUE",
210
+ * oAuthRequest: {
211
+ * authCode: "STRING_VALUE",
212
+ * redirectUri: "STRING_VALUE",
213
+ * },
214
+ * },
215
+ * SAPOData: {
216
+ * basicAuthCredentials: {
217
+ * username: "STRING_VALUE", // required
218
+ * password: "STRING_VALUE", // required
219
+ * },
220
+ * oAuthCredentials: {
221
+ * clientId: "STRING_VALUE", // required
222
+ * clientSecret: "STRING_VALUE", // required
223
+ * accessToken: "STRING_VALUE",
224
+ * refreshToken: "STRING_VALUE",
225
+ * oAuthRequest: {
226
+ * authCode: "STRING_VALUE",
227
+ * redirectUri: "STRING_VALUE",
228
+ * },
229
+ * },
230
+ * },
231
+ * CustomConnector: {
232
+ * authenticationType: "OAUTH2" || "APIKEY" || "BASIC" || "CUSTOM", // required
233
+ * basic: {
234
+ * username: "STRING_VALUE", // required
235
+ * password: "STRING_VALUE", // required
236
+ * },
237
+ * oauth2: {
238
+ * clientId: "STRING_VALUE",
239
+ * clientSecret: "STRING_VALUE",
240
+ * accessToken: "STRING_VALUE",
241
+ * refreshToken: "STRING_VALUE",
242
+ * oAuthRequest: {
243
+ * authCode: "STRING_VALUE",
244
+ * redirectUri: "STRING_VALUE",
245
+ * },
246
+ * },
247
+ * apiKey: {
248
+ * apiKey: "STRING_VALUE", // required
249
+ * apiSecretKey: "STRING_VALUE",
250
+ * },
251
+ * custom: {
252
+ * customAuthenticationType: "STRING_VALUE", // required
253
+ * credentialsMap: {
254
+ * "<keys>": "STRING_VALUE",
255
+ * },
256
+ * },
257
+ * },
258
+ * Pardot: {
259
+ * accessToken: "STRING_VALUE",
260
+ * refreshToken: "STRING_VALUE",
261
+ * oAuthRequest: {
262
+ * authCode: "STRING_VALUE",
263
+ * redirectUri: "STRING_VALUE",
264
+ * },
265
+ * clientCredentialsArn: "STRING_VALUE",
266
+ * },
267
+ * },
268
+ * },
269
+ * };
29
270
  * const command = new UpdateConnectorProfileCommand(input);
30
271
  * const response = await client.send(command);
31
272
  * ```
@@ -35,6 +35,15 @@ export interface UpdateConnectorRegistrationCommandOutput extends UpdateConnecto
35
35
  * import { AppflowClient, UpdateConnectorRegistrationCommand } from "@aws-sdk/client-appflow"; // ES Modules import
36
36
  * // const { AppflowClient, UpdateConnectorRegistrationCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
37
37
  * const client = new AppflowClient(config);
38
+ * const input = {
39
+ * connectorLabel: "STRING_VALUE", // required
40
+ * description: "STRING_VALUE",
41
+ * connectorProvisioningConfig: {
42
+ * lambda: {
43
+ * lambdaArn: "STRING_VALUE", // required
44
+ * },
45
+ * },
46
+ * };
38
47
  * const command = new UpdateConnectorRegistrationCommand(input);
39
48
  * const response = await client.send(command);
40
49
  * ```