@aws-sdk/client-appflow 3.35.0 → 3.36.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 (176) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist-cjs/Appflow.js +0 -1
  3. package/dist-cjs/AppflowClient.js +0 -1
  4. package/dist-cjs/commands/CreateConnectorProfileCommand.js +0 -1
  5. package/dist-cjs/commands/CreateFlowCommand.js +0 -1
  6. package/dist-cjs/commands/DeleteConnectorProfileCommand.js +0 -1
  7. package/dist-cjs/commands/DeleteFlowCommand.js +0 -1
  8. package/dist-cjs/commands/DescribeConnectorEntityCommand.js +0 -1
  9. package/dist-cjs/commands/DescribeConnectorProfilesCommand.js +0 -1
  10. package/dist-cjs/commands/DescribeConnectorsCommand.js +0 -1
  11. package/dist-cjs/commands/DescribeFlowCommand.js +0 -1
  12. package/dist-cjs/commands/DescribeFlowExecutionRecordsCommand.js +0 -1
  13. package/dist-cjs/commands/ListConnectorEntitiesCommand.js +0 -1
  14. package/dist-cjs/commands/ListFlowsCommand.js +0 -1
  15. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -1
  16. package/dist-cjs/commands/StartFlowCommand.js +0 -1
  17. package/dist-cjs/commands/StopFlowCommand.js +0 -1
  18. package/dist-cjs/commands/TagResourceCommand.js +0 -1
  19. package/dist-cjs/commands/UntagResourceCommand.js +0 -1
  20. package/dist-cjs/commands/UpdateConnectorProfileCommand.js +0 -1
  21. package/dist-cjs/commands/UpdateFlowCommand.js +0 -1
  22. package/dist-cjs/endpoints.js +0 -1
  23. package/dist-cjs/index.js +0 -1
  24. package/dist-cjs/models/index.js +0 -1
  25. package/dist-cjs/models/models_0.js +0 -1
  26. package/dist-cjs/pagination/DescribeConnectorProfilesPaginator.js +0 -1
  27. package/dist-cjs/pagination/DescribeConnectorsPaginator.js +0 -1
  28. package/dist-cjs/pagination/DescribeFlowExecutionRecordsPaginator.js +0 -1
  29. package/dist-cjs/pagination/Interfaces.js +0 -1
  30. package/dist-cjs/pagination/ListFlowsPaginator.js +0 -1
  31. package/dist-cjs/protocols/Aws_restJson1.js +0 -1
  32. package/dist-cjs/runtimeConfig.browser.js +2 -3
  33. package/dist-cjs/runtimeConfig.js +3 -4
  34. package/dist-cjs/runtimeConfig.native.js +0 -1
  35. package/dist-cjs/runtimeConfig.shared.js +0 -1
  36. package/dist-es/Appflow.js +0 -1
  37. package/dist-es/AppflowClient.js +0 -1
  38. package/dist-es/commands/CreateConnectorProfileCommand.js +0 -1
  39. package/dist-es/commands/CreateFlowCommand.js +0 -1
  40. package/dist-es/commands/DeleteConnectorProfileCommand.js +0 -1
  41. package/dist-es/commands/DeleteFlowCommand.js +0 -1
  42. package/dist-es/commands/DescribeConnectorEntityCommand.js +0 -1
  43. package/dist-es/commands/DescribeConnectorProfilesCommand.js +0 -1
  44. package/dist-es/commands/DescribeConnectorsCommand.js +0 -1
  45. package/dist-es/commands/DescribeFlowCommand.js +0 -1
  46. package/dist-es/commands/DescribeFlowExecutionRecordsCommand.js +0 -1
  47. package/dist-es/commands/ListConnectorEntitiesCommand.js +0 -1
  48. package/dist-es/commands/ListFlowsCommand.js +0 -1
  49. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  50. package/dist-es/commands/StartFlowCommand.js +0 -1
  51. package/dist-es/commands/StopFlowCommand.js +0 -1
  52. package/dist-es/commands/TagResourceCommand.js +0 -1
  53. package/dist-es/commands/UntagResourceCommand.js +0 -1
  54. package/dist-es/commands/UpdateConnectorProfileCommand.js +0 -1
  55. package/dist-es/commands/UpdateFlowCommand.js +0 -1
  56. package/dist-es/endpoints.js +0 -1
  57. package/dist-es/index.js +0 -1
  58. package/dist-es/models/index.js +0 -1
  59. package/dist-es/models/models_0.js +0 -1
  60. package/dist-es/pagination/DescribeConnectorProfilesPaginator.js +0 -1
  61. package/dist-es/pagination/DescribeConnectorsPaginator.js +0 -1
  62. package/dist-es/pagination/DescribeFlowExecutionRecordsPaginator.js +0 -1
  63. package/dist-es/pagination/Interfaces.js +0 -1
  64. package/dist-es/pagination/ListFlowsPaginator.js +0 -1
  65. package/dist-es/protocols/Aws_restJson1.js +0 -1
  66. package/dist-es/runtimeConfig.browser.js +1 -2
  67. package/dist-es/runtimeConfig.js +2 -3
  68. package/dist-es/runtimeConfig.native.js +0 -1
  69. package/dist-es/runtimeConfig.shared.js +0 -1
  70. package/package.json +33 -30
  71. package/dist-cjs/Appflow.js.map +0 -1
  72. package/dist-cjs/AppflowClient.js.map +0 -1
  73. package/dist-cjs/commands/CreateConnectorProfileCommand.js.map +0 -1
  74. package/dist-cjs/commands/CreateFlowCommand.js.map +0 -1
  75. package/dist-cjs/commands/DeleteConnectorProfileCommand.js.map +0 -1
  76. package/dist-cjs/commands/DeleteFlowCommand.js.map +0 -1
  77. package/dist-cjs/commands/DescribeConnectorEntityCommand.js.map +0 -1
  78. package/dist-cjs/commands/DescribeConnectorProfilesCommand.js.map +0 -1
  79. package/dist-cjs/commands/DescribeConnectorsCommand.js.map +0 -1
  80. package/dist-cjs/commands/DescribeFlowCommand.js.map +0 -1
  81. package/dist-cjs/commands/DescribeFlowExecutionRecordsCommand.js.map +0 -1
  82. package/dist-cjs/commands/ListConnectorEntitiesCommand.js.map +0 -1
  83. package/dist-cjs/commands/ListFlowsCommand.js.map +0 -1
  84. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  85. package/dist-cjs/commands/StartFlowCommand.js.map +0 -1
  86. package/dist-cjs/commands/StopFlowCommand.js.map +0 -1
  87. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  88. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  89. package/dist-cjs/commands/UpdateConnectorProfileCommand.js.map +0 -1
  90. package/dist-cjs/commands/UpdateFlowCommand.js.map +0 -1
  91. package/dist-cjs/endpoints.js.map +0 -1
  92. package/dist-cjs/index.js.map +0 -1
  93. package/dist-cjs/models/index.js.map +0 -1
  94. package/dist-cjs/models/models_0.js.map +0 -1
  95. package/dist-cjs/pagination/DescribeConnectorProfilesPaginator.js.map +0 -1
  96. package/dist-cjs/pagination/DescribeConnectorsPaginator.js.map +0 -1
  97. package/dist-cjs/pagination/DescribeFlowExecutionRecordsPaginator.js.map +0 -1
  98. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  99. package/dist-cjs/pagination/ListFlowsPaginator.js.map +0 -1
  100. package/dist-cjs/protocols/Aws_restJson1.js.map +0 -1
  101. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  102. package/dist-cjs/runtimeConfig.js.map +0 -1
  103. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  104. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  105. package/dist-es/Appflow.js.map +0 -1
  106. package/dist-es/AppflowClient.js.map +0 -1
  107. package/dist-es/commands/CreateConnectorProfileCommand.js.map +0 -1
  108. package/dist-es/commands/CreateFlowCommand.js.map +0 -1
  109. package/dist-es/commands/DeleteConnectorProfileCommand.js.map +0 -1
  110. package/dist-es/commands/DeleteFlowCommand.js.map +0 -1
  111. package/dist-es/commands/DescribeConnectorEntityCommand.js.map +0 -1
  112. package/dist-es/commands/DescribeConnectorProfilesCommand.js.map +0 -1
  113. package/dist-es/commands/DescribeConnectorsCommand.js.map +0 -1
  114. package/dist-es/commands/DescribeFlowCommand.js.map +0 -1
  115. package/dist-es/commands/DescribeFlowExecutionRecordsCommand.js.map +0 -1
  116. package/dist-es/commands/ListConnectorEntitiesCommand.js.map +0 -1
  117. package/dist-es/commands/ListFlowsCommand.js.map +0 -1
  118. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  119. package/dist-es/commands/StartFlowCommand.js.map +0 -1
  120. package/dist-es/commands/StopFlowCommand.js.map +0 -1
  121. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  122. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  123. package/dist-es/commands/UpdateConnectorProfileCommand.js.map +0 -1
  124. package/dist-es/commands/UpdateFlowCommand.js.map +0 -1
  125. package/dist-es/endpoints.js.map +0 -1
  126. package/dist-es/index.js.map +0 -1
  127. package/dist-es/models/index.js.map +0 -1
  128. package/dist-es/models/models_0.js.map +0 -1
  129. package/dist-es/pagination/DescribeConnectorProfilesPaginator.js.map +0 -1
  130. package/dist-es/pagination/DescribeConnectorsPaginator.js.map +0 -1
  131. package/dist-es/pagination/DescribeFlowExecutionRecordsPaginator.js.map +0 -1
  132. package/dist-es/pagination/Interfaces.js.map +0 -1
  133. package/dist-es/pagination/ListFlowsPaginator.js.map +0 -1
  134. package/dist-es/protocols/Aws_restJson1.js.map +0 -1
  135. package/dist-es/runtimeConfig.browser.js.map +0 -1
  136. package/dist-es/runtimeConfig.js.map +0 -1
  137. package/dist-es/runtimeConfig.native.js.map +0 -1
  138. package/dist-es/runtimeConfig.shared.js.map +0 -1
  139. package/jest.config.js +0 -4
  140. package/src/Appflow.ts +0 -664
  141. package/src/AppflowClient.ts +0 -354
  142. package/src/commands/CreateConnectorProfileCommand.ts +0 -98
  143. package/src/commands/CreateFlowCommand.ts +0 -98
  144. package/src/commands/DeleteConnectorProfileCommand.ts +0 -95
  145. package/src/commands/DeleteFlowCommand.ts +0 -97
  146. package/src/commands/DescribeConnectorEntityCommand.ts +0 -96
  147. package/src/commands/DescribeConnectorProfilesCommand.ts +0 -102
  148. package/src/commands/DescribeConnectorsCommand.ts +0 -99
  149. package/src/commands/DescribeFlowCommand.ts +0 -95
  150. package/src/commands/DescribeFlowExecutionRecordsCommand.ts +0 -100
  151. package/src/commands/ListConnectorEntitiesCommand.ts +0 -98
  152. package/src/commands/ListFlowsCommand.ts +0 -95
  153. package/src/commands/ListTagsForResourceCommand.ts +0 -95
  154. package/src/commands/StartFlowCommand.ts +0 -96
  155. package/src/commands/StopFlowCommand.ts +0 -97
  156. package/src/commands/TagResourceCommand.ts +0 -95
  157. package/src/commands/UntagResourceCommand.ts +0 -95
  158. package/src/commands/UpdateConnectorProfileCommand.ts +0 -95
  159. package/src/commands/UpdateFlowCommand.ts +0 -95
  160. package/src/endpoints.ts +0 -57
  161. package/src/index.ts +0 -26
  162. package/src/models/index.ts +0 -1
  163. package/src/models/models_0.ts +0 -5012
  164. package/src/pagination/DescribeConnectorProfilesPaginator.ts +0 -59
  165. package/src/pagination/DescribeConnectorsPaginator.ts +0 -58
  166. package/src/pagination/DescribeFlowExecutionRecordsPaginator.ts +0 -59
  167. package/src/pagination/Interfaces.ts +0 -8
  168. package/src/pagination/ListFlowsPaginator.ts +0 -55
  169. package/src/protocols/Aws_restJson1.ts +0 -5153
  170. package/src/runtimeConfig.browser.ts +0 -41
  171. package/src/runtimeConfig.native.ts +0 -17
  172. package/src/runtimeConfig.shared.ts +0 -17
  173. package/src/runtimeConfig.ts +0 -46
  174. package/tsconfig.es.json +0 -10
  175. package/tsconfig.json +0 -33
  176. package/tsconfig.types.json +0 -9
@@ -1,5012 +0,0 @@
1
- import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
-
4
- export enum AggregationType {
5
- NONE = "None",
6
- SINGLE_FILE = "SingleFile",
7
- }
8
-
9
- /**
10
- * <p> The aggregation settings that you can use to customize the output format of your flow
11
- * data. </p>
12
- */
13
- export interface AggregationConfig {
14
- /**
15
- * <p> Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave
16
- * them unaggregated. </p>
17
- */
18
- aggregationType?: AggregationType | string;
19
- }
20
-
21
- export namespace AggregationConfig {
22
- /**
23
- * @internal
24
- */
25
- export const filterSensitiveLog = (obj: AggregationConfig): any => ({
26
- ...obj,
27
- });
28
- }
29
-
30
- export enum AmplitudeConnectorOperator {
31
- BETWEEN = "BETWEEN",
32
- }
33
-
34
- /**
35
- * <p> The connector-specific credentials required when using Amplitude. </p>
36
- */
37
- export interface AmplitudeConnectorProfileCredentials {
38
- /**
39
- * <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
40
- * program to your API. </p>
41
- */
42
- apiKey: string | undefined;
43
-
44
- /**
45
- * <p> The Secret Access Key portion of the credentials. </p>
46
- */
47
- secretKey: string | undefined;
48
- }
49
-
50
- export namespace AmplitudeConnectorProfileCredentials {
51
- /**
52
- * @internal
53
- */
54
- export const filterSensitiveLog = (obj: AmplitudeConnectorProfileCredentials): any => ({
55
- ...obj,
56
- ...(obj.secretKey && { secretKey: SENSITIVE_STRING }),
57
- });
58
- }
59
-
60
- /**
61
- * <p> The connector-specific profile properties required when using Amplitude. </p>
62
- */
63
- export interface AmplitudeConnectorProfileProperties {}
64
-
65
- export namespace AmplitudeConnectorProfileProperties {
66
- /**
67
- * @internal
68
- */
69
- export const filterSensitiveLog = (obj: AmplitudeConnectorProfileProperties): any => ({
70
- ...obj,
71
- });
72
- }
73
-
74
- /**
75
- * <p> The connector metadata specific to Amplitude. </p>
76
- */
77
- export interface AmplitudeMetadata {}
78
-
79
- export namespace AmplitudeMetadata {
80
- /**
81
- * @internal
82
- */
83
- export const filterSensitiveLog = (obj: AmplitudeMetadata): any => ({
84
- ...obj,
85
- });
86
- }
87
-
88
- /**
89
- * <p> The properties that are applied when Amplitude is being used as a source. </p>
90
- */
91
- export interface AmplitudeSourceProperties {
92
- /**
93
- * <p> The object specified in the Amplitude flow source. </p>
94
- */
95
- object: string | undefined;
96
- }
97
-
98
- export namespace AmplitudeSourceProperties {
99
- /**
100
- * @internal
101
- */
102
- export const filterSensitiveLog = (obj: AmplitudeSourceProperties): any => ({
103
- ...obj,
104
- });
105
- }
106
-
107
- /**
108
- * <p> The basic auth credentials required for basic authentication. </p>
109
- */
110
- export interface BasicAuthCredentials {
111
- /**
112
- * <p> The username to use to connect to a resource. </p>
113
- */
114
- username: string | undefined;
115
-
116
- /**
117
- * <p> The password to use to connect to a resource.</p>
118
- */
119
- password: string | undefined;
120
- }
121
-
122
- export namespace BasicAuthCredentials {
123
- /**
124
- * @internal
125
- */
126
- export const filterSensitiveLog = (obj: BasicAuthCredentials): any => ({
127
- ...obj,
128
- ...(obj.password && { password: SENSITIVE_STRING }),
129
- });
130
- }
131
-
132
- /**
133
- * <p> There was a conflict when processing the request (for example, a flow with the given name
134
- * already exists within the account. Check for conflicting resource names and try again. </p>
135
- */
136
- export interface ConflictException extends __SmithyException, $MetadataBearer {
137
- name: "ConflictException";
138
- $fault: "client";
139
- message?: string;
140
- }
141
-
142
- export namespace ConflictException {
143
- /**
144
- * @internal
145
- */
146
- export const filterSensitiveLog = (obj: ConflictException): any => ({
147
- ...obj,
148
- });
149
- }
150
-
151
- export enum ConnectionMode {
152
- PRIVATE = "Private",
153
- PUBLIC = "Public",
154
- }
155
-
156
- /**
157
- * <p> An error occurred when authenticating with the connector endpoint. </p>
158
- */
159
- export interface ConnectorAuthenticationException extends __SmithyException, $MetadataBearer {
160
- name: "ConnectorAuthenticationException";
161
- $fault: "client";
162
- message?: string;
163
- }
164
-
165
- export namespace ConnectorAuthenticationException {
166
- /**
167
- * @internal
168
- */
169
- export const filterSensitiveLog = (obj: ConnectorAuthenticationException): any => ({
170
- ...obj,
171
- });
172
- }
173
-
174
- /**
175
- * <p> The connector metadata specific to Amazon Connect Customer Profiles. </p>
176
- */
177
- export interface CustomerProfilesMetadata {}
178
-
179
- export namespace CustomerProfilesMetadata {
180
- /**
181
- * @internal
182
- */
183
- export const filterSensitiveLog = (obj: CustomerProfilesMetadata): any => ({
184
- ...obj,
185
- });
186
- }
187
-
188
- /**
189
- * <p> The connector metadata specific to Datadog. </p>
190
- */
191
- export interface DatadogMetadata {}
192
-
193
- export namespace DatadogMetadata {
194
- /**
195
- * @internal
196
- */
197
- export const filterSensitiveLog = (obj: DatadogMetadata): any => ({
198
- ...obj,
199
- });
200
- }
201
-
202
- /**
203
- * <p> The connector metadata specific to Dynatrace. </p>
204
- */
205
- export interface DynatraceMetadata {}
206
-
207
- export namespace DynatraceMetadata {
208
- /**
209
- * @internal
210
- */
211
- export const filterSensitiveLog = (obj: DynatraceMetadata): any => ({
212
- ...obj,
213
- });
214
- }
215
-
216
- /**
217
- * <p> The connector metadata specific to Amazon EventBridge. </p>
218
- */
219
- export interface EventBridgeMetadata {}
220
-
221
- export namespace EventBridgeMetadata {
222
- /**
223
- * @internal
224
- */
225
- export const filterSensitiveLog = (obj: EventBridgeMetadata): any => ({
226
- ...obj,
227
- });
228
- }
229
-
230
- /**
231
- * <p> The connector metadata specific to Google Analytics. </p>
232
- */
233
- export interface GoogleAnalyticsMetadata {
234
- /**
235
- * <p> The desired authorization scope for the Google Analytics account. </p>
236
- */
237
- oAuthScopes?: string[];
238
- }
239
-
240
- export namespace GoogleAnalyticsMetadata {
241
- /**
242
- * @internal
243
- */
244
- export const filterSensitiveLog = (obj: GoogleAnalyticsMetadata): any => ({
245
- ...obj,
246
- });
247
- }
248
-
249
- /**
250
- * <p> The connector metadata specific to Amazon Honeycode. </p>
251
- */
252
- export interface HoneycodeMetadata {
253
- /**
254
- * <p> The desired authorization scope for the Amazon Honeycode account. </p>
255
- */
256
- oAuthScopes?: string[];
257
- }
258
-
259
- export namespace HoneycodeMetadata {
260
- /**
261
- * @internal
262
- */
263
- export const filterSensitiveLog = (obj: HoneycodeMetadata): any => ({
264
- ...obj,
265
- });
266
- }
267
-
268
- /**
269
- * <p> The connector metadata specific to Infor Nexus. </p>
270
- */
271
- export interface InforNexusMetadata {}
272
-
273
- export namespace InforNexusMetadata {
274
- /**
275
- * @internal
276
- */
277
- export const filterSensitiveLog = (obj: InforNexusMetadata): any => ({
278
- ...obj,
279
- });
280
- }
281
-
282
- /**
283
- * <p> The connector metadata specific to Marketo. </p>
284
- */
285
- export interface MarketoMetadata {}
286
-
287
- export namespace MarketoMetadata {
288
- /**
289
- * @internal
290
- */
291
- export const filterSensitiveLog = (obj: MarketoMetadata): any => ({
292
- ...obj,
293
- });
294
- }
295
-
296
- /**
297
- * <p> The connector metadata specific to Amazon Redshift. </p>
298
- */
299
- export interface RedshiftMetadata {}
300
-
301
- export namespace RedshiftMetadata {
302
- /**
303
- * @internal
304
- */
305
- export const filterSensitiveLog = (obj: RedshiftMetadata): any => ({
306
- ...obj,
307
- });
308
- }
309
-
310
- /**
311
- * <p> The connector metadata specific to Amazon S3. </p>
312
- */
313
- export interface S3Metadata {}
314
-
315
- export namespace S3Metadata {
316
- /**
317
- * @internal
318
- */
319
- export const filterSensitiveLog = (obj: S3Metadata): any => ({
320
- ...obj,
321
- });
322
- }
323
-
324
- /**
325
- * <p> The connector metadata specific to Salesforce. </p>
326
- */
327
- export interface SalesforceMetadata {
328
- /**
329
- * <p> The desired authorization scope for the Salesforce account. </p>
330
- */
331
- oAuthScopes?: string[];
332
- }
333
-
334
- export namespace SalesforceMetadata {
335
- /**
336
- * @internal
337
- */
338
- export const filterSensitiveLog = (obj: SalesforceMetadata): any => ({
339
- ...obj,
340
- });
341
- }
342
-
343
- /**
344
- * <p> The connector metadata specific to SAPOData. </p>
345
- */
346
- export interface SAPODataMetadata {}
347
-
348
- export namespace SAPODataMetadata {
349
- /**
350
- * @internal
351
- */
352
- export const filterSensitiveLog = (obj: SAPODataMetadata): any => ({
353
- ...obj,
354
- });
355
- }
356
-
357
- /**
358
- * <p> The connector metadata specific to ServiceNow. </p>
359
- */
360
- export interface ServiceNowMetadata {}
361
-
362
- export namespace ServiceNowMetadata {
363
- /**
364
- * @internal
365
- */
366
- export const filterSensitiveLog = (obj: ServiceNowMetadata): any => ({
367
- ...obj,
368
- });
369
- }
370
-
371
- /**
372
- * <p> The connector metadata specific to Singular. </p>
373
- */
374
- export interface SingularMetadata {}
375
-
376
- export namespace SingularMetadata {
377
- /**
378
- * @internal
379
- */
380
- export const filterSensitiveLog = (obj: SingularMetadata): any => ({
381
- ...obj,
382
- });
383
- }
384
-
385
- /**
386
- * <p> The connector metadata specific to Slack. </p>
387
- */
388
- export interface SlackMetadata {
389
- /**
390
- * <p> The desired authorization scope for the Slack account. </p>
391
- */
392
- oAuthScopes?: string[];
393
- }
394
-
395
- export namespace SlackMetadata {
396
- /**
397
- * @internal
398
- */
399
- export const filterSensitiveLog = (obj: SlackMetadata): any => ({
400
- ...obj,
401
- });
402
- }
403
-
404
- /**
405
- * <p> The connector metadata specific to Snowflake. </p>
406
- */
407
- export interface SnowflakeMetadata {
408
- /**
409
- * <p> Specifies the supported Amazon Web Services Regions when using Snowflake. </p>
410
- */
411
- supportedRegions?: string[];
412
- }
413
-
414
- export namespace SnowflakeMetadata {
415
- /**
416
- * @internal
417
- */
418
- export const filterSensitiveLog = (obj: SnowflakeMetadata): any => ({
419
- ...obj,
420
- });
421
- }
422
-
423
- /**
424
- * <p> The connector metadata specific to Trend Micro. </p>
425
- */
426
- export interface TrendmicroMetadata {}
427
-
428
- export namespace TrendmicroMetadata {
429
- /**
430
- * @internal
431
- */
432
- export const filterSensitiveLog = (obj: TrendmicroMetadata): any => ({
433
- ...obj,
434
- });
435
- }
436
-
437
- /**
438
- * <p> The connector metadata specific to Upsolver. </p>
439
- */
440
- export interface UpsolverMetadata {}
441
-
442
- export namespace UpsolverMetadata {
443
- /**
444
- * @internal
445
- */
446
- export const filterSensitiveLog = (obj: UpsolverMetadata): any => ({
447
- ...obj,
448
- });
449
- }
450
-
451
- /**
452
- * <p> The connector metadata specific to Veeva. </p>
453
- */
454
- export interface VeevaMetadata {}
455
-
456
- export namespace VeevaMetadata {
457
- /**
458
- * @internal
459
- */
460
- export const filterSensitiveLog = (obj: VeevaMetadata): any => ({
461
- ...obj,
462
- });
463
- }
464
-
465
- /**
466
- * <p> The connector metadata specific to Zendesk. </p>
467
- */
468
- export interface ZendeskMetadata {
469
- /**
470
- * <p> The desired authorization scope for the Zendesk account. </p>
471
- */
472
- oAuthScopes?: string[];
473
- }
474
-
475
- export namespace ZendeskMetadata {
476
- /**
477
- * @internal
478
- */
479
- export const filterSensitiveLog = (obj: ZendeskMetadata): any => ({
480
- ...obj,
481
- });
482
- }
483
-
484
- /**
485
- * <p> A structure to specify connector-specific metadata such as <code>oAuthScopes</code>,
486
- * <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>
487
- */
488
- export interface ConnectorMetadata {
489
- /**
490
- * <p> The connector metadata specific to Amplitude. </p>
491
- */
492
- Amplitude?: AmplitudeMetadata;
493
-
494
- /**
495
- * <p> The connector metadata specific to Datadog. </p>
496
- */
497
- Datadog?: DatadogMetadata;
498
-
499
- /**
500
- * <p> The connector metadata specific to Dynatrace. </p>
501
- */
502
- Dynatrace?: DynatraceMetadata;
503
-
504
- /**
505
- * <p> The connector metadata specific to Google Analytics. </p>
506
- */
507
- GoogleAnalytics?: GoogleAnalyticsMetadata;
508
-
509
- /**
510
- * <p> The connector metadata specific to Infor Nexus. </p>
511
- */
512
- InforNexus?: InforNexusMetadata;
513
-
514
- /**
515
- * <p> The connector metadata specific to Marketo. </p>
516
- */
517
- Marketo?: MarketoMetadata;
518
-
519
- /**
520
- * <p> The connector metadata specific to Amazon Redshift. </p>
521
- */
522
- Redshift?: RedshiftMetadata;
523
-
524
- /**
525
- * <p> The connector metadata specific to Amazon S3. </p>
526
- */
527
- S3?: S3Metadata;
528
-
529
- /**
530
- * <p> The connector metadata specific to Salesforce. </p>
531
- */
532
- Salesforce?: SalesforceMetadata;
533
-
534
- /**
535
- * <p> The connector metadata specific to ServiceNow. </p>
536
- */
537
- ServiceNow?: ServiceNowMetadata;
538
-
539
- /**
540
- * <p> The connector metadata specific to Singular. </p>
541
- */
542
- Singular?: SingularMetadata;
543
-
544
- /**
545
- * <p> The connector metadata specific to Slack. </p>
546
- */
547
- Slack?: SlackMetadata;
548
-
549
- /**
550
- * <p> The connector metadata specific to Snowflake. </p>
551
- */
552
- Snowflake?: SnowflakeMetadata;
553
-
554
- /**
555
- * <p> The connector metadata specific to Trend Micro. </p>
556
- */
557
- Trendmicro?: TrendmicroMetadata;
558
-
559
- /**
560
- * <p> The connector metadata specific to Veeva. </p>
561
- */
562
- Veeva?: VeevaMetadata;
563
-
564
- /**
565
- * <p> The connector metadata specific to Zendesk. </p>
566
- */
567
- Zendesk?: ZendeskMetadata;
568
-
569
- /**
570
- * <p> The connector metadata specific to Amazon EventBridge. </p>
571
- */
572
- EventBridge?: EventBridgeMetadata;
573
-
574
- /**
575
- * <p> The connector metadata specific to Upsolver. </p>
576
- */
577
- Upsolver?: UpsolverMetadata;
578
-
579
- /**
580
- * <p> The connector metadata specific to Amazon Connect Customer Profiles. </p>
581
- */
582
- CustomerProfiles?: CustomerProfilesMetadata;
583
-
584
- /**
585
- * <p> The connector metadata specific to Amazon Honeycode. </p>
586
- */
587
- Honeycode?: HoneycodeMetadata;
588
-
589
- /**
590
- * <p> The connector metadata specific to SAPOData. </p>
591
- */
592
- SAPOData?: SAPODataMetadata;
593
- }
594
-
595
- export namespace ConnectorMetadata {
596
- /**
597
- * @internal
598
- */
599
- export const filterSensitiveLog = (obj: ConnectorMetadata): any => ({
600
- ...obj,
601
- });
602
- }
603
-
604
- export enum ConnectorType {
605
- AMPLITUDE = "Amplitude",
606
- CUSTOMERPROFILES = "CustomerProfiles",
607
- DATADOG = "Datadog",
608
- DYNATRACE = "Dynatrace",
609
- EVENTBRIDGE = "EventBridge",
610
- GOOGLEANALYTICS = "Googleanalytics",
611
- HONEYCODE = "Honeycode",
612
- INFORNEXUS = "Infornexus",
613
- LOOKOUTMETRICS = "LookoutMetrics",
614
- MARKETO = "Marketo",
615
- REDSHIFT = "Redshift",
616
- S3 = "S3",
617
- SALESFORCE = "Salesforce",
618
- SAPODATA = "SAPOData",
619
- SERVICENOW = "Servicenow",
620
- SINGULAR = "Singular",
621
- SLACK = "Slack",
622
- SNOWFLAKE = "Snowflake",
623
- TRENDMICRO = "Trendmicro",
624
- UPSOLVER = "Upsolver",
625
- VEEVA = "Veeva",
626
- ZENDESK = "Zendesk",
627
- }
628
-
629
- export enum ScheduleFrequencyType {
630
- BYMINUTE = "BYMINUTE",
631
- DAILY = "DAILY",
632
- HOURLY = "HOURLY",
633
- MONTHLY = "MONTHLY",
634
- ONCE = "ONCE",
635
- WEEKLY = "WEEKLY",
636
- }
637
-
638
- export enum TriggerType {
639
- EVENT = "Event",
640
- ONDEMAND = "OnDemand",
641
- SCHEDULED = "Scheduled",
642
- }
643
-
644
- /**
645
- * <p> The configuration settings related to a given connector. </p>
646
- */
647
- export interface ConnectorConfiguration {
648
- /**
649
- * <p> Specifies whether the connector can be used as a source. </p>
650
- */
651
- canUseAsSource?: boolean;
652
-
653
- /**
654
- * <p> Specifies whether the connector can be used as a destination. </p>
655
- */
656
- canUseAsDestination?: boolean;
657
-
658
- /**
659
- * <p> Lists the connectors that are available for use as destinations. </p>
660
- */
661
- supportedDestinationConnectors?: (ConnectorType | string)[];
662
-
663
- /**
664
- * <p> Specifies the supported flow frequency for that connector. </p>
665
- */
666
- supportedSchedulingFrequencies?: (ScheduleFrequencyType | string)[];
667
-
668
- /**
669
- * <p> Specifies if PrivateLink is enabled for that connector. </p>
670
- */
671
- isPrivateLinkEnabled?: boolean;
672
-
673
- /**
674
- * <p> Specifies if a PrivateLink endpoint URL is required. </p>
675
- */
676
- isPrivateLinkEndpointUrlRequired?: boolean;
677
-
678
- /**
679
- * <p> Specifies the supported trigger types for the flow. </p>
680
- */
681
- supportedTriggerTypes?: (TriggerType | string)[];
682
-
683
- /**
684
- * <p> Specifies connector-specific metadata such as <code>oAuthScopes</code>,
685
- * <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>
686
- */
687
- connectorMetadata?: ConnectorMetadata;
688
- }
689
-
690
- export namespace ConnectorConfiguration {
691
- /**
692
- * @internal
693
- */
694
- export const filterSensitiveLog = (obj: ConnectorConfiguration): any => ({
695
- ...obj,
696
- });
697
- }
698
-
699
- /**
700
- * <p> The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce
701
- * entity might be an <i>Account</i> or <i>Opportunity</i>, whereas a
702
- * ServiceNow entity might be an <i>Incident</i>. </p>
703
- */
704
- export interface ConnectorEntity {
705
- /**
706
- * <p> The name of the connector entity. </p>
707
- */
708
- name: string | undefined;
709
-
710
- /**
711
- * <p> The label applied to the connector entity. </p>
712
- */
713
- label?: string;
714
-
715
- /**
716
- * <p> Specifies whether the connector entity is a parent or a category and has more entities
717
- * nested underneath it. If another call is made with <code>entitiesPath =
718
- * "the_current_entity_name_with_hasNestedEntities_true"</code>, then it returns the nested
719
- * entities underneath it. This provides a way to retrieve all supported entities in a recursive
720
- * fashion. </p>
721
- */
722
- hasNestedEntities?: boolean;
723
- }
724
-
725
- export namespace ConnectorEntity {
726
- /**
727
- * @internal
728
- */
729
- export const filterSensitiveLog = (obj: ConnectorEntity): any => ({
730
- ...obj,
731
- });
732
- }
733
-
734
- export enum WriteOperationType {
735
- INSERT = "INSERT",
736
- UPDATE = "UPDATE",
737
- UPSERT = "UPSERT",
738
- }
739
-
740
- /**
741
- * <p> The properties that can be applied to a field when connector is being used as a
742
- * destination. </p>
743
- */
744
- export interface DestinationFieldProperties {
745
- /**
746
- * <p> Specifies if the destination field can be created by the current user. </p>
747
- */
748
- isCreatable?: boolean;
749
-
750
- /**
751
- * <p> Specifies if the destination field can have a null value. </p>
752
- */
753
- isNullable?: boolean;
754
-
755
- /**
756
- * <p> Specifies if the flow run can either insert new rows in the destination field if they do
757
- * not already exist, or update them if they do. </p>
758
- */
759
- isUpsertable?: boolean;
760
-
761
- /**
762
- * <p> Specifies whether the field can be updated during an <code>UPDATE</code> or
763
- * <code>UPSERT</code> write operation. </p>
764
- */
765
- isUpdatable?: boolean;
766
-
767
- /**
768
- * <p> A list of supported write operations. For each write operation listed, this field can be
769
- * used in <code>idFieldNames</code> when that write operation is present as a destination
770
- * option. </p>
771
- */
772
- supportedWriteOperations?: (WriteOperationType | string)[];
773
- }
774
-
775
- export namespace DestinationFieldProperties {
776
- /**
777
- * @internal
778
- */
779
- export const filterSensitiveLog = (obj: DestinationFieldProperties): any => ({
780
- ...obj,
781
- });
782
- }
783
-
784
- /**
785
- * <p> The properties that can be applied to a field when the connector is being used as a
786
- * source. </p>
787
- */
788
- export interface SourceFieldProperties {
789
- /**
790
- * <p> Indicates whether the field can be returned in a search result. </p>
791
- */
792
- isRetrievable?: boolean;
793
-
794
- /**
795
- * <p> Indicates if the field can be queried. </p>
796
- */
797
- isQueryable?: boolean;
798
- }
799
-
800
- export namespace SourceFieldProperties {
801
- /**
802
- * @internal
803
- */
804
- export const filterSensitiveLog = (obj: SourceFieldProperties): any => ({
805
- ...obj,
806
- });
807
- }
808
-
809
- export enum Operator {
810
- ADDITION = "ADDITION",
811
- BETWEEN = "BETWEEN",
812
- CONTAINS = "CONTAINS",
813
- DIVISION = "DIVISION",
814
- EQUAL_TO = "EQUAL_TO",
815
- GREATER_THAN = "GREATER_THAN",
816
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
817
- LESS_THAN = "LESS_THAN",
818
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
819
- MASK_ALL = "MASK_ALL",
820
- MASK_FIRST_N = "MASK_FIRST_N",
821
- MASK_LAST_N = "MASK_LAST_N",
822
- MULTIPLICATION = "MULTIPLICATION",
823
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
824
- NO_OP = "NO_OP",
825
- PROJECTION = "PROJECTION",
826
- SUBTRACTION = "SUBTRACTION",
827
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
828
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
829
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
830
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
831
- }
832
-
833
- /**
834
- * <p> Contains details regarding the supported field type and the operators that can be applied
835
- * for filtering. </p>
836
- */
837
- export interface FieldTypeDetails {
838
- /**
839
- * <p> The type of field, such as string, integer, date, and so on. </p>
840
- */
841
- fieldType: string | undefined;
842
-
843
- /**
844
- * <p> The list of operators supported by a field. </p>
845
- */
846
- filterOperators: (Operator | string)[] | undefined;
847
-
848
- /**
849
- * <p> The list of values that a field can contain. For example, a Boolean
850
- * <code>fieldType</code> can have two values: "true" and "false". </p>
851
- */
852
- supportedValues?: string[];
853
- }
854
-
855
- export namespace FieldTypeDetails {
856
- /**
857
- * @internal
858
- */
859
- export const filterSensitiveLog = (obj: FieldTypeDetails): any => ({
860
- ...obj,
861
- });
862
- }
863
-
864
- /**
865
- * <p> Contains details regarding all the supported <code>FieldTypes</code> and their
866
- * corresponding <code>filterOperators</code> and <code>supportedValues</code>. </p>
867
- */
868
- export interface SupportedFieldTypeDetails {
869
- /**
870
- * <p> The initial supported version for <code>fieldType</code>. If this is later changed to a
871
- * different version, v2 will be introduced. </p>
872
- */
873
- v1: FieldTypeDetails | undefined;
874
- }
875
-
876
- export namespace SupportedFieldTypeDetails {
877
- /**
878
- * @internal
879
- */
880
- export const filterSensitiveLog = (obj: SupportedFieldTypeDetails): any => ({
881
- ...obj,
882
- });
883
- }
884
-
885
- /**
886
- * <p> Describes the data model of a connector field. For example, for an
887
- * <i>account</i> entity, the fields would be <i>account name</i>,
888
- * <i>account ID</i>, and so on. </p>
889
- */
890
- export interface ConnectorEntityField {
891
- /**
892
- * <p> The unique identifier of the connector field. </p>
893
- */
894
- identifier: string | undefined;
895
-
896
- /**
897
- * <p> The label applied to a connector entity field. </p>
898
- */
899
- label?: string;
900
-
901
- /**
902
- * <p> Contains details regarding the supported <code>FieldType</code>, including the
903
- * corresponding <code>filterOperators</code> and <code>supportedValues</code>. </p>
904
- */
905
- supportedFieldTypeDetails?: SupportedFieldTypeDetails;
906
-
907
- /**
908
- * <p> A description of the connector entity field. </p>
909
- */
910
- description?: string;
911
-
912
- /**
913
- * <p> The properties that can be applied to a field when the connector is being used as a
914
- * source. </p>
915
- */
916
- sourceProperties?: SourceFieldProperties;
917
-
918
- /**
919
- * <p> The properties applied to a field when the connector is being used as a destination.
920
- * </p>
921
- */
922
- destinationProperties?: DestinationFieldProperties;
923
- }
924
-
925
- export namespace ConnectorEntityField {
926
- /**
927
- * @internal
928
- */
929
- export const filterSensitiveLog = (obj: ConnectorEntityField): any => ({
930
- ...obj,
931
- });
932
- }
933
-
934
- /**
935
- * <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
936
- * Google Analytics, Marketo, Zendesk, and Slack. </p>
937
- */
938
- export interface ConnectorOAuthRequest {
939
- /**
940
- * <p> The code provided by the connector when it has been authenticated via the connected app.
941
- * </p>
942
- */
943
- authCode?: string;
944
-
945
- /**
946
- * <p> The URL to which the authentication server redirects the browser after authorization has
947
- * been granted. </p>
948
- */
949
- redirectUri?: string;
950
- }
951
-
952
- export namespace ConnectorOAuthRequest {
953
- /**
954
- * @internal
955
- */
956
- export const filterSensitiveLog = (obj: ConnectorOAuthRequest): any => ({
957
- ...obj,
958
- });
959
- }
960
-
961
- export enum DatadogConnectorOperator {
962
- ADDITION = "ADDITION",
963
- BETWEEN = "BETWEEN",
964
- DIVISION = "DIVISION",
965
- EQUAL_TO = "EQUAL_TO",
966
- MASK_ALL = "MASK_ALL",
967
- MASK_FIRST_N = "MASK_FIRST_N",
968
- MASK_LAST_N = "MASK_LAST_N",
969
- MULTIPLICATION = "MULTIPLICATION",
970
- NO_OP = "NO_OP",
971
- PROJECTION = "PROJECTION",
972
- SUBTRACTION = "SUBTRACTION",
973
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
974
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
975
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
976
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
977
- }
978
-
979
- export enum DynatraceConnectorOperator {
980
- ADDITION = "ADDITION",
981
- BETWEEN = "BETWEEN",
982
- DIVISION = "DIVISION",
983
- EQUAL_TO = "EQUAL_TO",
984
- MASK_ALL = "MASK_ALL",
985
- MASK_FIRST_N = "MASK_FIRST_N",
986
- MASK_LAST_N = "MASK_LAST_N",
987
- MULTIPLICATION = "MULTIPLICATION",
988
- NO_OP = "NO_OP",
989
- PROJECTION = "PROJECTION",
990
- SUBTRACTION = "SUBTRACTION",
991
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
992
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
993
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
994
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
995
- }
996
-
997
- export enum GoogleAnalyticsConnectorOperator {
998
- BETWEEN = "BETWEEN",
999
- PROJECTION = "PROJECTION",
1000
- }
1001
-
1002
- export enum InforNexusConnectorOperator {
1003
- ADDITION = "ADDITION",
1004
- BETWEEN = "BETWEEN",
1005
- DIVISION = "DIVISION",
1006
- EQUAL_TO = "EQUAL_TO",
1007
- MASK_ALL = "MASK_ALL",
1008
- MASK_FIRST_N = "MASK_FIRST_N",
1009
- MASK_LAST_N = "MASK_LAST_N",
1010
- MULTIPLICATION = "MULTIPLICATION",
1011
- NO_OP = "NO_OP",
1012
- PROJECTION = "PROJECTION",
1013
- SUBTRACTION = "SUBTRACTION",
1014
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1015
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1016
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1017
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1018
- }
1019
-
1020
- export enum MarketoConnectorOperator {
1021
- ADDITION = "ADDITION",
1022
- BETWEEN = "BETWEEN",
1023
- DIVISION = "DIVISION",
1024
- GREATER_THAN = "GREATER_THAN",
1025
- LESS_THAN = "LESS_THAN",
1026
- MASK_ALL = "MASK_ALL",
1027
- MASK_FIRST_N = "MASK_FIRST_N",
1028
- MASK_LAST_N = "MASK_LAST_N",
1029
- MULTIPLICATION = "MULTIPLICATION",
1030
- NO_OP = "NO_OP",
1031
- PROJECTION = "PROJECTION",
1032
- SUBTRACTION = "SUBTRACTION",
1033
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1034
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1035
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1036
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1037
- }
1038
-
1039
- export enum S3ConnectorOperator {
1040
- ADDITION = "ADDITION",
1041
- BETWEEN = "BETWEEN",
1042
- DIVISION = "DIVISION",
1043
- EQUAL_TO = "EQUAL_TO",
1044
- GREATER_THAN = "GREATER_THAN",
1045
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1046
- LESS_THAN = "LESS_THAN",
1047
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1048
- MASK_ALL = "MASK_ALL",
1049
- MASK_FIRST_N = "MASK_FIRST_N",
1050
- MASK_LAST_N = "MASK_LAST_N",
1051
- MULTIPLICATION = "MULTIPLICATION",
1052
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
1053
- NO_OP = "NO_OP",
1054
- PROJECTION = "PROJECTION",
1055
- SUBTRACTION = "SUBTRACTION",
1056
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1057
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1058
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1059
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1060
- }
1061
-
1062
- export enum SalesforceConnectorOperator {
1063
- ADDITION = "ADDITION",
1064
- BETWEEN = "BETWEEN",
1065
- CONTAINS = "CONTAINS",
1066
- DIVISION = "DIVISION",
1067
- EQUAL_TO = "EQUAL_TO",
1068
- GREATER_THAN = "GREATER_THAN",
1069
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1070
- LESS_THAN = "LESS_THAN",
1071
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1072
- MASK_ALL = "MASK_ALL",
1073
- MASK_FIRST_N = "MASK_FIRST_N",
1074
- MASK_LAST_N = "MASK_LAST_N",
1075
- MULTIPLICATION = "MULTIPLICATION",
1076
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
1077
- NO_OP = "NO_OP",
1078
- PROJECTION = "PROJECTION",
1079
- SUBTRACTION = "SUBTRACTION",
1080
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1081
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1082
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1083
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1084
- }
1085
-
1086
- export enum SAPODataConnectorOperator {
1087
- ADDITION = "ADDITION",
1088
- BETWEEN = "BETWEEN",
1089
- CONTAINS = "CONTAINS",
1090
- DIVISION = "DIVISION",
1091
- EQUAL_TO = "EQUAL_TO",
1092
- GREATER_THAN = "GREATER_THAN",
1093
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1094
- LESS_THAN = "LESS_THAN",
1095
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1096
- MASK_ALL = "MASK_ALL",
1097
- MASK_FIRST_N = "MASK_FIRST_N",
1098
- MASK_LAST_N = "MASK_LAST_N",
1099
- MULTIPLICATION = "MULTIPLICATION",
1100
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
1101
- NO_OP = "NO_OP",
1102
- PROJECTION = "PROJECTION",
1103
- SUBTRACTION = "SUBTRACTION",
1104
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1105
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1106
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1107
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1108
- }
1109
-
1110
- export enum ServiceNowConnectorOperator {
1111
- ADDITION = "ADDITION",
1112
- BETWEEN = "BETWEEN",
1113
- CONTAINS = "CONTAINS",
1114
- DIVISION = "DIVISION",
1115
- EQUAL_TO = "EQUAL_TO",
1116
- GREATER_THAN = "GREATER_THAN",
1117
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1118
- LESS_THAN = "LESS_THAN",
1119
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1120
- MASK_ALL = "MASK_ALL",
1121
- MASK_FIRST_N = "MASK_FIRST_N",
1122
- MASK_LAST_N = "MASK_LAST_N",
1123
- MULTIPLICATION = "MULTIPLICATION",
1124
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
1125
- NO_OP = "NO_OP",
1126
- PROJECTION = "PROJECTION",
1127
- SUBTRACTION = "SUBTRACTION",
1128
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1129
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1130
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1131
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1132
- }
1133
-
1134
- export enum SingularConnectorOperator {
1135
- ADDITION = "ADDITION",
1136
- DIVISION = "DIVISION",
1137
- EQUAL_TO = "EQUAL_TO",
1138
- MASK_ALL = "MASK_ALL",
1139
- MASK_FIRST_N = "MASK_FIRST_N",
1140
- MASK_LAST_N = "MASK_LAST_N",
1141
- MULTIPLICATION = "MULTIPLICATION",
1142
- NO_OP = "NO_OP",
1143
- PROJECTION = "PROJECTION",
1144
- SUBTRACTION = "SUBTRACTION",
1145
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1146
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1147
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1148
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1149
- }
1150
-
1151
- export enum SlackConnectorOperator {
1152
- ADDITION = "ADDITION",
1153
- BETWEEN = "BETWEEN",
1154
- DIVISION = "DIVISION",
1155
- EQUAL_TO = "EQUAL_TO",
1156
- GREATER_THAN = "GREATER_THAN",
1157
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1158
- LESS_THAN = "LESS_THAN",
1159
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1160
- MASK_ALL = "MASK_ALL",
1161
- MASK_FIRST_N = "MASK_FIRST_N",
1162
- MASK_LAST_N = "MASK_LAST_N",
1163
- MULTIPLICATION = "MULTIPLICATION",
1164
- NO_OP = "NO_OP",
1165
- PROJECTION = "PROJECTION",
1166
- SUBTRACTION = "SUBTRACTION",
1167
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1168
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1169
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1170
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1171
- }
1172
-
1173
- export enum TrendmicroConnectorOperator {
1174
- ADDITION = "ADDITION",
1175
- DIVISION = "DIVISION",
1176
- EQUAL_TO = "EQUAL_TO",
1177
- MASK_ALL = "MASK_ALL",
1178
- MASK_FIRST_N = "MASK_FIRST_N",
1179
- MASK_LAST_N = "MASK_LAST_N",
1180
- MULTIPLICATION = "MULTIPLICATION",
1181
- NO_OP = "NO_OP",
1182
- PROJECTION = "PROJECTION",
1183
- SUBTRACTION = "SUBTRACTION",
1184
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1185
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1186
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1187
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1188
- }
1189
-
1190
- export enum VeevaConnectorOperator {
1191
- ADDITION = "ADDITION",
1192
- BETWEEN = "BETWEEN",
1193
- CONTAINS = "CONTAINS",
1194
- DIVISION = "DIVISION",
1195
- EQUAL_TO = "EQUAL_TO",
1196
- GREATER_THAN = "GREATER_THAN",
1197
- GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
1198
- LESS_THAN = "LESS_THAN",
1199
- LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
1200
- MASK_ALL = "MASK_ALL",
1201
- MASK_FIRST_N = "MASK_FIRST_N",
1202
- MASK_LAST_N = "MASK_LAST_N",
1203
- MULTIPLICATION = "MULTIPLICATION",
1204
- NOT_EQUAL_TO = "NOT_EQUAL_TO",
1205
- NO_OP = "NO_OP",
1206
- PROJECTION = "PROJECTION",
1207
- SUBTRACTION = "SUBTRACTION",
1208
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1209
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1210
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1211
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1212
- }
1213
-
1214
- export enum ZendeskConnectorOperator {
1215
- ADDITION = "ADDITION",
1216
- DIVISION = "DIVISION",
1217
- GREATER_THAN = "GREATER_THAN",
1218
- MASK_ALL = "MASK_ALL",
1219
- MASK_FIRST_N = "MASK_FIRST_N",
1220
- MASK_LAST_N = "MASK_LAST_N",
1221
- MULTIPLICATION = "MULTIPLICATION",
1222
- NO_OP = "NO_OP",
1223
- PROJECTION = "PROJECTION",
1224
- SUBTRACTION = "SUBTRACTION",
1225
- VALIDATE_NON_NEGATIVE = "VALIDATE_NON_NEGATIVE",
1226
- VALIDATE_NON_NULL = "VALIDATE_NON_NULL",
1227
- VALIDATE_NON_ZERO = "VALIDATE_NON_ZERO",
1228
- VALIDATE_NUMERIC = "VALIDATE_NUMERIC",
1229
- }
1230
-
1231
- /**
1232
- * <p> The operation to be performed on the provided source fields. </p>
1233
- */
1234
- export interface ConnectorOperator {
1235
- /**
1236
- * <p> The operation to be performed on the provided Amplitude source fields. </p>
1237
- */
1238
- Amplitude?: AmplitudeConnectorOperator | string;
1239
-
1240
- /**
1241
- * <p> The operation to be performed on the provided Datadog source fields. </p>
1242
- */
1243
- Datadog?: DatadogConnectorOperator | string;
1244
-
1245
- /**
1246
- * <p> The operation to be performed on the provided Dynatrace source fields. </p>
1247
- */
1248
- Dynatrace?: DynatraceConnectorOperator | string;
1249
-
1250
- /**
1251
- * <p> The operation to be performed on the provided Google Analytics source fields. </p>
1252
- */
1253
- GoogleAnalytics?: GoogleAnalyticsConnectorOperator | string;
1254
-
1255
- /**
1256
- * <p> The operation to be performed on the provided Infor Nexus source fields. </p>
1257
- */
1258
- InforNexus?: InforNexusConnectorOperator | string;
1259
-
1260
- /**
1261
- * <p> The operation to be performed on the provided Marketo source fields. </p>
1262
- */
1263
- Marketo?: MarketoConnectorOperator | string;
1264
-
1265
- /**
1266
- * <p> The operation to be performed on the provided Amazon S3 source fields. </p>
1267
- */
1268
- S3?: S3ConnectorOperator | string;
1269
-
1270
- /**
1271
- * <p> The operation to be performed on the provided Salesforce source fields. </p>
1272
- */
1273
- Salesforce?: SalesforceConnectorOperator | string;
1274
-
1275
- /**
1276
- * <p> The operation to be performed on the provided ServiceNow source fields. </p>
1277
- */
1278
- ServiceNow?: ServiceNowConnectorOperator | string;
1279
-
1280
- /**
1281
- * <p> The operation to be performed on the provided Singular source fields. </p>
1282
- */
1283
- Singular?: SingularConnectorOperator | string;
1284
-
1285
- /**
1286
- * <p> The operation to be performed on the provided Slack source fields. </p>
1287
- */
1288
- Slack?: SlackConnectorOperator | string;
1289
-
1290
- /**
1291
- * <p> The operation to be performed on the provided Trend Micro source fields. </p>
1292
- */
1293
- Trendmicro?: TrendmicroConnectorOperator | string;
1294
-
1295
- /**
1296
- * <p> The operation to be performed on the provided Veeva source fields. </p>
1297
- */
1298
- Veeva?: VeevaConnectorOperator | string;
1299
-
1300
- /**
1301
- * <p> The operation to be performed on the provided Zendesk source fields. </p>
1302
- */
1303
- Zendesk?: ZendeskConnectorOperator | string;
1304
-
1305
- /**
1306
- * <p> The operation to be performed on the provided SAPOData source fields. </p>
1307
- */
1308
- SAPOData?: SAPODataConnectorOperator | string;
1309
- }
1310
-
1311
- export namespace ConnectorOperator {
1312
- /**
1313
- * @internal
1314
- */
1315
- export const filterSensitiveLog = (obj: ConnectorOperator): any => ({
1316
- ...obj,
1317
- });
1318
- }
1319
-
1320
- /**
1321
- * <p> The connector-specific profile properties required by Datadog. </p>
1322
- */
1323
- export interface DatadogConnectorProfileProperties {
1324
- /**
1325
- * <p> The location of the Datadog resource. </p>
1326
- */
1327
- instanceUrl: string | undefined;
1328
- }
1329
-
1330
- export namespace DatadogConnectorProfileProperties {
1331
- /**
1332
- * @internal
1333
- */
1334
- export const filterSensitiveLog = (obj: DatadogConnectorProfileProperties): any => ({
1335
- ...obj,
1336
- });
1337
- }
1338
-
1339
- /**
1340
- * <p> The connector-specific profile properties required by Dynatrace. </p>
1341
- */
1342
- export interface DynatraceConnectorProfileProperties {
1343
- /**
1344
- * <p> The location of the Dynatrace resource. </p>
1345
- */
1346
- instanceUrl: string | undefined;
1347
- }
1348
-
1349
- export namespace DynatraceConnectorProfileProperties {
1350
- /**
1351
- * @internal
1352
- */
1353
- export const filterSensitiveLog = (obj: DynatraceConnectorProfileProperties): any => ({
1354
- ...obj,
1355
- });
1356
- }
1357
-
1358
- /**
1359
- * <p> The connector-specific profile properties required by Google Analytics. </p>
1360
- */
1361
- export interface GoogleAnalyticsConnectorProfileProperties {}
1362
-
1363
- export namespace GoogleAnalyticsConnectorProfileProperties {
1364
- /**
1365
- * @internal
1366
- */
1367
- export const filterSensitiveLog = (obj: GoogleAnalyticsConnectorProfileProperties): any => ({
1368
- ...obj,
1369
- });
1370
- }
1371
-
1372
- /**
1373
- * <p> The connector-specific properties required when using Amazon Honeycode. </p>
1374
- */
1375
- export interface HoneycodeConnectorProfileProperties {}
1376
-
1377
- export namespace HoneycodeConnectorProfileProperties {
1378
- /**
1379
- * @internal
1380
- */
1381
- export const filterSensitiveLog = (obj: HoneycodeConnectorProfileProperties): any => ({
1382
- ...obj,
1383
- });
1384
- }
1385
-
1386
- /**
1387
- * <p> The connector-specific profile properties required by Infor Nexus. </p>
1388
- */
1389
- export interface InforNexusConnectorProfileProperties {
1390
- /**
1391
- * <p> The location of the Infor Nexus resource. </p>
1392
- */
1393
- instanceUrl: string | undefined;
1394
- }
1395
-
1396
- export namespace InforNexusConnectorProfileProperties {
1397
- /**
1398
- * @internal
1399
- */
1400
- export const filterSensitiveLog = (obj: InforNexusConnectorProfileProperties): any => ({
1401
- ...obj,
1402
- });
1403
- }
1404
-
1405
- /**
1406
- * <p> The connector-specific profile properties required when using Marketo. </p>
1407
- */
1408
- export interface MarketoConnectorProfileProperties {
1409
- /**
1410
- * <p> The location of the Marketo resource. </p>
1411
- */
1412
- instanceUrl: string | undefined;
1413
- }
1414
-
1415
- export namespace MarketoConnectorProfileProperties {
1416
- /**
1417
- * @internal
1418
- */
1419
- export const filterSensitiveLog = (obj: MarketoConnectorProfileProperties): any => ({
1420
- ...obj,
1421
- });
1422
- }
1423
-
1424
- /**
1425
- * <p> The connector-specific profile properties when using Amazon Redshift. </p>
1426
- */
1427
- export interface RedshiftConnectorProfileProperties {
1428
- /**
1429
- * <p> The JDBC URL of the Amazon Redshift cluster. </p>
1430
- */
1431
- databaseUrl: string | undefined;
1432
-
1433
- /**
1434
- * <p> A name for the associated Amazon S3 bucket. </p>
1435
- */
1436
- bucketName: string | undefined;
1437
-
1438
- /**
1439
- * <p> The object key for the destination bucket in which Amazon AppFlow places the files.
1440
- * </p>
1441
- */
1442
- bucketPrefix?: string;
1443
-
1444
- /**
1445
- * <p> The Amazon Resource Name (ARN) of the IAM role. </p>
1446
- */
1447
- roleArn: string | undefined;
1448
- }
1449
-
1450
- export namespace RedshiftConnectorProfileProperties {
1451
- /**
1452
- * @internal
1453
- */
1454
- export const filterSensitiveLog = (obj: RedshiftConnectorProfileProperties): any => ({
1455
- ...obj,
1456
- });
1457
- }
1458
-
1459
- /**
1460
- * <p> The connector-specific profile properties required when using Salesforce. </p>
1461
- */
1462
- export interface SalesforceConnectorProfileProperties {
1463
- /**
1464
- * <p> The location of the Salesforce resource. </p>
1465
- */
1466
- instanceUrl?: string;
1467
-
1468
- /**
1469
- * <p> Indicates whether the connector profile applies to a sandbox or production environment.
1470
- * </p>
1471
- */
1472
- isSandboxEnvironment?: boolean;
1473
- }
1474
-
1475
- export namespace SalesforceConnectorProfileProperties {
1476
- /**
1477
- * @internal
1478
- */
1479
- export const filterSensitiveLog = (obj: SalesforceConnectorProfileProperties): any => ({
1480
- ...obj,
1481
- });
1482
- }
1483
-
1484
- /**
1485
- * <p> The OAuth properties required for OAuth type authentication. </p>
1486
- */
1487
- export interface OAuthProperties {
1488
- /**
1489
- * <p> The token url required to fetch access/refresh tokens using authorization code and also to refresh expired
1490
- * access token using refresh token.</p>
1491
- */
1492
- tokenUrl: string | undefined;
1493
-
1494
- /**
1495
- * <p> The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type
1496
- * authentication. </p>
1497
- */
1498
- authCodeUrl: string | undefined;
1499
-
1500
- /**
1501
- * <p> The OAuth scopes required for OAuth type authentication. </p>
1502
- */
1503
- oAuthScopes: string[] | undefined;
1504
- }
1505
-
1506
- export namespace OAuthProperties {
1507
- /**
1508
- * @internal
1509
- */
1510
- export const filterSensitiveLog = (obj: OAuthProperties): any => ({
1511
- ...obj,
1512
- });
1513
- }
1514
-
1515
- /**
1516
- * <p> The connector-specific profile properties required when using SAPOData. </p>
1517
- */
1518
- export interface SAPODataConnectorProfileProperties {
1519
- /**
1520
- * <p> The location of the SAPOData resource. </p>
1521
- */
1522
- applicationHostUrl: string | undefined;
1523
-
1524
- /**
1525
- * <p> The application path to catalog service. </p>
1526
- */
1527
- applicationServicePath: string | undefined;
1528
-
1529
- /**
1530
- * <p> The port number of the SAPOData instance. </p>
1531
- */
1532
- portNumber: number | undefined;
1533
-
1534
- /**
1535
- * <p> The client number for the client creating the connection. </p>
1536
- */
1537
- clientNumber: string | undefined;
1538
-
1539
- /**
1540
- * <p> The logon language of SAPOData instance. </p>
1541
- */
1542
- logonLanguage?: string;
1543
-
1544
- /**
1545
- * <p> The SAPOData Private Link service name to be used for private data transfers. </p>
1546
- */
1547
- privateLinkServiceName?: string;
1548
-
1549
- /**
1550
- * <p> The SAPOData OAuth properties required for OAuth type authentication. </p>
1551
- */
1552
- oAuthProperties?: OAuthProperties;
1553
- }
1554
-
1555
- export namespace SAPODataConnectorProfileProperties {
1556
- /**
1557
- * @internal
1558
- */
1559
- export const filterSensitiveLog = (obj: SAPODataConnectorProfileProperties): any => ({
1560
- ...obj,
1561
- });
1562
- }
1563
-
1564
- /**
1565
- * <p> The connector-specific profile properties required when using ServiceNow. </p>
1566
- */
1567
- export interface ServiceNowConnectorProfileProperties {
1568
- /**
1569
- * <p> The location of the ServiceNow resource. </p>
1570
- */
1571
- instanceUrl: string | undefined;
1572
- }
1573
-
1574
- export namespace ServiceNowConnectorProfileProperties {
1575
- /**
1576
- * @internal
1577
- */
1578
- export const filterSensitiveLog = (obj: ServiceNowConnectorProfileProperties): any => ({
1579
- ...obj,
1580
- });
1581
- }
1582
-
1583
- /**
1584
- * <p> The connector-specific profile properties required when using Singular. </p>
1585
- */
1586
- export interface SingularConnectorProfileProperties {}
1587
-
1588
- export namespace SingularConnectorProfileProperties {
1589
- /**
1590
- * @internal
1591
- */
1592
- export const filterSensitiveLog = (obj: SingularConnectorProfileProperties): any => ({
1593
- ...obj,
1594
- });
1595
- }
1596
-
1597
- /**
1598
- * <p> The connector-specific profile properties required when using Slack. </p>
1599
- */
1600
- export interface SlackConnectorProfileProperties {
1601
- /**
1602
- * <p> The location of the Slack resource. </p>
1603
- */
1604
- instanceUrl: string | undefined;
1605
- }
1606
-
1607
- export namespace SlackConnectorProfileProperties {
1608
- /**
1609
- * @internal
1610
- */
1611
- export const filterSensitiveLog = (obj: SlackConnectorProfileProperties): any => ({
1612
- ...obj,
1613
- });
1614
- }
1615
-
1616
- /**
1617
- * <p> The connector-specific profile properties required when using Snowflake. </p>
1618
- */
1619
- export interface SnowflakeConnectorProfileProperties {
1620
- /**
1621
- * <p> The name of the Snowflake warehouse. </p>
1622
- */
1623
- warehouse: string | undefined;
1624
-
1625
- /**
1626
- * <p> The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in
1627
- * the Snowflake account. This is written in the following format: < Database><
1628
- * Schema><Stage Name>. </p>
1629
- */
1630
- stage: string | undefined;
1631
-
1632
- /**
1633
- * <p> The name of the Amazon S3 bucket associated with Snowflake. </p>
1634
- */
1635
- bucketName: string | undefined;
1636
-
1637
- /**
1638
- * <p> The bucket path that refers to the Amazon S3 bucket associated with Snowflake. </p>
1639
- */
1640
- bucketPrefix?: string;
1641
-
1642
- /**
1643
- * <p> The Snowflake Private Link service name to be used for private data transfers. </p>
1644
- */
1645
- privateLinkServiceName?: string;
1646
-
1647
- /**
1648
- * <p> The name of the account. </p>
1649
- */
1650
- accountName?: string;
1651
-
1652
- /**
1653
- * <p> The Amazon Web Services Region of the Snowflake account. </p>
1654
- */
1655
- region?: string;
1656
- }
1657
-
1658
- export namespace SnowflakeConnectorProfileProperties {
1659
- /**
1660
- * @internal
1661
- */
1662
- export const filterSensitiveLog = (obj: SnowflakeConnectorProfileProperties): any => ({
1663
- ...obj,
1664
- });
1665
- }
1666
-
1667
- /**
1668
- * <p> The connector-specific profile properties required when using Trend Micro. </p>
1669
- */
1670
- export interface TrendmicroConnectorProfileProperties {}
1671
-
1672
- export namespace TrendmicroConnectorProfileProperties {
1673
- /**
1674
- * @internal
1675
- */
1676
- export const filterSensitiveLog = (obj: TrendmicroConnectorProfileProperties): any => ({
1677
- ...obj,
1678
- });
1679
- }
1680
-
1681
- /**
1682
- * <p> The connector-specific profile properties required when using Veeva. </p>
1683
- */
1684
- export interface VeevaConnectorProfileProperties {
1685
- /**
1686
- * <p> The location of the Veeva resource. </p>
1687
- */
1688
- instanceUrl: string | undefined;
1689
- }
1690
-
1691
- export namespace VeevaConnectorProfileProperties {
1692
- /**
1693
- * @internal
1694
- */
1695
- export const filterSensitiveLog = (obj: VeevaConnectorProfileProperties): any => ({
1696
- ...obj,
1697
- });
1698
- }
1699
-
1700
- /**
1701
- * <p> The connector-specific profile properties required when using Zendesk. </p>
1702
- */
1703
- export interface ZendeskConnectorProfileProperties {
1704
- /**
1705
- * <p> The location of the Zendesk resource. </p>
1706
- */
1707
- instanceUrl: string | undefined;
1708
- }
1709
-
1710
- export namespace ZendeskConnectorProfileProperties {
1711
- /**
1712
- * @internal
1713
- */
1714
- export const filterSensitiveLog = (obj: ZendeskConnectorProfileProperties): any => ({
1715
- ...obj,
1716
- });
1717
- }
1718
-
1719
- /**
1720
- * <p> The connector-specific profile properties required by each connector. </p>
1721
- */
1722
- export interface ConnectorProfileProperties {
1723
- /**
1724
- * <p> The connector-specific properties required by Amplitude. </p>
1725
- */
1726
- Amplitude?: AmplitudeConnectorProfileProperties;
1727
-
1728
- /**
1729
- * <p> The connector-specific properties required by Datadog. </p>
1730
- */
1731
- Datadog?: DatadogConnectorProfileProperties;
1732
-
1733
- /**
1734
- * <p> The connector-specific properties required by Dynatrace. </p>
1735
- */
1736
- Dynatrace?: DynatraceConnectorProfileProperties;
1737
-
1738
- /**
1739
- * <p> The connector-specific properties required Google Analytics. </p>
1740
- */
1741
- GoogleAnalytics?: GoogleAnalyticsConnectorProfileProperties;
1742
-
1743
- /**
1744
- * <p> The connector-specific properties required by Amazon Honeycode. </p>
1745
- */
1746
- Honeycode?: HoneycodeConnectorProfileProperties;
1747
-
1748
- /**
1749
- * <p> The connector-specific properties required by Infor Nexus. </p>
1750
- */
1751
- InforNexus?: InforNexusConnectorProfileProperties;
1752
-
1753
- /**
1754
- * <p> The connector-specific properties required by Marketo. </p>
1755
- */
1756
- Marketo?: MarketoConnectorProfileProperties;
1757
-
1758
- /**
1759
- * <p> The connector-specific properties required by Amazon Redshift. </p>
1760
- */
1761
- Redshift?: RedshiftConnectorProfileProperties;
1762
-
1763
- /**
1764
- * <p> The connector-specific properties required by Salesforce. </p>
1765
- */
1766
- Salesforce?: SalesforceConnectorProfileProperties;
1767
-
1768
- /**
1769
- * <p> The connector-specific properties required by serviceNow. </p>
1770
- */
1771
- ServiceNow?: ServiceNowConnectorProfileProperties;
1772
-
1773
- /**
1774
- * <p> The connector-specific properties required by Singular. </p>
1775
- */
1776
- Singular?: SingularConnectorProfileProperties;
1777
-
1778
- /**
1779
- * <p> The connector-specific properties required by Slack. </p>
1780
- */
1781
- Slack?: SlackConnectorProfileProperties;
1782
-
1783
- /**
1784
- * <p> The connector-specific properties required by Snowflake. </p>
1785
- */
1786
- Snowflake?: SnowflakeConnectorProfileProperties;
1787
-
1788
- /**
1789
- * <p> The connector-specific properties required by Trend Micro. </p>
1790
- */
1791
- Trendmicro?: TrendmicroConnectorProfileProperties;
1792
-
1793
- /**
1794
- * <p> The connector-specific properties required by Veeva. </p>
1795
- */
1796
- Veeva?: VeevaConnectorProfileProperties;
1797
-
1798
- /**
1799
- * <p> The connector-specific properties required by Zendesk. </p>
1800
- */
1801
- Zendesk?: ZendeskConnectorProfileProperties;
1802
-
1803
- /**
1804
- * <p> The connector-specific profile properties required when using SAPOData. </p>
1805
- */
1806
- SAPOData?: SAPODataConnectorProfileProperties;
1807
- }
1808
-
1809
- export namespace ConnectorProfileProperties {
1810
- /**
1811
- * @internal
1812
- */
1813
- export const filterSensitiveLog = (obj: ConnectorProfileProperties): any => ({
1814
- ...obj,
1815
- });
1816
- }
1817
-
1818
- export enum PrivateConnectionProvisioningFailureCause {
1819
- ACCESS_DENIED = "ACCESS_DENIED",
1820
- CONNECTOR_AUTHENTICATION = "CONNECTOR_AUTHENTICATION",
1821
- CONNECTOR_SERVER = "CONNECTOR_SERVER",
1822
- INTERNAL_SERVER = "INTERNAL_SERVER",
1823
- VALIDATION = "VALIDATION",
1824
- }
1825
-
1826
- export enum PrivateConnectionProvisioningStatus {
1827
- CREATED = "CREATED",
1828
- FAILED = "FAILED",
1829
- PENDING = "PENDING",
1830
- }
1831
-
1832
- /**
1833
- * <p> Specifies the private connection provisioning state. </p>
1834
- */
1835
- export interface PrivateConnectionProvisioningState {
1836
- /**
1837
- * <p> Specifies the private connection provisioning status. </p>
1838
- */
1839
- status?: PrivateConnectionProvisioningStatus | string;
1840
-
1841
- /**
1842
- * <p> Specifies the private connection provisioning failure reason. </p>
1843
- */
1844
- failureMessage?: string;
1845
-
1846
- /**
1847
- * <p> Specifies the private connection provisioning failure cause. </p>
1848
- */
1849
- failureCause?: PrivateConnectionProvisioningFailureCause | string;
1850
- }
1851
-
1852
- export namespace PrivateConnectionProvisioningState {
1853
- /**
1854
- * @internal
1855
- */
1856
- export const filterSensitiveLog = (obj: PrivateConnectionProvisioningState): any => ({
1857
- ...obj,
1858
- });
1859
- }
1860
-
1861
- /**
1862
- * <p> Describes an instance of a connector. This includes the provided name, credentials ARN,
1863
- * connection-mode, and so on. To keep the API intuitive and extensible, the fields that are
1864
- * common to all types of connector profiles are explicitly specified at the top level. The rest
1865
- * of the connector-specific properties are available via the
1866
- * <code>connectorProfileProperties</code> field. </p>
1867
- */
1868
- export interface ConnectorProfile {
1869
- /**
1870
- * <p> The Amazon Resource Name (ARN) of the connector profile. </p>
1871
- */
1872
- connectorProfileArn?: string;
1873
-
1874
- /**
1875
- * <p> The name of the connector profile. The name is unique for each
1876
- * <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
1877
- */
1878
- connectorProfileName?: string;
1879
-
1880
- /**
1881
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
1882
- */
1883
- connectorType?: ConnectorType | string;
1884
-
1885
- /**
1886
- * <p> Indicates the connection mode and if it is public or private. </p>
1887
- */
1888
- connectionMode?: ConnectionMode | string;
1889
-
1890
- /**
1891
- * <p> The Amazon Resource Name (ARN) of the connector profile credentials. </p>
1892
- */
1893
- credentialsArn?: string;
1894
-
1895
- /**
1896
- * <p> The connector-specific properties of the profile configuration. </p>
1897
- */
1898
- connectorProfileProperties?: ConnectorProfileProperties;
1899
-
1900
- /**
1901
- * <p> Specifies when the connector profile was created. </p>
1902
- */
1903
- createdAt?: Date;
1904
-
1905
- /**
1906
- * <p> Specifies when the connector profile was last updated. </p>
1907
- */
1908
- lastUpdatedAt?: Date;
1909
-
1910
- /**
1911
- * <p> Specifies the private connection provisioning state. </p>
1912
- */
1913
- privateConnectionProvisioningState?: PrivateConnectionProvisioningState;
1914
- }
1915
-
1916
- export namespace ConnectorProfile {
1917
- /**
1918
- * @internal
1919
- */
1920
- export const filterSensitiveLog = (obj: ConnectorProfile): any => ({
1921
- ...obj,
1922
- });
1923
- }
1924
-
1925
- /**
1926
- * <p> The connector-specific credentials required by Datadog. </p>
1927
- */
1928
- export interface DatadogConnectorProfileCredentials {
1929
- /**
1930
- * <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
1931
- * program to your API. </p>
1932
- */
1933
- apiKey: string | undefined;
1934
-
1935
- /**
1936
- * <p> Application keys, in conjunction with your API key, give you full access to Datadog’s
1937
- * programmatic API. Application keys are associated with the user account that created them. The
1938
- * application key is used to log all requests made to the API. </p>
1939
- */
1940
- applicationKey: string | undefined;
1941
- }
1942
-
1943
- export namespace DatadogConnectorProfileCredentials {
1944
- /**
1945
- * @internal
1946
- */
1947
- export const filterSensitiveLog = (obj: DatadogConnectorProfileCredentials): any => ({
1948
- ...obj,
1949
- });
1950
- }
1951
-
1952
- /**
1953
- * <p> The connector-specific profile credentials required by Dynatrace. </p>
1954
- */
1955
- export interface DynatraceConnectorProfileCredentials {
1956
- /**
1957
- * <p> The API tokens used by Dynatrace API to authenticate various API calls. </p>
1958
- */
1959
- apiToken: string | undefined;
1960
- }
1961
-
1962
- export namespace DynatraceConnectorProfileCredentials {
1963
- /**
1964
- * @internal
1965
- */
1966
- export const filterSensitiveLog = (obj: DynatraceConnectorProfileCredentials): any => ({
1967
- ...obj,
1968
- });
1969
- }
1970
-
1971
- /**
1972
- * <p> The connector-specific profile credentials required by Google Analytics. </p>
1973
- */
1974
- export interface GoogleAnalyticsConnectorProfileCredentials {
1975
- /**
1976
- * <p> The identifier for the desired client. </p>
1977
- */
1978
- clientId: string | undefined;
1979
-
1980
- /**
1981
- * <p> The client secret used by the OAuth client to authenticate to the authorization server.
1982
- * </p>
1983
- */
1984
- clientSecret: string | undefined;
1985
-
1986
- /**
1987
- * <p> The credentials used to access protected Google Analytics resources. </p>
1988
- */
1989
- accessToken?: string;
1990
-
1991
- /**
1992
- * <p> The credentials used to acquire new access tokens. This is required only for OAuth2
1993
- * access tokens, and is not required for OAuth1 access tokens. </p>
1994
- */
1995
- refreshToken?: string;
1996
-
1997
- /**
1998
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
1999
- * </p>
2000
- */
2001
- oAuthRequest?: ConnectorOAuthRequest;
2002
- }
2003
-
2004
- export namespace GoogleAnalyticsConnectorProfileCredentials {
2005
- /**
2006
- * @internal
2007
- */
2008
- export const filterSensitiveLog = (obj: GoogleAnalyticsConnectorProfileCredentials): any => ({
2009
- ...obj,
2010
- ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }),
2011
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2012
- });
2013
- }
2014
-
2015
- /**
2016
- * <p> The connector-specific credentials required when using Amazon Honeycode. </p>
2017
- */
2018
- export interface HoneycodeConnectorProfileCredentials {
2019
- /**
2020
- * <p> The credentials used to access protected Amazon Honeycode resources. </p>
2021
- */
2022
- accessToken?: string;
2023
-
2024
- /**
2025
- * <p> The credentials used to acquire new access tokens. </p>
2026
- */
2027
- refreshToken?: string;
2028
-
2029
- /**
2030
- * <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
2031
- * Google Analytics, Marketo, Zendesk, and Slack. </p>
2032
- */
2033
- oAuthRequest?: ConnectorOAuthRequest;
2034
- }
2035
-
2036
- export namespace HoneycodeConnectorProfileCredentials {
2037
- /**
2038
- * @internal
2039
- */
2040
- export const filterSensitiveLog = (obj: HoneycodeConnectorProfileCredentials): any => ({
2041
- ...obj,
2042
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2043
- });
2044
- }
2045
-
2046
- /**
2047
- * <p> The connector-specific profile credentials required by Infor Nexus. </p>
2048
- */
2049
- export interface InforNexusConnectorProfileCredentials {
2050
- /**
2051
- * <p> The Access Key portion of the credentials. </p>
2052
- */
2053
- accessKeyId: string | undefined;
2054
-
2055
- /**
2056
- * <p> The identifier for the user. </p>
2057
- */
2058
- userId: string | undefined;
2059
-
2060
- /**
2061
- * <p> The secret key used to sign requests. </p>
2062
- */
2063
- secretAccessKey: string | undefined;
2064
-
2065
- /**
2066
- * <p> The encryption keys used to encrypt data. </p>
2067
- */
2068
- datakey: string | undefined;
2069
- }
2070
-
2071
- export namespace InforNexusConnectorProfileCredentials {
2072
- /**
2073
- * @internal
2074
- */
2075
- export const filterSensitiveLog = (obj: InforNexusConnectorProfileCredentials): any => ({
2076
- ...obj,
2077
- ...(obj.accessKeyId && { accessKeyId: SENSITIVE_STRING }),
2078
- });
2079
- }
2080
-
2081
- /**
2082
- * <p> The connector-specific profile credentials required by Marketo. </p>
2083
- */
2084
- export interface MarketoConnectorProfileCredentials {
2085
- /**
2086
- * <p> The identifier for the desired client. </p>
2087
- */
2088
- clientId: string | undefined;
2089
-
2090
- /**
2091
- * <p> The client secret used by the OAuth client to authenticate to the authorization server.
2092
- * </p>
2093
- */
2094
- clientSecret: string | undefined;
2095
-
2096
- /**
2097
- * <p> The credentials used to access protected Marketo resources. </p>
2098
- */
2099
- accessToken?: string;
2100
-
2101
- /**
2102
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
2103
- * </p>
2104
- */
2105
- oAuthRequest?: ConnectorOAuthRequest;
2106
- }
2107
-
2108
- export namespace MarketoConnectorProfileCredentials {
2109
- /**
2110
- * @internal
2111
- */
2112
- export const filterSensitiveLog = (obj: MarketoConnectorProfileCredentials): any => ({
2113
- ...obj,
2114
- ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }),
2115
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2116
- });
2117
- }
2118
-
2119
- /**
2120
- * <p> The connector-specific profile credentials required when using Amazon Redshift. </p>
2121
- */
2122
- export interface RedshiftConnectorProfileCredentials {
2123
- /**
2124
- * <p> The name of the user. </p>
2125
- */
2126
- username: string | undefined;
2127
-
2128
- /**
2129
- * <p> The password that corresponds to the user name. </p>
2130
- */
2131
- password: string | undefined;
2132
- }
2133
-
2134
- export namespace RedshiftConnectorProfileCredentials {
2135
- /**
2136
- * @internal
2137
- */
2138
- export const filterSensitiveLog = (obj: RedshiftConnectorProfileCredentials): any => ({
2139
- ...obj,
2140
- ...(obj.password && { password: SENSITIVE_STRING }),
2141
- });
2142
- }
2143
-
2144
- /**
2145
- * <p> The connector-specific profile credentials required when using Salesforce. </p>
2146
- */
2147
- export interface SalesforceConnectorProfileCredentials {
2148
- /**
2149
- * <p> The credentials used to access protected Salesforce resources. </p>
2150
- */
2151
- accessToken?: string;
2152
-
2153
- /**
2154
- * <p> The credentials used to acquire new access tokens. </p>
2155
- */
2156
- refreshToken?: string;
2157
-
2158
- /**
2159
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
2160
- * </p>
2161
- */
2162
- oAuthRequest?: ConnectorOAuthRequest;
2163
-
2164
- /**
2165
- * <p> The secret manager ARN, which contains the client ID and client secret of the connected
2166
- * app. </p>
2167
- */
2168
- clientCredentialsArn?: string;
2169
- }
2170
-
2171
- export namespace SalesforceConnectorProfileCredentials {
2172
- /**
2173
- * @internal
2174
- */
2175
- export const filterSensitiveLog = (obj: SalesforceConnectorProfileCredentials): any => ({
2176
- ...obj,
2177
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2178
- ...(obj.clientCredentialsArn && { clientCredentialsArn: SENSITIVE_STRING }),
2179
- });
2180
- }
2181
-
2182
- /**
2183
- * <p> The OAuth credentials required for OAuth type authentication. </p>
2184
- */
2185
- export interface OAuthCredentials {
2186
- /**
2187
- * <p> The identifier for the desired client. </p>
2188
- */
2189
- clientId: string | undefined;
2190
-
2191
- /**
2192
- * <p> The client secret used by the OAuth client to authenticate to the authorization server.
2193
- * </p>
2194
- */
2195
- clientSecret: string | undefined;
2196
-
2197
- /**
2198
- * <p> The access token used to access protected SAPOData resources. </p>
2199
- */
2200
- accessToken?: string;
2201
-
2202
- /**
2203
- * <p> The refresh token used to refresh expired access token. </p>
2204
- */
2205
- refreshToken?: string;
2206
-
2207
- /**
2208
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
2209
- * </p>
2210
- */
2211
- oAuthRequest?: ConnectorOAuthRequest;
2212
- }
2213
-
2214
- export namespace OAuthCredentials {
2215
- /**
2216
- * @internal
2217
- */
2218
- export const filterSensitiveLog = (obj: OAuthCredentials): any => ({
2219
- ...obj,
2220
- ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }),
2221
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2222
- });
2223
- }
2224
-
2225
- /**
2226
- * <p> The connector-specific profile credentials required when using SAPOData. </p>
2227
- */
2228
- export interface SAPODataConnectorProfileCredentials {
2229
- /**
2230
- * <p> The SAPOData basic authentication credentials. </p>
2231
- */
2232
- basicAuthCredentials?: BasicAuthCredentials;
2233
-
2234
- /**
2235
- * <p> The SAPOData OAuth type authentication credentials. </p>
2236
- */
2237
- oAuthCredentials?: OAuthCredentials;
2238
- }
2239
-
2240
- export namespace SAPODataConnectorProfileCredentials {
2241
- /**
2242
- * @internal
2243
- */
2244
- export const filterSensitiveLog = (obj: SAPODataConnectorProfileCredentials): any => ({
2245
- ...obj,
2246
- ...(obj.basicAuthCredentials && {
2247
- basicAuthCredentials: BasicAuthCredentials.filterSensitiveLog(obj.basicAuthCredentials),
2248
- }),
2249
- ...(obj.oAuthCredentials && { oAuthCredentials: OAuthCredentials.filterSensitiveLog(obj.oAuthCredentials) }),
2250
- });
2251
- }
2252
-
2253
- /**
2254
- * <p> The connector-specific profile credentials required when using ServiceNow. </p>
2255
- */
2256
- export interface ServiceNowConnectorProfileCredentials {
2257
- /**
2258
- * <p> The name of the user. </p>
2259
- */
2260
- username: string | undefined;
2261
-
2262
- /**
2263
- * <p> The password that corresponds to the user name. </p>
2264
- */
2265
- password: string | undefined;
2266
- }
2267
-
2268
- export namespace ServiceNowConnectorProfileCredentials {
2269
- /**
2270
- * @internal
2271
- */
2272
- export const filterSensitiveLog = (obj: ServiceNowConnectorProfileCredentials): any => ({
2273
- ...obj,
2274
- ...(obj.password && { password: SENSITIVE_STRING }),
2275
- });
2276
- }
2277
-
2278
- /**
2279
- * <p> The connector-specific profile credentials required when using Singular. </p>
2280
- */
2281
- export interface SingularConnectorProfileCredentials {
2282
- /**
2283
- * <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
2284
- * program to your API. </p>
2285
- */
2286
- apiKey: string | undefined;
2287
- }
2288
-
2289
- export namespace SingularConnectorProfileCredentials {
2290
- /**
2291
- * @internal
2292
- */
2293
- export const filterSensitiveLog = (obj: SingularConnectorProfileCredentials): any => ({
2294
- ...obj,
2295
- });
2296
- }
2297
-
2298
- /**
2299
- * <p> The connector-specific profile credentials required when using Slack. </p>
2300
- */
2301
- export interface SlackConnectorProfileCredentials {
2302
- /**
2303
- * <p> The identifier for the client. </p>
2304
- */
2305
- clientId: string | undefined;
2306
-
2307
- /**
2308
- * <p> The client secret used by the OAuth client to authenticate to the authorization server.
2309
- * </p>
2310
- */
2311
- clientSecret: string | undefined;
2312
-
2313
- /**
2314
- * <p> The credentials used to access protected Slack resources. </p>
2315
- */
2316
- accessToken?: string;
2317
-
2318
- /**
2319
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
2320
- * </p>
2321
- */
2322
- oAuthRequest?: ConnectorOAuthRequest;
2323
- }
2324
-
2325
- export namespace SlackConnectorProfileCredentials {
2326
- /**
2327
- * @internal
2328
- */
2329
- export const filterSensitiveLog = (obj: SlackConnectorProfileCredentials): any => ({
2330
- ...obj,
2331
- ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }),
2332
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2333
- });
2334
- }
2335
-
2336
- /**
2337
- * <p> The connector-specific profile credentials required when using Snowflake. </p>
2338
- */
2339
- export interface SnowflakeConnectorProfileCredentials {
2340
- /**
2341
- * <p> The name of the user. </p>
2342
- */
2343
- username: string | undefined;
2344
-
2345
- /**
2346
- * <p> The password that corresponds to the user name. </p>
2347
- */
2348
- password: string | undefined;
2349
- }
2350
-
2351
- export namespace SnowflakeConnectorProfileCredentials {
2352
- /**
2353
- * @internal
2354
- */
2355
- export const filterSensitiveLog = (obj: SnowflakeConnectorProfileCredentials): any => ({
2356
- ...obj,
2357
- ...(obj.password && { password: SENSITIVE_STRING }),
2358
- });
2359
- }
2360
-
2361
- /**
2362
- * <p> The connector-specific profile credentials required when using Trend Micro. </p>
2363
- */
2364
- export interface TrendmicroConnectorProfileCredentials {
2365
- /**
2366
- * <p> The Secret Access Key portion of the credentials. </p>
2367
- */
2368
- apiSecretKey: string | undefined;
2369
- }
2370
-
2371
- export namespace TrendmicroConnectorProfileCredentials {
2372
- /**
2373
- * @internal
2374
- */
2375
- export const filterSensitiveLog = (obj: TrendmicroConnectorProfileCredentials): any => ({
2376
- ...obj,
2377
- ...(obj.apiSecretKey && { apiSecretKey: SENSITIVE_STRING }),
2378
- });
2379
- }
2380
-
2381
- /**
2382
- * <p> The connector-specific profile credentials required when using Veeva. </p>
2383
- */
2384
- export interface VeevaConnectorProfileCredentials {
2385
- /**
2386
- * <p> The name of the user. </p>
2387
- */
2388
- username: string | undefined;
2389
-
2390
- /**
2391
- * <p> The password that corresponds to the user name. </p>
2392
- */
2393
- password: string | undefined;
2394
- }
2395
-
2396
- export namespace VeevaConnectorProfileCredentials {
2397
- /**
2398
- * @internal
2399
- */
2400
- export const filterSensitiveLog = (obj: VeevaConnectorProfileCredentials): any => ({
2401
- ...obj,
2402
- ...(obj.password && { password: SENSITIVE_STRING }),
2403
- });
2404
- }
2405
-
2406
- /**
2407
- * <p> The connector-specific profile credentials required when using Zendesk. </p>
2408
- */
2409
- export interface ZendeskConnectorProfileCredentials {
2410
- /**
2411
- * <p> The identifier for the desired client. </p>
2412
- */
2413
- clientId: string | undefined;
2414
-
2415
- /**
2416
- * <p> The client secret used by the OAuth client to authenticate to the authorization server.
2417
- * </p>
2418
- */
2419
- clientSecret: string | undefined;
2420
-
2421
- /**
2422
- * <p> The credentials used to access protected Zendesk resources. </p>
2423
- */
2424
- accessToken?: string;
2425
-
2426
- /**
2427
- * <p> The OAuth requirement needed to request security tokens from the connector endpoint.
2428
- * </p>
2429
- */
2430
- oAuthRequest?: ConnectorOAuthRequest;
2431
- }
2432
-
2433
- export namespace ZendeskConnectorProfileCredentials {
2434
- /**
2435
- * @internal
2436
- */
2437
- export const filterSensitiveLog = (obj: ZendeskConnectorProfileCredentials): any => ({
2438
- ...obj,
2439
- ...(obj.clientSecret && { clientSecret: SENSITIVE_STRING }),
2440
- ...(obj.accessToken && { accessToken: SENSITIVE_STRING }),
2441
- });
2442
- }
2443
-
2444
- /**
2445
- * <p> The connector-specific credentials required by a connector. </p>
2446
- */
2447
- export interface ConnectorProfileCredentials {
2448
- /**
2449
- * <p> The connector-specific credentials required when using Amplitude. </p>
2450
- */
2451
- Amplitude?: AmplitudeConnectorProfileCredentials;
2452
-
2453
- /**
2454
- * <p> The connector-specific credentials required when using Datadog. </p>
2455
- */
2456
- Datadog?: DatadogConnectorProfileCredentials;
2457
-
2458
- /**
2459
- * <p> The connector-specific credentials required when using Dynatrace. </p>
2460
- */
2461
- Dynatrace?: DynatraceConnectorProfileCredentials;
2462
-
2463
- /**
2464
- * <p> The connector-specific credentials required when using Google Analytics. </p>
2465
- */
2466
- GoogleAnalytics?: GoogleAnalyticsConnectorProfileCredentials;
2467
-
2468
- /**
2469
- * <p> The connector-specific credentials required when using Amazon Honeycode. </p>
2470
- */
2471
- Honeycode?: HoneycodeConnectorProfileCredentials;
2472
-
2473
- /**
2474
- * <p> The connector-specific credentials required when using Infor Nexus. </p>
2475
- */
2476
- InforNexus?: InforNexusConnectorProfileCredentials;
2477
-
2478
- /**
2479
- * <p> The connector-specific credentials required when using Marketo. </p>
2480
- */
2481
- Marketo?: MarketoConnectorProfileCredentials;
2482
-
2483
- /**
2484
- * <p> The connector-specific credentials required when using Amazon Redshift. </p>
2485
- */
2486
- Redshift?: RedshiftConnectorProfileCredentials;
2487
-
2488
- /**
2489
- * <p> The connector-specific credentials required when using Salesforce. </p>
2490
- */
2491
- Salesforce?: SalesforceConnectorProfileCredentials;
2492
-
2493
- /**
2494
- * <p> The connector-specific credentials required when using ServiceNow. </p>
2495
- */
2496
- ServiceNow?: ServiceNowConnectorProfileCredentials;
2497
-
2498
- /**
2499
- * <p> The connector-specific credentials required when using Singular. </p>
2500
- */
2501
- Singular?: SingularConnectorProfileCredentials;
2502
-
2503
- /**
2504
- * <p> The connector-specific credentials required when using Slack. </p>
2505
- */
2506
- Slack?: SlackConnectorProfileCredentials;
2507
-
2508
- /**
2509
- * <p> The connector-specific credentials required when using Snowflake. </p>
2510
- */
2511
- Snowflake?: SnowflakeConnectorProfileCredentials;
2512
-
2513
- /**
2514
- * <p> The connector-specific credentials required when using Trend Micro. </p>
2515
- */
2516
- Trendmicro?: TrendmicroConnectorProfileCredentials;
2517
-
2518
- /**
2519
- * <p> The connector-specific credentials required when using Veeva. </p>
2520
- */
2521
- Veeva?: VeevaConnectorProfileCredentials;
2522
-
2523
- /**
2524
- * <p> The connector-specific credentials required when using Zendesk. </p>
2525
- */
2526
- Zendesk?: ZendeskConnectorProfileCredentials;
2527
-
2528
- /**
2529
- * <p> The connector-specific profile credentials required when using SAPOData. </p>
2530
- */
2531
- SAPOData?: SAPODataConnectorProfileCredentials;
2532
- }
2533
-
2534
- export namespace ConnectorProfileCredentials {
2535
- /**
2536
- * @internal
2537
- */
2538
- export const filterSensitiveLog = (obj: ConnectorProfileCredentials): any => ({
2539
- ...obj,
2540
- ...(obj.Amplitude && { Amplitude: AmplitudeConnectorProfileCredentials.filterSensitiveLog(obj.Amplitude) }),
2541
- ...(obj.GoogleAnalytics && {
2542
- GoogleAnalytics: GoogleAnalyticsConnectorProfileCredentials.filterSensitiveLog(obj.GoogleAnalytics),
2543
- }),
2544
- ...(obj.Honeycode && { Honeycode: HoneycodeConnectorProfileCredentials.filterSensitiveLog(obj.Honeycode) }),
2545
- ...(obj.InforNexus && { InforNexus: InforNexusConnectorProfileCredentials.filterSensitiveLog(obj.InforNexus) }),
2546
- ...(obj.Marketo && { Marketo: MarketoConnectorProfileCredentials.filterSensitiveLog(obj.Marketo) }),
2547
- ...(obj.Redshift && { Redshift: RedshiftConnectorProfileCredentials.filterSensitiveLog(obj.Redshift) }),
2548
- ...(obj.Salesforce && { Salesforce: SalesforceConnectorProfileCredentials.filterSensitiveLog(obj.Salesforce) }),
2549
- ...(obj.ServiceNow && { ServiceNow: ServiceNowConnectorProfileCredentials.filterSensitiveLog(obj.ServiceNow) }),
2550
- ...(obj.Slack && { Slack: SlackConnectorProfileCredentials.filterSensitiveLog(obj.Slack) }),
2551
- ...(obj.Snowflake && { Snowflake: SnowflakeConnectorProfileCredentials.filterSensitiveLog(obj.Snowflake) }),
2552
- ...(obj.Trendmicro && { Trendmicro: TrendmicroConnectorProfileCredentials.filterSensitiveLog(obj.Trendmicro) }),
2553
- ...(obj.Veeva && { Veeva: VeevaConnectorProfileCredentials.filterSensitiveLog(obj.Veeva) }),
2554
- ...(obj.Zendesk && { Zendesk: ZendeskConnectorProfileCredentials.filterSensitiveLog(obj.Zendesk) }),
2555
- ...(obj.SAPOData && { SAPOData: SAPODataConnectorProfileCredentials.filterSensitiveLog(obj.SAPOData) }),
2556
- });
2557
- }
2558
-
2559
- /**
2560
- * <p> Defines the connector-specific configuration and credentials for the connector profile.
2561
- * </p>
2562
- */
2563
- export interface ConnectorProfileConfig {
2564
- /**
2565
- * <p> The connector-specific properties of the profile configuration. </p>
2566
- */
2567
- connectorProfileProperties: ConnectorProfileProperties | undefined;
2568
-
2569
- /**
2570
- * <p> The connector-specific credentials required by each connector. </p>
2571
- */
2572
- connectorProfileCredentials: ConnectorProfileCredentials | undefined;
2573
- }
2574
-
2575
- export namespace ConnectorProfileConfig {
2576
- /**
2577
- * @internal
2578
- */
2579
- export const filterSensitiveLog = (obj: ConnectorProfileConfig): any => ({
2580
- ...obj,
2581
- ...(obj.connectorProfileCredentials && {
2582
- connectorProfileCredentials: ConnectorProfileCredentials.filterSensitiveLog(obj.connectorProfileCredentials),
2583
- }),
2584
- });
2585
- }
2586
-
2587
- /**
2588
- * <p> An error occurred when retrieving data from the connector endpoint. </p>
2589
- */
2590
- export interface ConnectorServerException extends __SmithyException, $MetadataBearer {
2591
- name: "ConnectorServerException";
2592
- $fault: "client";
2593
- message?: string;
2594
- }
2595
-
2596
- export namespace ConnectorServerException {
2597
- /**
2598
- * @internal
2599
- */
2600
- export const filterSensitiveLog = (obj: ConnectorServerException): any => ({
2601
- ...obj,
2602
- });
2603
- }
2604
-
2605
- export interface CreateConnectorProfileRequest {
2606
- /**
2607
- * <p> The name of the connector profile. The name is unique for each
2608
- * <code>ConnectorProfile</code> in your Amazon Web Services account. </p>
2609
- */
2610
- connectorProfileName: string | undefined;
2611
-
2612
- /**
2613
- * <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
2614
- * encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If
2615
- * you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
2616
- * </p>
2617
- */
2618
- kmsArn?: string;
2619
-
2620
- /**
2621
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
2622
- */
2623
- connectorType: ConnectorType | string | undefined;
2624
-
2625
- /**
2626
- * <p> Indicates the connection mode and specifies whether it is public or private. Private
2627
- * flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the
2628
- * public internet. </p>
2629
- */
2630
- connectionMode: ConnectionMode | string | undefined;
2631
-
2632
- /**
2633
- * <p> Defines the connector-specific configuration and credentials. </p>
2634
- */
2635
- connectorProfileConfig: ConnectorProfileConfig | undefined;
2636
- }
2637
-
2638
- export namespace CreateConnectorProfileRequest {
2639
- /**
2640
- * @internal
2641
- */
2642
- export const filterSensitiveLog = (obj: CreateConnectorProfileRequest): any => ({
2643
- ...obj,
2644
- });
2645
- }
2646
-
2647
- export interface CreateConnectorProfileResponse {
2648
- /**
2649
- * <p> The Amazon Resource Name (ARN) of the connector profile. </p>
2650
- */
2651
- connectorProfileArn?: string;
2652
- }
2653
-
2654
- export namespace CreateConnectorProfileResponse {
2655
- /**
2656
- * @internal
2657
- */
2658
- export const filterSensitiveLog = (obj: CreateConnectorProfileResponse): any => ({
2659
- ...obj,
2660
- });
2661
- }
2662
-
2663
- /**
2664
- * <p> An internal service error occurred during the processing of your request. Try again
2665
- * later. </p>
2666
- */
2667
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
2668
- name: "InternalServerException";
2669
- $fault: "server";
2670
- message?: string;
2671
- }
2672
-
2673
- export namespace InternalServerException {
2674
- /**
2675
- * @internal
2676
- */
2677
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
2678
- ...obj,
2679
- });
2680
- }
2681
-
2682
- /**
2683
- * <p> The request would cause a service quota (such as the number of flows) to be exceeded.
2684
- * </p>
2685
- */
2686
- export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
2687
- name: "ServiceQuotaExceededException";
2688
- $fault: "client";
2689
- message?: string;
2690
- }
2691
-
2692
- export namespace ServiceQuotaExceededException {
2693
- /**
2694
- * @internal
2695
- */
2696
- export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({
2697
- ...obj,
2698
- });
2699
- }
2700
-
2701
- /**
2702
- * <p> The request has invalid or missing parameters. </p>
2703
- */
2704
- export interface ValidationException extends __SmithyException, $MetadataBearer {
2705
- name: "ValidationException";
2706
- $fault: "client";
2707
- message?: string;
2708
- }
2709
-
2710
- export namespace ValidationException {
2711
- /**
2712
- * @internal
2713
- */
2714
- export const filterSensitiveLog = (obj: ValidationException): any => ({
2715
- ...obj,
2716
- });
2717
- }
2718
-
2719
- /**
2720
- * <p> The properties that are applied when Amazon Connect Customer Profiles is used as a
2721
- * destination. </p>
2722
- */
2723
- export interface CustomerProfilesDestinationProperties {
2724
- /**
2725
- * <p> The unique name of the Amazon Connect Customer Profiles domain. </p>
2726
- */
2727
- domainName: string | undefined;
2728
-
2729
- /**
2730
- * <p> The object specified in the Amazon Connect Customer Profiles flow destination. </p>
2731
- */
2732
- objectTypeName?: string;
2733
- }
2734
-
2735
- export namespace CustomerProfilesDestinationProperties {
2736
- /**
2737
- * @internal
2738
- */
2739
- export const filterSensitiveLog = (obj: CustomerProfilesDestinationProperties): any => ({
2740
- ...obj,
2741
- });
2742
- }
2743
-
2744
- /**
2745
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
2746
- * destination. For example, this setting would determine if the flow should fail after one
2747
- * insertion error, or continue and attempt to insert every record regardless of the initial
2748
- * failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details.
2749
- * </p>
2750
- */
2751
- export interface ErrorHandlingConfig {
2752
- /**
2753
- * <p> Specifies if the flow should fail after the first instance of a failure when attempting
2754
- * to place data in the destination. </p>
2755
- */
2756
- failOnFirstDestinationError?: boolean;
2757
-
2758
- /**
2759
- * <p> Specifies the Amazon S3 bucket prefix. </p>
2760
- */
2761
- bucketPrefix?: string;
2762
-
2763
- /**
2764
- * <p> Specifies the name of the Amazon S3 bucket. </p>
2765
- */
2766
- bucketName?: string;
2767
- }
2768
-
2769
- export namespace ErrorHandlingConfig {
2770
- /**
2771
- * @internal
2772
- */
2773
- export const filterSensitiveLog = (obj: ErrorHandlingConfig): any => ({
2774
- ...obj,
2775
- });
2776
- }
2777
-
2778
- /**
2779
- * <p> The properties that are applied when Amazon EventBridge is being used as a destination.
2780
- * </p>
2781
- */
2782
- export interface EventBridgeDestinationProperties {
2783
- /**
2784
- * <p> The object specified in the Amazon EventBridge flow destination. </p>
2785
- */
2786
- object: string | undefined;
2787
-
2788
- /**
2789
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
2790
- * destination. For example, this setting would determine if the flow should fail after one
2791
- * insertion error, or continue and attempt to insert every record regardless of the initial
2792
- * failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details.
2793
- * </p>
2794
- */
2795
- errorHandlingConfig?: ErrorHandlingConfig;
2796
- }
2797
-
2798
- export namespace EventBridgeDestinationProperties {
2799
- /**
2800
- * @internal
2801
- */
2802
- export const filterSensitiveLog = (obj: EventBridgeDestinationProperties): any => ({
2803
- ...obj,
2804
- });
2805
- }
2806
-
2807
- /**
2808
- * <p> The properties that are applied when Amazon Honeycode is used as a destination. </p>
2809
- */
2810
- export interface HoneycodeDestinationProperties {
2811
- /**
2812
- * <p> The object specified in the Amazon Honeycode flow destination. </p>
2813
- */
2814
- object: string | undefined;
2815
-
2816
- /**
2817
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
2818
- * destination. For example, this setting would determine if the flow should fail after one
2819
- * insertion error, or continue and attempt to insert every record regardless of the initial
2820
- * failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details.
2821
- * </p>
2822
- */
2823
- errorHandlingConfig?: ErrorHandlingConfig;
2824
- }
2825
-
2826
- export namespace HoneycodeDestinationProperties {
2827
- /**
2828
- * @internal
2829
- */
2830
- export const filterSensitiveLog = (obj: HoneycodeDestinationProperties): any => ({
2831
- ...obj,
2832
- });
2833
- }
2834
-
2835
- /**
2836
- * <p> The properties that are applied when Amazon Lookout for Metrics is used as a destination.
2837
- * </p>
2838
- */
2839
- export interface LookoutMetricsDestinationProperties {}
2840
-
2841
- export namespace LookoutMetricsDestinationProperties {
2842
- /**
2843
- * @internal
2844
- */
2845
- export const filterSensitiveLog = (obj: LookoutMetricsDestinationProperties): any => ({
2846
- ...obj,
2847
- });
2848
- }
2849
-
2850
- /**
2851
- * <p> The properties that are applied when Amazon Redshift is being used as a destination.
2852
- * </p>
2853
- */
2854
- export interface RedshiftDestinationProperties {
2855
- /**
2856
- * <p> The object specified in the Amazon Redshift flow destination. </p>
2857
- */
2858
- object: string | undefined;
2859
-
2860
- /**
2861
- * <p> The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift.
2862
- * </p>
2863
- */
2864
- intermediateBucketName: string | undefined;
2865
-
2866
- /**
2867
- * <p> The object key for the bucket in which Amazon AppFlow places the destination files.
2868
- * </p>
2869
- */
2870
- bucketPrefix?: string;
2871
-
2872
- /**
2873
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
2874
- * Amazon Redshift destination. For example, this setting would determine if the flow should fail
2875
- * after one insertion error, or continue and attempt to insert every record regardless of the
2876
- * initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector
2877
- * details. </p>
2878
- */
2879
- errorHandlingConfig?: ErrorHandlingConfig;
2880
- }
2881
-
2882
- export namespace RedshiftDestinationProperties {
2883
- /**
2884
- * @internal
2885
- */
2886
- export const filterSensitiveLog = (obj: RedshiftDestinationProperties): any => ({
2887
- ...obj,
2888
- });
2889
- }
2890
-
2891
- export enum FileType {
2892
- CSV = "CSV",
2893
- JSON = "JSON",
2894
- PARQUET = "PARQUET",
2895
- }
2896
-
2897
- export enum PrefixFormat {
2898
- DAY = "DAY",
2899
- HOUR = "HOUR",
2900
- MINUTE = "MINUTE",
2901
- MONTH = "MONTH",
2902
- YEAR = "YEAR",
2903
- }
2904
-
2905
- export enum PrefixType {
2906
- FILENAME = "FILENAME",
2907
- PATH = "PATH",
2908
- PATH_AND_FILENAME = "PATH_AND_FILENAME",
2909
- }
2910
-
2911
- /**
2912
- * <p> Determines the prefix that Amazon AppFlow applies to the destination folder name. You can
2913
- * name your destination folders according to the flow frequency and date. </p>
2914
- */
2915
- export interface PrefixConfig {
2916
- /**
2917
- * <p> Determines the format of the prefix, and whether it applies to the file name, file path,
2918
- * or both. </p>
2919
- */
2920
- prefixType?: PrefixType | string;
2921
-
2922
- /**
2923
- * <p> Determines the level of granularity that's included in the prefix. </p>
2924
- */
2925
- prefixFormat?: PrefixFormat | string;
2926
- }
2927
-
2928
- export namespace PrefixConfig {
2929
- /**
2930
- * @internal
2931
- */
2932
- export const filterSensitiveLog = (obj: PrefixConfig): any => ({
2933
- ...obj,
2934
- });
2935
- }
2936
-
2937
- /**
2938
- * <p> The configuration that determines how Amazon AppFlow should format the flow output data
2939
- * when Amazon S3 is used as the destination. </p>
2940
- */
2941
- export interface S3OutputFormatConfig {
2942
- /**
2943
- * <p> Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. </p>
2944
- */
2945
- fileType?: FileType | string;
2946
-
2947
- /**
2948
- * <p> Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3
2949
- * bucket. You can name folders according to the flow frequency and date. </p>
2950
- */
2951
- prefixConfig?: PrefixConfig;
2952
-
2953
- /**
2954
- * <p> The aggregation settings that you can use to customize the output format of your flow
2955
- * data. </p>
2956
- */
2957
- aggregationConfig?: AggregationConfig;
2958
- }
2959
-
2960
- export namespace S3OutputFormatConfig {
2961
- /**
2962
- * @internal
2963
- */
2964
- export const filterSensitiveLog = (obj: S3OutputFormatConfig): any => ({
2965
- ...obj,
2966
- });
2967
- }
2968
-
2969
- /**
2970
- * <p> The properties that are applied when Amazon S3 is used as a destination. </p>
2971
- */
2972
- export interface S3DestinationProperties {
2973
- /**
2974
- * <p> The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. </p>
2975
- */
2976
- bucketName: string | undefined;
2977
-
2978
- /**
2979
- * <p> The object key for the destination bucket in which Amazon AppFlow places the files.
2980
- * </p>
2981
- */
2982
- bucketPrefix?: string;
2983
-
2984
- /**
2985
- * <p> The configuration that determines how Amazon AppFlow should format the flow output data
2986
- * when Amazon S3 is used as the destination. </p>
2987
- */
2988
- s3OutputFormatConfig?: S3OutputFormatConfig;
2989
- }
2990
-
2991
- export namespace S3DestinationProperties {
2992
- /**
2993
- * @internal
2994
- */
2995
- export const filterSensitiveLog = (obj: S3DestinationProperties): any => ({
2996
- ...obj,
2997
- });
2998
- }
2999
-
3000
- /**
3001
- * <p> The properties that are applied when Salesforce is being used as a destination. </p>
3002
- */
3003
- export interface SalesforceDestinationProperties {
3004
- /**
3005
- * <p> The object specified in the Salesforce flow destination. </p>
3006
- */
3007
- object: string | undefined;
3008
-
3009
- /**
3010
- * <p> The name of the field that Amazon AppFlow uses as an ID when performing a write operation
3011
- * such as update or delete. </p>
3012
- */
3013
- idFieldNames?: string[];
3014
-
3015
- /**
3016
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
3017
- * Salesforce destination. For example, this setting would determine if the flow should fail
3018
- * after one insertion error, or continue and attempt to insert every record regardless of the
3019
- * initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector
3020
- * details. </p>
3021
- */
3022
- errorHandlingConfig?: ErrorHandlingConfig;
3023
-
3024
- /**
3025
- * <p> This specifies the type of write operation to be performed in Salesforce. When the value
3026
- * is <code>UPSERT</code>, then <code>idFieldNames</code> is required. </p>
3027
- */
3028
- writeOperationType?: WriteOperationType | string;
3029
- }
3030
-
3031
- export namespace SalesforceDestinationProperties {
3032
- /**
3033
- * @internal
3034
- */
3035
- export const filterSensitiveLog = (obj: SalesforceDestinationProperties): any => ({
3036
- ...obj,
3037
- });
3038
- }
3039
-
3040
- /**
3041
- * <p> The properties that are applied when Snowflake is being used as a destination. </p>
3042
- */
3043
- export interface SnowflakeDestinationProperties {
3044
- /**
3045
- * <p> The object specified in the Snowflake flow destination. </p>
3046
- */
3047
- object: string | undefined;
3048
-
3049
- /**
3050
- * <p> The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake. </p>
3051
- */
3052
- intermediateBucketName: string | undefined;
3053
-
3054
- /**
3055
- * <p> The object key for the destination bucket in which Amazon AppFlow places the files.
3056
- * </p>
3057
- */
3058
- bucketPrefix?: string;
3059
-
3060
- /**
3061
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
3062
- * Snowflake destination. For example, this setting would determine if the flow should fail after
3063
- * one insertion error, or continue and attempt to insert every record regardless of the initial
3064
- * failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details.
3065
- * </p>
3066
- */
3067
- errorHandlingConfig?: ErrorHandlingConfig;
3068
- }
3069
-
3070
- export namespace SnowflakeDestinationProperties {
3071
- /**
3072
- * @internal
3073
- */
3074
- export const filterSensitiveLog = (obj: SnowflakeDestinationProperties): any => ({
3075
- ...obj,
3076
- });
3077
- }
3078
-
3079
- /**
3080
- * <p> The configuration that determines how Amazon AppFlow formats the flow output data when
3081
- * Upsolver is used as the destination. </p>
3082
- */
3083
- export interface UpsolverS3OutputFormatConfig {
3084
- /**
3085
- * <p> Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.
3086
- * </p>
3087
- */
3088
- fileType?: FileType | string;
3089
-
3090
- /**
3091
- * <p> Determines the prefix that Amazon AppFlow applies to the destination folder name. You can
3092
- * name your destination folders according to the flow frequency and date. </p>
3093
- */
3094
- prefixConfig: PrefixConfig | undefined;
3095
-
3096
- /**
3097
- * <p> The aggregation settings that you can use to customize the output format of your flow
3098
- * data. </p>
3099
- */
3100
- aggregationConfig?: AggregationConfig;
3101
- }
3102
-
3103
- export namespace UpsolverS3OutputFormatConfig {
3104
- /**
3105
- * @internal
3106
- */
3107
- export const filterSensitiveLog = (obj: UpsolverS3OutputFormatConfig): any => ({
3108
- ...obj,
3109
- });
3110
- }
3111
-
3112
- /**
3113
- * <p> The properties that are applied when Upsolver is used as a destination. </p>
3114
- */
3115
- export interface UpsolverDestinationProperties {
3116
- /**
3117
- * <p> The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.
3118
- * </p>
3119
- */
3120
- bucketName: string | undefined;
3121
-
3122
- /**
3123
- * <p> The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow
3124
- * places the files. </p>
3125
- */
3126
- bucketPrefix?: string;
3127
-
3128
- /**
3129
- * <p> The configuration that determines how data is formatted when Upsolver is used as the flow
3130
- * destination. </p>
3131
- */
3132
- s3OutputFormatConfig: UpsolverS3OutputFormatConfig | undefined;
3133
- }
3134
-
3135
- export namespace UpsolverDestinationProperties {
3136
- /**
3137
- * @internal
3138
- */
3139
- export const filterSensitiveLog = (obj: UpsolverDestinationProperties): any => ({
3140
- ...obj,
3141
- });
3142
- }
3143
-
3144
- /**
3145
- * <p>The properties that are applied when Zendesk is used as a destination.</p>
3146
- */
3147
- export interface ZendeskDestinationProperties {
3148
- /**
3149
- * <p>The object specified in the Zendesk flow destination.</p>
3150
- */
3151
- object: string | undefined;
3152
-
3153
- /**
3154
- * <p> A list of field names that can be used as an ID field when performing a write operation.
3155
- * </p>
3156
- */
3157
- idFieldNames?: string[];
3158
-
3159
- /**
3160
- * <p> The settings that determine how Amazon AppFlow handles an error when placing data in the
3161
- * destination. For example, this setting would determine if the flow should fail after one
3162
- * insertion error, or continue and attempt to insert every record regardless of the initial
3163
- * failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details.
3164
- * </p>
3165
- */
3166
- errorHandlingConfig?: ErrorHandlingConfig;
3167
-
3168
- /**
3169
- * <p> The possible write operations in the destination connector. When this value is not
3170
- * provided, this defaults to the <code>INSERT</code> operation. </p>
3171
- */
3172
- writeOperationType?: WriteOperationType | string;
3173
- }
3174
-
3175
- export namespace ZendeskDestinationProperties {
3176
- /**
3177
- * @internal
3178
- */
3179
- export const filterSensitiveLog = (obj: ZendeskDestinationProperties): any => ({
3180
- ...obj,
3181
- });
3182
- }
3183
-
3184
- /**
3185
- * <p> This stores the information that is required to query a particular connector. </p>
3186
- */
3187
- export interface DestinationConnectorProperties {
3188
- /**
3189
- * <p> The properties required to query Amazon Redshift. </p>
3190
- */
3191
- Redshift?: RedshiftDestinationProperties;
3192
-
3193
- /**
3194
- * <p> The properties required to query Amazon S3. </p>
3195
- */
3196
- S3?: S3DestinationProperties;
3197
-
3198
- /**
3199
- * <p> The properties required to query Salesforce. </p>
3200
- */
3201
- Salesforce?: SalesforceDestinationProperties;
3202
-
3203
- /**
3204
- * <p> The properties required to query Snowflake. </p>
3205
- */
3206
- Snowflake?: SnowflakeDestinationProperties;
3207
-
3208
- /**
3209
- * <p> The properties required to query Amazon EventBridge. </p>
3210
- */
3211
- EventBridge?: EventBridgeDestinationProperties;
3212
-
3213
- /**
3214
- * <p> The properties required to query Amazon Lookout for Metrics. </p>
3215
- */
3216
- LookoutMetrics?: LookoutMetricsDestinationProperties;
3217
-
3218
- /**
3219
- * <p> The properties required to query Upsolver. </p>
3220
- */
3221
- Upsolver?: UpsolverDestinationProperties;
3222
-
3223
- /**
3224
- * <p> The properties required to query Amazon Honeycode. </p>
3225
- */
3226
- Honeycode?: HoneycodeDestinationProperties;
3227
-
3228
- /**
3229
- * <p> The properties required to query Amazon Connect Customer Profiles. </p>
3230
- */
3231
- CustomerProfiles?: CustomerProfilesDestinationProperties;
3232
-
3233
- /**
3234
- * <p>The properties required to query Zendesk.</p>
3235
- */
3236
- Zendesk?: ZendeskDestinationProperties;
3237
- }
3238
-
3239
- export namespace DestinationConnectorProperties {
3240
- /**
3241
- * @internal
3242
- */
3243
- export const filterSensitiveLog = (obj: DestinationConnectorProperties): any => ({
3244
- ...obj,
3245
- });
3246
- }
3247
-
3248
- /**
3249
- * <p> Contains information about the configuration of destination connectors present in the
3250
- * flow. </p>
3251
- */
3252
- export interface DestinationFlowConfig {
3253
- /**
3254
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
3255
- */
3256
- connectorType: ConnectorType | string | undefined;
3257
-
3258
- /**
3259
- * <p> The name of the connector profile. This name must be unique for each connector profile in
3260
- * the Amazon Web Services account. </p>
3261
- */
3262
- connectorProfileName?: string;
3263
-
3264
- /**
3265
- * <p> This stores the information that is required to query a particular connector. </p>
3266
- */
3267
- destinationConnectorProperties: DestinationConnectorProperties | undefined;
3268
- }
3269
-
3270
- export namespace DestinationFlowConfig {
3271
- /**
3272
- * @internal
3273
- */
3274
- export const filterSensitiveLog = (obj: DestinationFlowConfig): any => ({
3275
- ...obj,
3276
- });
3277
- }
3278
-
3279
- /**
3280
- * <p> Specifies the configuration used when importing incremental records from the source.
3281
- * </p>
3282
- */
3283
- export interface IncrementalPullConfig {
3284
- /**
3285
- * <p> A field that specifies the date time or timestamp field as the criteria to use when
3286
- * importing incremental records from the source. </p>
3287
- */
3288
- datetimeTypeFieldName?: string;
3289
- }
3290
-
3291
- export namespace IncrementalPullConfig {
3292
- /**
3293
- * @internal
3294
- */
3295
- export const filterSensitiveLog = (obj: IncrementalPullConfig): any => ({
3296
- ...obj,
3297
- });
3298
- }
3299
-
3300
- /**
3301
- * <p> The properties that are applied when Datadog is being used as a source. </p>
3302
- */
3303
- export interface DatadogSourceProperties {
3304
- /**
3305
- * <p> The object specified in the Datadog flow source. </p>
3306
- */
3307
- object: string | undefined;
3308
- }
3309
-
3310
- export namespace DatadogSourceProperties {
3311
- /**
3312
- * @internal
3313
- */
3314
- export const filterSensitiveLog = (obj: DatadogSourceProperties): any => ({
3315
- ...obj,
3316
- });
3317
- }
3318
-
3319
- /**
3320
- * <p> The properties that are applied when Dynatrace is being used as a source. </p>
3321
- */
3322
- export interface DynatraceSourceProperties {
3323
- /**
3324
- * <p> The object specified in the Dynatrace flow source. </p>
3325
- */
3326
- object: string | undefined;
3327
- }
3328
-
3329
- export namespace DynatraceSourceProperties {
3330
- /**
3331
- * @internal
3332
- */
3333
- export const filterSensitiveLog = (obj: DynatraceSourceProperties): any => ({
3334
- ...obj,
3335
- });
3336
- }
3337
-
3338
- /**
3339
- * <p> The properties that are applied when Google Analytics is being used as a source. </p>
3340
- */
3341
- export interface GoogleAnalyticsSourceProperties {
3342
- /**
3343
- * <p> The object specified in the Google Analytics flow source. </p>
3344
- */
3345
- object: string | undefined;
3346
- }
3347
-
3348
- export namespace GoogleAnalyticsSourceProperties {
3349
- /**
3350
- * @internal
3351
- */
3352
- export const filterSensitiveLog = (obj: GoogleAnalyticsSourceProperties): any => ({
3353
- ...obj,
3354
- });
3355
- }
3356
-
3357
- /**
3358
- * <p> The properties that are applied when Infor Nexus is being used as a source. </p>
3359
- */
3360
- export interface InforNexusSourceProperties {
3361
- /**
3362
- * <p> The object specified in the Infor Nexus flow source. </p>
3363
- */
3364
- object: string | undefined;
3365
- }
3366
-
3367
- export namespace InforNexusSourceProperties {
3368
- /**
3369
- * @internal
3370
- */
3371
- export const filterSensitiveLog = (obj: InforNexusSourceProperties): any => ({
3372
- ...obj,
3373
- });
3374
- }
3375
-
3376
- /**
3377
- * <p> The properties that are applied when Marketo is being used as a source. </p>
3378
- */
3379
- export interface MarketoSourceProperties {
3380
- /**
3381
- * <p> The object specified in the Marketo flow source. </p>
3382
- */
3383
- object: string | undefined;
3384
- }
3385
-
3386
- export namespace MarketoSourceProperties {
3387
- /**
3388
- * @internal
3389
- */
3390
- export const filterSensitiveLog = (obj: MarketoSourceProperties): any => ({
3391
- ...obj,
3392
- });
3393
- }
3394
-
3395
- /**
3396
- * <p> The properties that are applied when Amazon S3 is being used as the flow source. </p>
3397
- */
3398
- export interface S3SourceProperties {
3399
- /**
3400
- * <p> The Amazon S3 bucket name where the source files are stored. </p>
3401
- */
3402
- bucketName: string | undefined;
3403
-
3404
- /**
3405
- * <p> The object key for the Amazon S3 bucket in which the source files are stored. </p>
3406
- */
3407
- bucketPrefix?: string;
3408
- }
3409
-
3410
- export namespace S3SourceProperties {
3411
- /**
3412
- * @internal
3413
- */
3414
- export const filterSensitiveLog = (obj: S3SourceProperties): any => ({
3415
- ...obj,
3416
- });
3417
- }
3418
-
3419
- /**
3420
- * <p> The properties that are applied when Salesforce is being used as a source. </p>
3421
- */
3422
- export interface SalesforceSourceProperties {
3423
- /**
3424
- * <p> The object specified in the Salesforce flow source. </p>
3425
- */
3426
- object: string | undefined;
3427
-
3428
- /**
3429
- * <p> The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
3430
- * objects while running a flow. </p>
3431
- */
3432
- enableDynamicFieldUpdate?: boolean;
3433
-
3434
- /**
3435
- * <p> Indicates whether Amazon AppFlow includes deleted files in the flow run. </p>
3436
- */
3437
- includeDeletedRecords?: boolean;
3438
- }
3439
-
3440
- export namespace SalesforceSourceProperties {
3441
- /**
3442
- * @internal
3443
- */
3444
- export const filterSensitiveLog = (obj: SalesforceSourceProperties): any => ({
3445
- ...obj,
3446
- });
3447
- }
3448
-
3449
- /**
3450
- * <p> The properties that are applied when using SAPOData as a flow source. </p>
3451
- */
3452
- export interface SAPODataSourceProperties {
3453
- /**
3454
- * <p> The object path specified in the SAPOData flow source. </p>
3455
- */
3456
- objectPath?: string;
3457
- }
3458
-
3459
- export namespace SAPODataSourceProperties {
3460
- /**
3461
- * @internal
3462
- */
3463
- export const filterSensitiveLog = (obj: SAPODataSourceProperties): any => ({
3464
- ...obj,
3465
- });
3466
- }
3467
-
3468
- /**
3469
- * <p> The properties that are applied when ServiceNow is being used as a source. </p>
3470
- */
3471
- export interface ServiceNowSourceProperties {
3472
- /**
3473
- * <p> The object specified in the ServiceNow flow source. </p>
3474
- */
3475
- object: string | undefined;
3476
- }
3477
-
3478
- export namespace ServiceNowSourceProperties {
3479
- /**
3480
- * @internal
3481
- */
3482
- export const filterSensitiveLog = (obj: ServiceNowSourceProperties): any => ({
3483
- ...obj,
3484
- });
3485
- }
3486
-
3487
- /**
3488
- * <p> The properties that are applied when Singular is being used as a source. </p>
3489
- */
3490
- export interface SingularSourceProperties {
3491
- /**
3492
- * <p> The object specified in the Singular flow source. </p>
3493
- */
3494
- object: string | undefined;
3495
- }
3496
-
3497
- export namespace SingularSourceProperties {
3498
- /**
3499
- * @internal
3500
- */
3501
- export const filterSensitiveLog = (obj: SingularSourceProperties): any => ({
3502
- ...obj,
3503
- });
3504
- }
3505
-
3506
- /**
3507
- * <p> The properties that are applied when Slack is being used as a source. </p>
3508
- */
3509
- export interface SlackSourceProperties {
3510
- /**
3511
- * <p> The object specified in the Slack flow source. </p>
3512
- */
3513
- object: string | undefined;
3514
- }
3515
-
3516
- export namespace SlackSourceProperties {
3517
- /**
3518
- * @internal
3519
- */
3520
- export const filterSensitiveLog = (obj: SlackSourceProperties): any => ({
3521
- ...obj,
3522
- });
3523
- }
3524
-
3525
- /**
3526
- * <p> The properties that are applied when using Trend Micro as a flow source. </p>
3527
- */
3528
- export interface TrendmicroSourceProperties {
3529
- /**
3530
- * <p> The object specified in the Trend Micro flow source. </p>
3531
- */
3532
- object: string | undefined;
3533
- }
3534
-
3535
- export namespace TrendmicroSourceProperties {
3536
- /**
3537
- * @internal
3538
- */
3539
- export const filterSensitiveLog = (obj: TrendmicroSourceProperties): any => ({
3540
- ...obj,
3541
- });
3542
- }
3543
-
3544
- /**
3545
- * <p> The properties that are applied when using Veeva as a flow source. </p>
3546
- */
3547
- export interface VeevaSourceProperties {
3548
- /**
3549
- * <p> The object specified in the Veeva flow source. </p>
3550
- */
3551
- object: string | undefined;
3552
-
3553
- /**
3554
- * <p>The document type specified in the Veeva document extract flow.</p>
3555
- */
3556
- documentType?: string;
3557
-
3558
- /**
3559
- * <p>Boolean value to include source files in Veeva document extract flow.</p>
3560
- */
3561
- includeSourceFiles?: boolean;
3562
-
3563
- /**
3564
- * <p>Boolean value to include file renditions in Veeva document extract flow.</p>
3565
- */
3566
- includeRenditions?: boolean;
3567
-
3568
- /**
3569
- * <p>Boolean value to include All Versions of files in Veeva document extract flow.</p>
3570
- */
3571
- includeAllVersions?: boolean;
3572
- }
3573
-
3574
- export namespace VeevaSourceProperties {
3575
- /**
3576
- * @internal
3577
- */
3578
- export const filterSensitiveLog = (obj: VeevaSourceProperties): any => ({
3579
- ...obj,
3580
- });
3581
- }
3582
-
3583
- /**
3584
- * <p> The properties that are applied when using Zendesk as a flow source. </p>
3585
- */
3586
- export interface ZendeskSourceProperties {
3587
- /**
3588
- * <p> The object specified in the Zendesk flow source. </p>
3589
- */
3590
- object: string | undefined;
3591
- }
3592
-
3593
- export namespace ZendeskSourceProperties {
3594
- /**
3595
- * @internal
3596
- */
3597
- export const filterSensitiveLog = (obj: ZendeskSourceProperties): any => ({
3598
- ...obj,
3599
- });
3600
- }
3601
-
3602
- /**
3603
- * <p> Specifies the information that is required to query a particular connector. </p>
3604
- */
3605
- export interface SourceConnectorProperties {
3606
- /**
3607
- * <p> Specifies the information that is required for querying Amplitude. </p>
3608
- */
3609
- Amplitude?: AmplitudeSourceProperties;
3610
-
3611
- /**
3612
- * <p> Specifies the information that is required for querying Datadog. </p>
3613
- */
3614
- Datadog?: DatadogSourceProperties;
3615
-
3616
- /**
3617
- * <p> Specifies the information that is required for querying Dynatrace. </p>
3618
- */
3619
- Dynatrace?: DynatraceSourceProperties;
3620
-
3621
- /**
3622
- * <p> Specifies the information that is required for querying Google Analytics. </p>
3623
- */
3624
- GoogleAnalytics?: GoogleAnalyticsSourceProperties;
3625
-
3626
- /**
3627
- * <p> Specifies the information that is required for querying Infor Nexus. </p>
3628
- */
3629
- InforNexus?: InforNexusSourceProperties;
3630
-
3631
- /**
3632
- * <p> Specifies the information that is required for querying Marketo. </p>
3633
- */
3634
- Marketo?: MarketoSourceProperties;
3635
-
3636
- /**
3637
- * <p> Specifies the information that is required for querying Amazon S3. </p>
3638
- */
3639
- S3?: S3SourceProperties;
3640
-
3641
- /**
3642
- * <p> Specifies the information that is required for querying Salesforce. </p>
3643
- */
3644
- Salesforce?: SalesforceSourceProperties;
3645
-
3646
- /**
3647
- * <p> Specifies the information that is required for querying ServiceNow. </p>
3648
- */
3649
- ServiceNow?: ServiceNowSourceProperties;
3650
-
3651
- /**
3652
- * <p> Specifies the information that is required for querying Singular. </p>
3653
- */
3654
- Singular?: SingularSourceProperties;
3655
-
3656
- /**
3657
- * <p> Specifies the information that is required for querying Slack. </p>
3658
- */
3659
- Slack?: SlackSourceProperties;
3660
-
3661
- /**
3662
- * <p> Specifies the information that is required for querying Trend Micro. </p>
3663
- */
3664
- Trendmicro?: TrendmicroSourceProperties;
3665
-
3666
- /**
3667
- * <p> Specifies the information that is required for querying Veeva. </p>
3668
- */
3669
- Veeva?: VeevaSourceProperties;
3670
-
3671
- /**
3672
- * <p> Specifies the information that is required for querying Zendesk. </p>
3673
- */
3674
- Zendesk?: ZendeskSourceProperties;
3675
-
3676
- /**
3677
- * <p> The properties that are applied when using SAPOData as a flow source. </p>
3678
- */
3679
- SAPOData?: SAPODataSourceProperties;
3680
- }
3681
-
3682
- export namespace SourceConnectorProperties {
3683
- /**
3684
- * @internal
3685
- */
3686
- export const filterSensitiveLog = (obj: SourceConnectorProperties): any => ({
3687
- ...obj,
3688
- });
3689
- }
3690
-
3691
- /**
3692
- * <p> Contains information about the configuration of the source connector used in the flow.
3693
- * </p>
3694
- */
3695
- export interface SourceFlowConfig {
3696
- /**
3697
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
3698
- */
3699
- connectorType: ConnectorType | string | undefined;
3700
-
3701
- /**
3702
- * <p> The name of the connector profile. This name must be unique for each connector profile in
3703
- * the Amazon Web Services account. </p>
3704
- */
3705
- connectorProfileName?: string;
3706
-
3707
- /**
3708
- * <p> Specifies the information that is required to query a particular source connector.
3709
- * </p>
3710
- */
3711
- sourceConnectorProperties: SourceConnectorProperties | undefined;
3712
-
3713
- /**
3714
- * <p> Defines the configuration for a scheduled incremental data pull. If a valid configuration
3715
- * is provided, the fields specified in the configuration are used when querying for the
3716
- * incremental data pull. </p>
3717
- */
3718
- incrementalPullConfig?: IncrementalPullConfig;
3719
- }
3720
-
3721
- export namespace SourceFlowConfig {
3722
- /**
3723
- * @internal
3724
- */
3725
- export const filterSensitiveLog = (obj: SourceFlowConfig): any => ({
3726
- ...obj,
3727
- });
3728
- }
3729
-
3730
- export enum OperatorPropertiesKeys {
3731
- CONCAT_FORMAT = "CONCAT_FORMAT",
3732
- DATA_TYPE = "DATA_TYPE",
3733
- DESTINATION_DATA_TYPE = "DESTINATION_DATA_TYPE",
3734
- EXCLUDE_SOURCE_FIELDS_LIST = "EXCLUDE_SOURCE_FIELDS_LIST",
3735
- LOWER_BOUND = "LOWER_BOUND",
3736
- MASK_LENGTH = "MASK_LENGTH",
3737
- MASK_VALUE = "MASK_VALUE",
3738
- MATH_OPERATION_FIELDS_ORDER = "MATH_OPERATION_FIELDS_ORDER",
3739
- SOURCE_DATA_TYPE = "SOURCE_DATA_TYPE",
3740
- SUBFIELD_CATEGORY_MAP = "SUBFIELD_CATEGORY_MAP",
3741
- TRUNCATE_LENGTH = "TRUNCATE_LENGTH",
3742
- UPPER_BOUND = "UPPER_BOUND",
3743
- VALIDATION_ACTION = "VALIDATION_ACTION",
3744
- VALUE = "VALUE",
3745
- VALUES = "VALUES",
3746
- }
3747
-
3748
- export enum TaskType {
3749
- ARITHMETIC = "Arithmetic",
3750
- FILTER = "Filter",
3751
- MAP = "Map",
3752
- MAP_ALL = "Map_all",
3753
- MASK = "Mask",
3754
- MERGE = "Merge",
3755
- TRUNCATE = "Truncate",
3756
- VALIDATE = "Validate",
3757
- }
3758
-
3759
- /**
3760
- * <p> A class for modeling different type of tasks. Task implementation varies based on the
3761
- * <code>TaskType</code>. </p>
3762
- */
3763
- export interface Task {
3764
- /**
3765
- * <p> The source fields to which a particular task is applied. </p>
3766
- */
3767
- sourceFields: string[] | undefined;
3768
-
3769
- /**
3770
- * <p> The operation to be performed on the provided source fields. </p>
3771
- */
3772
- connectorOperator?: ConnectorOperator;
3773
-
3774
- /**
3775
- * <p> A field in a destination connector, or a field value against which Amazon AppFlow
3776
- * validates a source field. </p>
3777
- */
3778
- destinationField?: string;
3779
-
3780
- /**
3781
- * <p> Specifies the particular task implementation that Amazon AppFlow performs. </p>
3782
- */
3783
- taskType: TaskType | string | undefined;
3784
-
3785
- /**
3786
- * <p> A map used to store task-related information. The execution service looks for particular
3787
- * information based on the <code>TaskType</code>. </p>
3788
- */
3789
- taskProperties?: { [key: string]: string };
3790
- }
3791
-
3792
- export namespace Task {
3793
- /**
3794
- * @internal
3795
- */
3796
- export const filterSensitiveLog = (obj: Task): any => ({
3797
- ...obj,
3798
- });
3799
- }
3800
-
3801
- export enum DataPullMode {
3802
- COMPLETE = "Complete",
3803
- INCREMENTAL = "Incremental",
3804
- }
3805
-
3806
- /**
3807
- * <p> Specifies the configuration details of a schedule-triggered flow as defined by the user.
3808
- * Currently, these settings only apply to the <code>Scheduled</code> trigger type. </p>
3809
- */
3810
- export interface ScheduledTriggerProperties {
3811
- /**
3812
- * <p> The scheduling expression that determines the rate at which the schedule will run, for
3813
- * example <code>rate(5minutes)</code>. </p>
3814
- */
3815
- scheduleExpression: string | undefined;
3816
-
3817
- /**
3818
- * <p> Specifies whether a scheduled flow has an incremental data transfer or a complete data
3819
- * transfer for each flow run. </p>
3820
- */
3821
- dataPullMode?: DataPullMode | string;
3822
-
3823
- /**
3824
- * <p> Specifies the scheduled start time for a schedule-triggered flow. </p>
3825
- */
3826
- scheduleStartTime?: Date;
3827
-
3828
- /**
3829
- * <p> Specifies the scheduled end time for a schedule-triggered flow. </p>
3830
- */
3831
- scheduleEndTime?: Date;
3832
-
3833
- /**
3834
- * <p> Specifies the time zone used when referring to the date and time of a scheduled-triggered
3835
- * flow, such as <code>America/New_York</code>. </p>
3836
- */
3837
- timezone?: string;
3838
-
3839
- /**
3840
- * <p> Specifies the optional offset that is added to the time interval for a schedule-triggered
3841
- * flow. </p>
3842
- */
3843
- scheduleOffset?: number;
3844
-
3845
- /**
3846
- * <p> Specifies the date range for the records to import from the connector in the first flow
3847
- * run. </p>
3848
- */
3849
- firstExecutionFrom?: Date;
3850
- }
3851
-
3852
- export namespace ScheduledTriggerProperties {
3853
- /**
3854
- * @internal
3855
- */
3856
- export const filterSensitiveLog = (obj: ScheduledTriggerProperties): any => ({
3857
- ...obj,
3858
- });
3859
- }
3860
-
3861
- /**
3862
- * <p> Specifies the configuration details that control the trigger for a flow. Currently, these
3863
- * settings only apply to the <code>Scheduled</code> trigger type. </p>
3864
- */
3865
- export interface TriggerProperties {
3866
- /**
3867
- * <p> Specifies the configuration details of a schedule-triggered flow as defined by the user.
3868
- * </p>
3869
- */
3870
- Scheduled?: ScheduledTriggerProperties;
3871
- }
3872
-
3873
- export namespace TriggerProperties {
3874
- /**
3875
- * @internal
3876
- */
3877
- export const filterSensitiveLog = (obj: TriggerProperties): any => ({
3878
- ...obj,
3879
- });
3880
- }
3881
-
3882
- /**
3883
- * <p> The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
3884
- * </p>
3885
- */
3886
- export interface TriggerConfig {
3887
- /**
3888
- * <p> Specifies the type of flow trigger. This can be <code>OnDemand</code>,
3889
- * <code>Scheduled</code>, or <code>Event</code>. </p>
3890
- */
3891
- triggerType: TriggerType | string | undefined;
3892
-
3893
- /**
3894
- * <p> Specifies the configuration details of a schedule-triggered flow as defined by the user.
3895
- * Currently, these settings only apply to the <code>Scheduled</code> trigger type. </p>
3896
- */
3897
- triggerProperties?: TriggerProperties;
3898
- }
3899
-
3900
- export namespace TriggerConfig {
3901
- /**
3902
- * @internal
3903
- */
3904
- export const filterSensitiveLog = (obj: TriggerConfig): any => ({
3905
- ...obj,
3906
- });
3907
- }
3908
-
3909
- export interface CreateFlowRequest {
3910
- /**
3911
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
3912
- * (-) only. </p>
3913
- */
3914
- flowName: string | undefined;
3915
-
3916
- /**
3917
- * <p> A description of the flow you want to create. </p>
3918
- */
3919
- description?: string;
3920
-
3921
- /**
3922
- * <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
3923
- * encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If
3924
- * you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
3925
- * </p>
3926
- */
3927
- kmsArn?: string;
3928
-
3929
- /**
3930
- * <p> The trigger settings that determine how and when the flow runs. </p>
3931
- */
3932
- triggerConfig: TriggerConfig | undefined;
3933
-
3934
- /**
3935
- * <p> The configuration that controls how Amazon AppFlow retrieves data from the source
3936
- * connector. </p>
3937
- */
3938
- sourceFlowConfig: SourceFlowConfig | undefined;
3939
-
3940
- /**
3941
- * <p> The configuration that controls how Amazon AppFlow places data in the destination
3942
- * connector. </p>
3943
- */
3944
- destinationFlowConfigList: DestinationFlowConfig[] | undefined;
3945
-
3946
- /**
3947
- * <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
3948
- * </p>
3949
- */
3950
- tasks: Task[] | undefined;
3951
-
3952
- /**
3953
- * <p> The tags used to organize, track, or control access for your flow. </p>
3954
- */
3955
- tags?: { [key: string]: string };
3956
- }
3957
-
3958
- export namespace CreateFlowRequest {
3959
- /**
3960
- * @internal
3961
- */
3962
- export const filterSensitiveLog = (obj: CreateFlowRequest): any => ({
3963
- ...obj,
3964
- });
3965
- }
3966
-
3967
- export enum FlowStatus {
3968
- ACTIVE = "Active",
3969
- DELETED = "Deleted",
3970
- DEPRECATED = "Deprecated",
3971
- DRAFT = "Draft",
3972
- ERRORED = "Errored",
3973
- SUSPENDED = "Suspended",
3974
- }
3975
-
3976
- export interface CreateFlowResponse {
3977
- /**
3978
- * <p> The flow's Amazon Resource Name (ARN). </p>
3979
- */
3980
- flowArn?: string;
3981
-
3982
- /**
3983
- * <p> Indicates the current status of the flow. </p>
3984
- */
3985
- flowStatus?: FlowStatus | string;
3986
- }
3987
-
3988
- export namespace CreateFlowResponse {
3989
- /**
3990
- * @internal
3991
- */
3992
- export const filterSensitiveLog = (obj: CreateFlowResponse): any => ({
3993
- ...obj,
3994
- });
3995
- }
3996
-
3997
- /**
3998
- * <p> The resource specified in the request (such as the source or destination connector
3999
- * profile) is not found. </p>
4000
- */
4001
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
4002
- name: "ResourceNotFoundException";
4003
- $fault: "client";
4004
- message?: string;
4005
- }
4006
-
4007
- export namespace ResourceNotFoundException {
4008
- /**
4009
- * @internal
4010
- */
4011
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
4012
- ...obj,
4013
- });
4014
- }
4015
-
4016
- export interface DeleteConnectorProfileRequest {
4017
- /**
4018
- * <p> The name of the connector profile. The name is unique for each
4019
- * <code>ConnectorProfile</code> in your account. </p>
4020
- */
4021
- connectorProfileName: string | undefined;
4022
-
4023
- /**
4024
- * <p> Indicates whether Amazon AppFlow should delete the profile, even if it is currently in
4025
- * use in one or more flows. </p>
4026
- */
4027
- forceDelete?: boolean;
4028
- }
4029
-
4030
- export namespace DeleteConnectorProfileRequest {
4031
- /**
4032
- * @internal
4033
- */
4034
- export const filterSensitiveLog = (obj: DeleteConnectorProfileRequest): any => ({
4035
- ...obj,
4036
- });
4037
- }
4038
-
4039
- export interface DeleteConnectorProfileResponse {}
4040
-
4041
- export namespace DeleteConnectorProfileResponse {
4042
- /**
4043
- * @internal
4044
- */
4045
- export const filterSensitiveLog = (obj: DeleteConnectorProfileResponse): any => ({
4046
- ...obj,
4047
- });
4048
- }
4049
-
4050
- export interface DeleteFlowRequest {
4051
- /**
4052
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4053
- * (-) only. </p>
4054
- */
4055
- flowName: string | undefined;
4056
-
4057
- /**
4058
- * <p> Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use.
4059
- * </p>
4060
- */
4061
- forceDelete?: boolean;
4062
- }
4063
-
4064
- export namespace DeleteFlowRequest {
4065
- /**
4066
- * @internal
4067
- */
4068
- export const filterSensitiveLog = (obj: DeleteFlowRequest): any => ({
4069
- ...obj,
4070
- });
4071
- }
4072
-
4073
- export interface DeleteFlowResponse {}
4074
-
4075
- export namespace DeleteFlowResponse {
4076
- /**
4077
- * @internal
4078
- */
4079
- export const filterSensitiveLog = (obj: DeleteFlowResponse): any => ({
4080
- ...obj,
4081
- });
4082
- }
4083
-
4084
- export interface DescribeConnectorEntityRequest {
4085
- /**
4086
- * <p> The entity name for that connector. </p>
4087
- */
4088
- connectorEntityName: string | undefined;
4089
-
4090
- /**
4091
- * <p> The type of connector application, such as Salesforce, Amplitude, and so on. </p>
4092
- */
4093
- connectorType?: ConnectorType | string;
4094
-
4095
- /**
4096
- * <p> The name of the connector profile. The name is unique for each
4097
- * <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
4098
- */
4099
- connectorProfileName?: string;
4100
- }
4101
-
4102
- export namespace DescribeConnectorEntityRequest {
4103
- /**
4104
- * @internal
4105
- */
4106
- export const filterSensitiveLog = (obj: DescribeConnectorEntityRequest): any => ({
4107
- ...obj,
4108
- });
4109
- }
4110
-
4111
- export interface DescribeConnectorEntityResponse {
4112
- /**
4113
- * <p> Describes the fields for that connector entity. For example, for an
4114
- * <i>account</i> entity, the fields would be <i>account name</i>,
4115
- * <i>account ID</i>, and so on. </p>
4116
- */
4117
- connectorEntityFields: ConnectorEntityField[] | undefined;
4118
- }
4119
-
4120
- export namespace DescribeConnectorEntityResponse {
4121
- /**
4122
- * @internal
4123
- */
4124
- export const filterSensitiveLog = (obj: DescribeConnectorEntityResponse): any => ({
4125
- ...obj,
4126
- });
4127
- }
4128
-
4129
- export interface DescribeConnectorProfilesRequest {
4130
- /**
4131
- * <p> The name of the connector profile. The name is unique for each
4132
- * <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
4133
- */
4134
- connectorProfileNames?: string[];
4135
-
4136
- /**
4137
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
4138
- */
4139
- connectorType?: ConnectorType | string;
4140
-
4141
- /**
4142
- * <p> Specifies the maximum number of items that should be returned in the result set. The
4143
- * default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
4144
- */
4145
- maxResults?: number;
4146
-
4147
- /**
4148
- * <p> The pagination token for the next page of data. </p>
4149
- */
4150
- nextToken?: string;
4151
- }
4152
-
4153
- export namespace DescribeConnectorProfilesRequest {
4154
- /**
4155
- * @internal
4156
- */
4157
- export const filterSensitiveLog = (obj: DescribeConnectorProfilesRequest): any => ({
4158
- ...obj,
4159
- });
4160
- }
4161
-
4162
- export interface DescribeConnectorProfilesResponse {
4163
- /**
4164
- * <p> Returns information about the connector profiles associated with the flow. </p>
4165
- */
4166
- connectorProfileDetails?: ConnectorProfile[];
4167
-
4168
- /**
4169
- * <p> The pagination token for the next page of data. If <code>nextToken=null</code>, this
4170
- * means that all records have been fetched. </p>
4171
- */
4172
- nextToken?: string;
4173
- }
4174
-
4175
- export namespace DescribeConnectorProfilesResponse {
4176
- /**
4177
- * @internal
4178
- */
4179
- export const filterSensitiveLog = (obj: DescribeConnectorProfilesResponse): any => ({
4180
- ...obj,
4181
- });
4182
- }
4183
-
4184
- export interface DescribeConnectorsRequest {
4185
- /**
4186
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
4187
- */
4188
- connectorTypes?: (ConnectorType | string)[];
4189
-
4190
- /**
4191
- * <p> The pagination token for the next page of data. </p>
4192
- */
4193
- nextToken?: string;
4194
- }
4195
-
4196
- export namespace DescribeConnectorsRequest {
4197
- /**
4198
- * @internal
4199
- */
4200
- export const filterSensitiveLog = (obj: DescribeConnectorsRequest): any => ({
4201
- ...obj,
4202
- });
4203
- }
4204
-
4205
- export interface DescribeConnectorsResponse {
4206
- /**
4207
- * <p> The configuration that is applied to the connectors used in the flow. </p>
4208
- */
4209
- connectorConfigurations?: { [key: string]: ConnectorConfiguration };
4210
-
4211
- /**
4212
- * <p> The pagination token for the next page of data. </p>
4213
- */
4214
- nextToken?: string;
4215
- }
4216
-
4217
- export namespace DescribeConnectorsResponse {
4218
- /**
4219
- * @internal
4220
- */
4221
- export const filterSensitiveLog = (obj: DescribeConnectorsResponse): any => ({
4222
- ...obj,
4223
- });
4224
- }
4225
-
4226
- export interface DescribeFlowRequest {
4227
- /**
4228
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4229
- * (-) only. </p>
4230
- */
4231
- flowName: string | undefined;
4232
- }
4233
-
4234
- export namespace DescribeFlowRequest {
4235
- /**
4236
- * @internal
4237
- */
4238
- export const filterSensitiveLog = (obj: DescribeFlowRequest): any => ({
4239
- ...obj,
4240
- });
4241
- }
4242
-
4243
- export enum ExecutionStatus {
4244
- ERROR = "Error",
4245
- INPROGRESS = "InProgress",
4246
- SUCCESSFUL = "Successful",
4247
- }
4248
-
4249
- /**
4250
- * <p> Describes the details of the flow run, including the timestamp, status, and message.
4251
- * </p>
4252
- */
4253
- export interface ExecutionDetails {
4254
- /**
4255
- * <p> Describes the details of the most recent flow run. </p>
4256
- */
4257
- mostRecentExecutionMessage?: string;
4258
-
4259
- /**
4260
- * <p> Specifies the time of the most recent flow run. </p>
4261
- */
4262
- mostRecentExecutionTime?: Date;
4263
-
4264
- /**
4265
- * <p> Specifies the status of the most recent flow run. </p>
4266
- */
4267
- mostRecentExecutionStatus?: ExecutionStatus | string;
4268
- }
4269
-
4270
- export namespace ExecutionDetails {
4271
- /**
4272
- * @internal
4273
- */
4274
- export const filterSensitiveLog = (obj: ExecutionDetails): any => ({
4275
- ...obj,
4276
- });
4277
- }
4278
-
4279
- export interface DescribeFlowResponse {
4280
- /**
4281
- * <p> The flow's Amazon Resource Name (ARN). </p>
4282
- */
4283
- flowArn?: string;
4284
-
4285
- /**
4286
- * <p> A description of the flow. </p>
4287
- */
4288
- description?: string;
4289
-
4290
- /**
4291
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4292
- * (-) only. </p>
4293
- */
4294
- flowName?: string;
4295
-
4296
- /**
4297
- * <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
4298
- * encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key. If
4299
- * you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
4300
- * </p>
4301
- */
4302
- kmsArn?: string;
4303
-
4304
- /**
4305
- * <p> Indicates the current status of the flow. </p>
4306
- */
4307
- flowStatus?: FlowStatus | string;
4308
-
4309
- /**
4310
- * <p> Contains an error message if the flow status is in a suspended or error state. This
4311
- * applies only to scheduled or event-triggered flows. </p>
4312
- */
4313
- flowStatusMessage?: string;
4314
-
4315
- /**
4316
- * <p> The configuration that controls how Amazon AppFlow retrieves data from the source
4317
- * connector. </p>
4318
- */
4319
- sourceFlowConfig?: SourceFlowConfig;
4320
-
4321
- /**
4322
- * <p> The configuration that controls how Amazon AppFlow transfers data to the destination
4323
- * connector. </p>
4324
- */
4325
- destinationFlowConfigList?: DestinationFlowConfig[];
4326
-
4327
- /**
4328
- * <p> Describes the details of the most recent flow run. </p>
4329
- */
4330
- lastRunExecutionDetails?: ExecutionDetails;
4331
-
4332
- /**
4333
- * <p> The trigger settings that determine how and when the flow runs. </p>
4334
- */
4335
- triggerConfig?: TriggerConfig;
4336
-
4337
- /**
4338
- * <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
4339
- * </p>
4340
- */
4341
- tasks?: Task[];
4342
-
4343
- /**
4344
- * <p> Specifies when the flow was created. </p>
4345
- */
4346
- createdAt?: Date;
4347
-
4348
- /**
4349
- * <p> Specifies when the flow was last updated. </p>
4350
- */
4351
- lastUpdatedAt?: Date;
4352
-
4353
- /**
4354
- * <p> The ARN of the user who created the flow. </p>
4355
- */
4356
- createdBy?: string;
4357
-
4358
- /**
4359
- * <p> Specifies the user name of the account that performed the most recent update. </p>
4360
- */
4361
- lastUpdatedBy?: string;
4362
-
4363
- /**
4364
- * <p> The tags used to organize, track, or control access for your flow. </p>
4365
- */
4366
- tags?: { [key: string]: string };
4367
- }
4368
-
4369
- export namespace DescribeFlowResponse {
4370
- /**
4371
- * @internal
4372
- */
4373
- export const filterSensitiveLog = (obj: DescribeFlowResponse): any => ({
4374
- ...obj,
4375
- });
4376
- }
4377
-
4378
- export interface DescribeFlowExecutionRecordsRequest {
4379
- /**
4380
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4381
- * (-) only. </p>
4382
- */
4383
- flowName: string | undefined;
4384
-
4385
- /**
4386
- * <p> Specifies the maximum number of items that should be returned in the result set. The
4387
- * default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
4388
- */
4389
- maxResults?: number;
4390
-
4391
- /**
4392
- * <p> The pagination token for the next page of data. </p>
4393
- */
4394
- nextToken?: string;
4395
- }
4396
-
4397
- export namespace DescribeFlowExecutionRecordsRequest {
4398
- /**
4399
- * @internal
4400
- */
4401
- export const filterSensitiveLog = (obj: DescribeFlowExecutionRecordsRequest): any => ({
4402
- ...obj,
4403
- });
4404
- }
4405
-
4406
- /**
4407
- * <p> Provides details in the event of a failed flow, including the failure count and the
4408
- * related error messages. </p>
4409
- */
4410
- export interface ErrorInfo {
4411
- /**
4412
- * <p> Specifies the failure count for the attempted flow. </p>
4413
- */
4414
- putFailuresCount?: number;
4415
-
4416
- /**
4417
- * <p> Specifies the error message that appears if a flow fails. </p>
4418
- */
4419
- executionMessage?: string;
4420
- }
4421
-
4422
- export namespace ErrorInfo {
4423
- /**
4424
- * @internal
4425
- */
4426
- export const filterSensitiveLog = (obj: ErrorInfo): any => ({
4427
- ...obj,
4428
- });
4429
- }
4430
-
4431
- /**
4432
- * <p> Specifies the end result of the flow run. </p>
4433
- */
4434
- export interface ExecutionResult {
4435
- /**
4436
- * <p> Provides any error message information related to the flow run. </p>
4437
- */
4438
- errorInfo?: ErrorInfo;
4439
-
4440
- /**
4441
- * <p> The total number of bytes processed by the flow run. </p>
4442
- */
4443
- bytesProcessed?: number;
4444
-
4445
- /**
4446
- * <p> The total number of bytes written as a result of the flow run. </p>
4447
- */
4448
- bytesWritten?: number;
4449
-
4450
- /**
4451
- * <p> The number of records processed in the flow run. </p>
4452
- */
4453
- recordsProcessed?: number;
4454
- }
4455
-
4456
- export namespace ExecutionResult {
4457
- /**
4458
- * @internal
4459
- */
4460
- export const filterSensitiveLog = (obj: ExecutionResult): any => ({
4461
- ...obj,
4462
- });
4463
- }
4464
-
4465
- /**
4466
- * <p> Specifies information about the past flow run instances for a given flow. </p>
4467
- */
4468
- export interface ExecutionRecord {
4469
- /**
4470
- * <p> Specifies the identifier of the given flow run. </p>
4471
- */
4472
- executionId?: string;
4473
-
4474
- /**
4475
- * <p> Specifies the flow run status and whether it is in progress, has completed successfully,
4476
- * or has failed. </p>
4477
- */
4478
- executionStatus?: ExecutionStatus | string;
4479
-
4480
- /**
4481
- * <p> Describes the result of the given flow run. </p>
4482
- */
4483
- executionResult?: ExecutionResult;
4484
-
4485
- /**
4486
- * <p> Specifies the start time of the flow run. </p>
4487
- */
4488
- startedAt?: Date;
4489
-
4490
- /**
4491
- * <p> Specifies the time of the most recent update. </p>
4492
- */
4493
- lastUpdatedAt?: Date;
4494
-
4495
- /**
4496
- * <p> The timestamp that determines the first new or updated record to be transferred in the
4497
- * flow run. </p>
4498
- */
4499
- dataPullStartTime?: Date;
4500
-
4501
- /**
4502
- * <p> The timestamp that indicates the last new or updated record to be transferred in the flow
4503
- * run. </p>
4504
- */
4505
- dataPullEndTime?: Date;
4506
- }
4507
-
4508
- export namespace ExecutionRecord {
4509
- /**
4510
- * @internal
4511
- */
4512
- export const filterSensitiveLog = (obj: ExecutionRecord): any => ({
4513
- ...obj,
4514
- });
4515
- }
4516
-
4517
- export interface DescribeFlowExecutionRecordsResponse {
4518
- /**
4519
- * <p> Returns a list of all instances when this flow was run. </p>
4520
- */
4521
- flowExecutions?: ExecutionRecord[];
4522
-
4523
- /**
4524
- * <p> The pagination token for the next page of data. </p>
4525
- */
4526
- nextToken?: string;
4527
- }
4528
-
4529
- export namespace DescribeFlowExecutionRecordsResponse {
4530
- /**
4531
- * @internal
4532
- */
4533
- export const filterSensitiveLog = (obj: DescribeFlowExecutionRecordsResponse): any => ({
4534
- ...obj,
4535
- });
4536
- }
4537
-
4538
- /**
4539
- * <p> The properties of the flow, such as its source, destination, trigger type, and so on.
4540
- * </p>
4541
- */
4542
- export interface FlowDefinition {
4543
- /**
4544
- * <p> The flow's Amazon Resource Name (ARN). </p>
4545
- */
4546
- flowArn?: string;
4547
-
4548
- /**
4549
- * <p> A user-entered description of the flow. </p>
4550
- */
4551
- description?: string;
4552
-
4553
- /**
4554
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4555
- * (-) only. </p>
4556
- */
4557
- flowName?: string;
4558
-
4559
- /**
4560
- * <p> Indicates the current status of the flow. </p>
4561
- */
4562
- flowStatus?: FlowStatus | string;
4563
-
4564
- /**
4565
- * <p> Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.
4566
- * </p>
4567
- */
4568
- sourceConnectorType?: ConnectorType | string;
4569
-
4570
- /**
4571
- * <p> Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and
4572
- * so on. </p>
4573
- */
4574
- destinationConnectorType?: ConnectorType | string;
4575
-
4576
- /**
4577
- * <p> Specifies the type of flow trigger. This can be <code>OnDemand</code>,
4578
- * <code>Scheduled</code>, or <code>Event</code>. </p>
4579
- */
4580
- triggerType?: TriggerType | string;
4581
-
4582
- /**
4583
- * <p> Specifies when the flow was created. </p>
4584
- */
4585
- createdAt?: Date;
4586
-
4587
- /**
4588
- * <p> Specifies when the flow was last updated. </p>
4589
- */
4590
- lastUpdatedAt?: Date;
4591
-
4592
- /**
4593
- * <p> The ARN of the user who created the flow. </p>
4594
- */
4595
- createdBy?: string;
4596
-
4597
- /**
4598
- * <p> Specifies the account user name that most recently updated the flow. </p>
4599
- */
4600
- lastUpdatedBy?: string;
4601
-
4602
- /**
4603
- * <p> The tags used to organize, track, or control access for your flow. </p>
4604
- */
4605
- tags?: { [key: string]: string };
4606
-
4607
- /**
4608
- * <p> Describes the details of the most recent flow run. </p>
4609
- */
4610
- lastRunExecutionDetails?: ExecutionDetails;
4611
- }
4612
-
4613
- export namespace FlowDefinition {
4614
- /**
4615
- * @internal
4616
- */
4617
- export const filterSensitiveLog = (obj: FlowDefinition): any => ({
4618
- ...obj,
4619
- });
4620
- }
4621
-
4622
- export interface ListConnectorEntitiesRequest {
4623
- /**
4624
- * <p> The name of the connector profile. The name is unique for each
4625
- * <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the downstream
4626
- * connector. </p>
4627
- */
4628
- connectorProfileName?: string;
4629
-
4630
- /**
4631
- * <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
4632
- */
4633
- connectorType?: ConnectorType | string;
4634
-
4635
- /**
4636
- * <p> This optional parameter is specific to connector implementation. Some connectors support
4637
- * multiple levels or categories of entities. You can find out the list of roots for such
4638
- * providers by sending a request without the <code>entitiesPath</code> parameter. If the
4639
- * connector supports entities at different roots, this initial request returns the list of
4640
- * roots. Otherwise, this request returns all entities supported by the provider. </p>
4641
- */
4642
- entitiesPath?: string;
4643
- }
4644
-
4645
- export namespace ListConnectorEntitiesRequest {
4646
- /**
4647
- * @internal
4648
- */
4649
- export const filterSensitiveLog = (obj: ListConnectorEntitiesRequest): any => ({
4650
- ...obj,
4651
- });
4652
- }
4653
-
4654
- export interface ListConnectorEntitiesResponse {
4655
- /**
4656
- * <p> The response of <code>ListConnectorEntities</code> lists entities grouped by category.
4657
- * This map's key represents the group name, and its value contains the list of entities
4658
- * belonging to that group. </p>
4659
- */
4660
- connectorEntityMap: { [key: string]: ConnectorEntity[] } | undefined;
4661
- }
4662
-
4663
- export namespace ListConnectorEntitiesResponse {
4664
- /**
4665
- * @internal
4666
- */
4667
- export const filterSensitiveLog = (obj: ListConnectorEntitiesResponse): any => ({
4668
- ...obj,
4669
- });
4670
- }
4671
-
4672
- export interface ListFlowsRequest {
4673
- /**
4674
- * <p> Specifies the maximum number of items that should be returned in the result set. </p>
4675
- */
4676
- maxResults?: number;
4677
-
4678
- /**
4679
- * <p> The pagination token for next page of data. </p>
4680
- */
4681
- nextToken?: string;
4682
- }
4683
-
4684
- export namespace ListFlowsRequest {
4685
- /**
4686
- * @internal
4687
- */
4688
- export const filterSensitiveLog = (obj: ListFlowsRequest): any => ({
4689
- ...obj,
4690
- });
4691
- }
4692
-
4693
- export interface ListFlowsResponse {
4694
- /**
4695
- * <p> The list of flows associated with your account. </p>
4696
- */
4697
- flows?: FlowDefinition[];
4698
-
4699
- /**
4700
- * <p> The pagination token for next page of data. </p>
4701
- */
4702
- nextToken?: string;
4703
- }
4704
-
4705
- export namespace ListFlowsResponse {
4706
- /**
4707
- * @internal
4708
- */
4709
- export const filterSensitiveLog = (obj: ListFlowsResponse): any => ({
4710
- ...obj,
4711
- });
4712
- }
4713
-
4714
- export interface ListTagsForResourceRequest {
4715
- /**
4716
- * <p> The Amazon Resource Name (ARN) of the specified flow. </p>
4717
- */
4718
- resourceArn: string | undefined;
4719
- }
4720
-
4721
- export namespace ListTagsForResourceRequest {
4722
- /**
4723
- * @internal
4724
- */
4725
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
4726
- ...obj,
4727
- });
4728
- }
4729
-
4730
- export interface ListTagsForResourceResponse {
4731
- /**
4732
- * <p> The tags used to organize, track, or control access for your flow. </p>
4733
- */
4734
- tags?: { [key: string]: string };
4735
- }
4736
-
4737
- export namespace ListTagsForResourceResponse {
4738
- /**
4739
- * @internal
4740
- */
4741
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
4742
- ...obj,
4743
- });
4744
- }
4745
-
4746
- export interface StartFlowRequest {
4747
- /**
4748
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4749
- * (-) only. </p>
4750
- */
4751
- flowName: string | undefined;
4752
- }
4753
-
4754
- export namespace StartFlowRequest {
4755
- /**
4756
- * @internal
4757
- */
4758
- export const filterSensitiveLog = (obj: StartFlowRequest): any => ({
4759
- ...obj,
4760
- });
4761
- }
4762
-
4763
- export interface StartFlowResponse {
4764
- /**
4765
- * <p> The flow's Amazon Resource Name (ARN). </p>
4766
- */
4767
- flowArn?: string;
4768
-
4769
- /**
4770
- * <p> Indicates the current status of the flow. </p>
4771
- */
4772
- flowStatus?: FlowStatus | string;
4773
-
4774
- /**
4775
- * <p> Returns the internal execution ID of an on-demand flow when the flow is started. For
4776
- * scheduled or event-triggered flows, this value is null. </p>
4777
- */
4778
- executionId?: string;
4779
- }
4780
-
4781
- export namespace StartFlowResponse {
4782
- /**
4783
- * @internal
4784
- */
4785
- export const filterSensitiveLog = (obj: StartFlowResponse): any => ({
4786
- ...obj,
4787
- });
4788
- }
4789
-
4790
- export interface StopFlowRequest {
4791
- /**
4792
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4793
- * (-) only. </p>
4794
- */
4795
- flowName: string | undefined;
4796
- }
4797
-
4798
- export namespace StopFlowRequest {
4799
- /**
4800
- * @internal
4801
- */
4802
- export const filterSensitiveLog = (obj: StopFlowRequest): any => ({
4803
- ...obj,
4804
- });
4805
- }
4806
-
4807
- export interface StopFlowResponse {
4808
- /**
4809
- * <p> The flow's Amazon Resource Name (ARN). </p>
4810
- */
4811
- flowArn?: string;
4812
-
4813
- /**
4814
- * <p> Indicates the current status of the flow. </p>
4815
- */
4816
- flowStatus?: FlowStatus | string;
4817
- }
4818
-
4819
- export namespace StopFlowResponse {
4820
- /**
4821
- * @internal
4822
- */
4823
- export const filterSensitiveLog = (obj: StopFlowResponse): any => ({
4824
- ...obj,
4825
- });
4826
- }
4827
-
4828
- /**
4829
- * <p> The requested operation is not supported for the current flow. </p>
4830
- */
4831
- export interface UnsupportedOperationException extends __SmithyException, $MetadataBearer {
4832
- name: "UnsupportedOperationException";
4833
- $fault: "client";
4834
- message?: string;
4835
- }
4836
-
4837
- export namespace UnsupportedOperationException {
4838
- /**
4839
- * @internal
4840
- */
4841
- export const filterSensitiveLog = (obj: UnsupportedOperationException): any => ({
4842
- ...obj,
4843
- });
4844
- }
4845
-
4846
- export interface TagResourceRequest {
4847
- /**
4848
- * <p> The Amazon Resource Name (ARN) of the flow that you want to tag. </p>
4849
- */
4850
- resourceArn: string | undefined;
4851
-
4852
- /**
4853
- * <p> The tags used to organize, track, or control access for your flow. </p>
4854
- */
4855
- tags: { [key: string]: string } | undefined;
4856
- }
4857
-
4858
- export namespace TagResourceRequest {
4859
- /**
4860
- * @internal
4861
- */
4862
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
4863
- ...obj,
4864
- });
4865
- }
4866
-
4867
- export interface TagResourceResponse {}
4868
-
4869
- export namespace TagResourceResponse {
4870
- /**
4871
- * @internal
4872
- */
4873
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
4874
- ...obj,
4875
- });
4876
- }
4877
-
4878
- export interface UntagResourceRequest {
4879
- /**
4880
- * <p> The Amazon Resource Name (ARN) of the flow that you want to untag. </p>
4881
- */
4882
- resourceArn: string | undefined;
4883
-
4884
- /**
4885
- * <p> The tag keys associated with the tag that you want to remove from your flow. </p>
4886
- */
4887
- tagKeys: string[] | undefined;
4888
- }
4889
-
4890
- export namespace UntagResourceRequest {
4891
- /**
4892
- * @internal
4893
- */
4894
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
4895
- ...obj,
4896
- });
4897
- }
4898
-
4899
- export interface UntagResourceResponse {}
4900
-
4901
- export namespace UntagResourceResponse {
4902
- /**
4903
- * @internal
4904
- */
4905
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
4906
- ...obj,
4907
- });
4908
- }
4909
-
4910
- export interface UpdateConnectorProfileRequest {
4911
- /**
4912
- * <p> The name of the connector profile and is unique for each <code>ConnectorProfile</code> in
4913
- * the Amazon Web Services account. </p>
4914
- */
4915
- connectorProfileName: string | undefined;
4916
-
4917
- /**
4918
- * <p> Indicates the connection mode and if it is public or private. </p>
4919
- */
4920
- connectionMode: ConnectionMode | string | undefined;
4921
-
4922
- /**
4923
- * <p> Defines the connector-specific profile configuration and credentials. </p>
4924
- */
4925
- connectorProfileConfig: ConnectorProfileConfig | undefined;
4926
- }
4927
-
4928
- export namespace UpdateConnectorProfileRequest {
4929
- /**
4930
- * @internal
4931
- */
4932
- export const filterSensitiveLog = (obj: UpdateConnectorProfileRequest): any => ({
4933
- ...obj,
4934
- });
4935
- }
4936
-
4937
- export interface UpdateConnectorProfileResponse {
4938
- /**
4939
- * <p> The Amazon Resource Name (ARN) of the connector profile. </p>
4940
- */
4941
- connectorProfileArn?: string;
4942
- }
4943
-
4944
- export namespace UpdateConnectorProfileResponse {
4945
- /**
4946
- * @internal
4947
- */
4948
- export const filterSensitiveLog = (obj: UpdateConnectorProfileResponse): any => ({
4949
- ...obj,
4950
- });
4951
- }
4952
-
4953
- export interface UpdateFlowRequest {
4954
- /**
4955
- * <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
4956
- * (-) only. </p>
4957
- */
4958
- flowName: string | undefined;
4959
-
4960
- /**
4961
- * <p> A description of the flow. </p>
4962
- */
4963
- description?: string;
4964
-
4965
- /**
4966
- * <p> The trigger settings that determine how and when the flow runs. </p>
4967
- */
4968
- triggerConfig: TriggerConfig | undefined;
4969
-
4970
- /**
4971
- * <p> Contains information about the configuration of the source connector used in the flow.
4972
- * </p>
4973
- */
4974
- sourceFlowConfig: SourceFlowConfig | undefined;
4975
-
4976
- /**
4977
- * <p> The configuration that controls how Amazon AppFlow transfers data to the destination
4978
- * connector. </p>
4979
- */
4980
- destinationFlowConfigList: DestinationFlowConfig[] | undefined;
4981
-
4982
- /**
4983
- * <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow run.
4984
- * </p>
4985
- */
4986
- tasks: Task[] | undefined;
4987
- }
4988
-
4989
- export namespace UpdateFlowRequest {
4990
- /**
4991
- * @internal
4992
- */
4993
- export const filterSensitiveLog = (obj: UpdateFlowRequest): any => ({
4994
- ...obj,
4995
- });
4996
- }
4997
-
4998
- export interface UpdateFlowResponse {
4999
- /**
5000
- * <p>Indicates the current status of the flow. </p>
5001
- */
5002
- flowStatus?: FlowStatus | string;
5003
- }
5004
-
5005
- export namespace UpdateFlowResponse {
5006
- /**
5007
- * @internal
5008
- */
5009
- export const filterSensitiveLog = (obj: UpdateFlowResponse): any => ({
5010
- ...obj,
5011
- });
5012
- }