@aws-sdk/client-appflow 3.379.1 → 3.382.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/models/models_0.d.ts +651 -0
- package/package.json +5 -5
|
@@ -31,11 +31,13 @@ export type AggregationType = (typeof AggregationType)[keyof typeof AggregationT
|
|
|
31
31
|
*/
|
|
32
32
|
export interface AggregationConfig {
|
|
33
33
|
/**
|
|
34
|
+
* @public
|
|
34
35
|
* <p> Specifies whether Amazon AppFlow aggregates the flow records into a single file, or
|
|
35
36
|
* leave them unaggregated. </p>
|
|
36
37
|
*/
|
|
37
38
|
aggregationType?: AggregationType | string;
|
|
38
39
|
/**
|
|
40
|
+
* @public
|
|
39
41
|
* <p>The desired file size, in MB, for each output file that Amazon AppFlow writes to the
|
|
40
42
|
* flow destination. For each file, Amazon AppFlow attempts to achieve the size that you
|
|
41
43
|
* specify. The actual file sizes might differ from this target based on the number and size of
|
|
@@ -60,11 +62,13 @@ export type AmplitudeConnectorOperator = (typeof AmplitudeConnectorOperator)[key
|
|
|
60
62
|
*/
|
|
61
63
|
export interface AmplitudeConnectorProfileCredentials {
|
|
62
64
|
/**
|
|
65
|
+
* @public
|
|
63
66
|
* <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
|
|
64
67
|
* program to your API. </p>
|
|
65
68
|
*/
|
|
66
69
|
apiKey: string | undefined;
|
|
67
70
|
/**
|
|
71
|
+
* @public
|
|
68
72
|
* <p> The Secret Access Key portion of the credentials. </p>
|
|
69
73
|
*/
|
|
70
74
|
secretKey: string | undefined;
|
|
@@ -87,6 +91,7 @@ export interface AmplitudeMetadata {
|
|
|
87
91
|
*/
|
|
88
92
|
export interface AmplitudeSourceProperties {
|
|
89
93
|
/**
|
|
94
|
+
* @public
|
|
90
95
|
* <p> The object specified in the Amplitude flow source. </p>
|
|
91
96
|
*/
|
|
92
97
|
object: string | undefined;
|
|
@@ -97,10 +102,12 @@ export interface AmplitudeSourceProperties {
|
|
|
97
102
|
*/
|
|
98
103
|
export interface ApiKeyCredentials {
|
|
99
104
|
/**
|
|
105
|
+
* @public
|
|
100
106
|
* <p>The API key required for API key authentication.</p>
|
|
101
107
|
*/
|
|
102
108
|
apiKey: string | undefined;
|
|
103
109
|
/**
|
|
110
|
+
* @public
|
|
104
111
|
* <p>The API secret key required for API key authentication.</p>
|
|
105
112
|
*/
|
|
106
113
|
apiSecretKey?: string;
|
|
@@ -111,26 +118,32 @@ export interface ApiKeyCredentials {
|
|
|
111
118
|
*/
|
|
112
119
|
export interface AuthParameter {
|
|
113
120
|
/**
|
|
121
|
+
* @public
|
|
114
122
|
* <p>The authentication key required to authenticate with the connector.</p>
|
|
115
123
|
*/
|
|
116
124
|
key?: string;
|
|
117
125
|
/**
|
|
126
|
+
* @public
|
|
118
127
|
* <p>Indicates whether this authentication parameter is required.</p>
|
|
119
128
|
*/
|
|
120
129
|
isRequired?: boolean;
|
|
121
130
|
/**
|
|
131
|
+
* @public
|
|
122
132
|
* <p>Label used for authentication parameter.</p>
|
|
123
133
|
*/
|
|
124
134
|
label?: string;
|
|
125
135
|
/**
|
|
136
|
+
* @public
|
|
126
137
|
* <p>A description about the authentication parameter.</p>
|
|
127
138
|
*/
|
|
128
139
|
description?: string;
|
|
129
140
|
/**
|
|
141
|
+
* @public
|
|
130
142
|
* <p>Indicates whether this authentication parameter is a sensitive field.</p>
|
|
131
143
|
*/
|
|
132
144
|
isSensitiveField?: boolean;
|
|
133
145
|
/**
|
|
146
|
+
* @public
|
|
134
147
|
* <p>Contains default values for this authentication parameter that are supplied by the
|
|
135
148
|
* connector.</p>
|
|
136
149
|
*/
|
|
@@ -142,10 +155,12 @@ export interface AuthParameter {
|
|
|
142
155
|
*/
|
|
143
156
|
export interface CustomAuthConfig {
|
|
144
157
|
/**
|
|
158
|
+
* @public
|
|
145
159
|
* <p>The authentication type that the custom connector uses.</p>
|
|
146
160
|
*/
|
|
147
161
|
customAuthenticationType?: string;
|
|
148
162
|
/**
|
|
163
|
+
* @public
|
|
149
164
|
* <p>Information about authentication parameters required for authentication.</p>
|
|
150
165
|
*/
|
|
151
166
|
authParameters?: AuthParameter[];
|
|
@@ -168,31 +183,38 @@ export type OAuth2CustomPropType = (typeof OAuth2CustomPropType)[keyof typeof OA
|
|
|
168
183
|
*/
|
|
169
184
|
export interface OAuth2CustomParameter {
|
|
170
185
|
/**
|
|
186
|
+
* @public
|
|
171
187
|
* <p>The key of the custom parameter required for OAuth 2.0 authentication.</p>
|
|
172
188
|
*/
|
|
173
189
|
key?: string;
|
|
174
190
|
/**
|
|
191
|
+
* @public
|
|
175
192
|
* <p>Indicates whether the custom parameter for OAuth 2.0 authentication is required.</p>
|
|
176
193
|
*/
|
|
177
194
|
isRequired?: boolean;
|
|
178
195
|
/**
|
|
196
|
+
* @public
|
|
179
197
|
* <p>The label of the custom parameter used for OAuth 2.0 authentication.</p>
|
|
180
198
|
*/
|
|
181
199
|
label?: string;
|
|
182
200
|
/**
|
|
201
|
+
* @public
|
|
183
202
|
* <p>A description about the custom parameter used for OAuth 2.0 authentication.</p>
|
|
184
203
|
*/
|
|
185
204
|
description?: string;
|
|
186
205
|
/**
|
|
206
|
+
* @public
|
|
187
207
|
* <p>Indicates whether this authentication custom parameter is a sensitive field.</p>
|
|
188
208
|
*/
|
|
189
209
|
isSensitiveField?: boolean;
|
|
190
210
|
/**
|
|
211
|
+
* @public
|
|
191
212
|
* <p>Contains default values for this authentication parameter that are supplied by the
|
|
192
213
|
* connector.</p>
|
|
193
214
|
*/
|
|
194
215
|
connectorSuppliedValues?: string[];
|
|
195
216
|
/**
|
|
217
|
+
* @public
|
|
196
218
|
* <p>Indicates whether custom parameter is used with TokenUrl or AuthUrl.</p>
|
|
197
219
|
*/
|
|
198
220
|
type?: OAuth2CustomPropType | string;
|
|
@@ -216,22 +238,27 @@ export type OAuth2GrantType = (typeof OAuth2GrantType)[keyof typeof OAuth2GrantT
|
|
|
216
238
|
*/
|
|
217
239
|
export interface OAuth2Defaults {
|
|
218
240
|
/**
|
|
241
|
+
* @public
|
|
219
242
|
* <p>OAuth 2.0 scopes that the connector supports.</p>
|
|
220
243
|
*/
|
|
221
244
|
oauthScopes?: string[];
|
|
222
245
|
/**
|
|
246
|
+
* @public
|
|
223
247
|
* <p>Token URLs that can be used for OAuth 2.0 authentication.</p>
|
|
224
248
|
*/
|
|
225
249
|
tokenUrls?: string[];
|
|
226
250
|
/**
|
|
251
|
+
* @public
|
|
227
252
|
* <p>Auth code URLs that can be used for OAuth 2.0 authentication.</p>
|
|
228
253
|
*/
|
|
229
254
|
authCodeUrls?: string[];
|
|
230
255
|
/**
|
|
256
|
+
* @public
|
|
231
257
|
* <p>OAuth 2.0 grant types supported by the connector.</p>
|
|
232
258
|
*/
|
|
233
259
|
oauth2GrantTypesSupported?: (OAuth2GrantType | string)[];
|
|
234
260
|
/**
|
|
261
|
+
* @public
|
|
235
262
|
* <p>List of custom parameters required for OAuth 2.0 authentication.</p>
|
|
236
263
|
*/
|
|
237
264
|
oauth2CustomProperties?: OAuth2CustomParameter[];
|
|
@@ -242,26 +269,32 @@ export interface OAuth2Defaults {
|
|
|
242
269
|
*/
|
|
243
270
|
export interface AuthenticationConfig {
|
|
244
271
|
/**
|
|
272
|
+
* @public
|
|
245
273
|
* <p>Indicates whether basic authentication is supported by the connector.</p>
|
|
246
274
|
*/
|
|
247
275
|
isBasicAuthSupported?: boolean;
|
|
248
276
|
/**
|
|
277
|
+
* @public
|
|
249
278
|
* <p>Indicates whether API key authentication is supported by the connector</p>
|
|
250
279
|
*/
|
|
251
280
|
isApiKeyAuthSupported?: boolean;
|
|
252
281
|
/**
|
|
282
|
+
* @public
|
|
253
283
|
* <p>Indicates whether OAuth 2.0 authentication is supported by the connector.</p>
|
|
254
284
|
*/
|
|
255
285
|
isOAuth2Supported?: boolean;
|
|
256
286
|
/**
|
|
287
|
+
* @public
|
|
257
288
|
* <p>Indicates whether custom authentication is supported by the connector</p>
|
|
258
289
|
*/
|
|
259
290
|
isCustomAuthSupported?: boolean;
|
|
260
291
|
/**
|
|
292
|
+
* @public
|
|
261
293
|
* <p>Contains the default values required for OAuth 2.0 authentication.</p>
|
|
262
294
|
*/
|
|
263
295
|
oAuth2Defaults?: OAuth2Defaults;
|
|
264
296
|
/**
|
|
297
|
+
* @public
|
|
265
298
|
* <p>Contains information required for custom authentication.</p>
|
|
266
299
|
*/
|
|
267
300
|
customAuthConfigs?: CustomAuthConfig[];
|
|
@@ -286,10 +319,12 @@ export type AuthenticationType = (typeof AuthenticationType)[keyof typeof Authen
|
|
|
286
319
|
*/
|
|
287
320
|
export interface BasicAuthCredentials {
|
|
288
321
|
/**
|
|
322
|
+
* @public
|
|
289
323
|
* <p> The username to use to connect to a resource. </p>
|
|
290
324
|
*/
|
|
291
325
|
username: string | undefined;
|
|
292
326
|
/**
|
|
327
|
+
* @public
|
|
293
328
|
* <p> The password to use to connect to a resource.</p>
|
|
294
329
|
*/
|
|
295
330
|
password: string | undefined;
|
|
@@ -299,10 +334,12 @@ export interface BasicAuthCredentials {
|
|
|
299
334
|
*/
|
|
300
335
|
export interface CancelFlowExecutionsRequest {
|
|
301
336
|
/**
|
|
337
|
+
* @public
|
|
302
338
|
* <p>The name of a flow with active runs that you want to cancel.</p>
|
|
303
339
|
*/
|
|
304
340
|
flowName: string | undefined;
|
|
305
341
|
/**
|
|
342
|
+
* @public
|
|
306
343
|
* <p>The ID of each active run to cancel. These runs must belong to the flow you specify in
|
|
307
344
|
* your request.</p>
|
|
308
345
|
* <p>If you omit this parameter, your request ends all active runs that belong to the
|
|
@@ -315,6 +352,7 @@ export interface CancelFlowExecutionsRequest {
|
|
|
315
352
|
*/
|
|
316
353
|
export interface CancelFlowExecutionsResponse {
|
|
317
354
|
/**
|
|
355
|
+
* @public
|
|
318
356
|
* <p>The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible
|
|
319
357
|
* for canceling because they haven't started yet or have already completed.</p>
|
|
320
358
|
*/
|
|
@@ -449,6 +487,7 @@ export interface EventBridgeMetadata {
|
|
|
449
487
|
*/
|
|
450
488
|
export interface GoogleAnalyticsMetadata {
|
|
451
489
|
/**
|
|
490
|
+
* @public
|
|
452
491
|
* <p> The desired authorization scope for the Google Analytics account. </p>
|
|
453
492
|
*/
|
|
454
493
|
oAuthScopes?: string[];
|
|
@@ -459,6 +498,7 @@ export interface GoogleAnalyticsMetadata {
|
|
|
459
498
|
*/
|
|
460
499
|
export interface HoneycodeMetadata {
|
|
461
500
|
/**
|
|
501
|
+
* @public
|
|
462
502
|
* <p> The desired authorization scope for the Amazon Honeycode account. </p>
|
|
463
503
|
*/
|
|
464
504
|
oAuthScopes?: string[];
|
|
@@ -512,15 +552,18 @@ export type SalesforceDataTransferApi = (typeof SalesforceDataTransferApi)[keyof
|
|
|
512
552
|
*/
|
|
513
553
|
export interface SalesforceMetadata {
|
|
514
554
|
/**
|
|
555
|
+
* @public
|
|
515
556
|
* <p> The desired authorization scope for the Salesforce account. </p>
|
|
516
557
|
*/
|
|
517
558
|
oAuthScopes?: string[];
|
|
518
559
|
/**
|
|
560
|
+
* @public
|
|
519
561
|
* <p>The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers
|
|
520
562
|
* data to or from Salesforce.</p>
|
|
521
563
|
*/
|
|
522
564
|
dataTransferApis?: (SalesforceDataTransferApi | string)[];
|
|
523
565
|
/**
|
|
566
|
+
* @public
|
|
524
567
|
* <p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access
|
|
525
568
|
* token from Salesforce. Amazon AppFlow requires an access token each time it attempts to
|
|
526
569
|
* access your Salesforce records.</p>
|
|
@@ -573,6 +616,7 @@ export interface SingularMetadata {
|
|
|
573
616
|
*/
|
|
574
617
|
export interface SlackMetadata {
|
|
575
618
|
/**
|
|
619
|
+
* @public
|
|
576
620
|
* <p> The desired authorization scope for the Slack account. </p>
|
|
577
621
|
*/
|
|
578
622
|
oAuthScopes?: string[];
|
|
@@ -583,6 +627,7 @@ export interface SlackMetadata {
|
|
|
583
627
|
*/
|
|
584
628
|
export interface SnowflakeMetadata {
|
|
585
629
|
/**
|
|
630
|
+
* @public
|
|
586
631
|
* <p> Specifies the supported Amazon Web Services Regions when using Snowflake. </p>
|
|
587
632
|
*/
|
|
588
633
|
supportedRegions?: string[];
|
|
@@ -611,6 +656,7 @@ export interface VeevaMetadata {
|
|
|
611
656
|
*/
|
|
612
657
|
export interface ZendeskMetadata {
|
|
613
658
|
/**
|
|
659
|
+
* @public
|
|
614
660
|
* <p> The desired authorization scope for the Zendesk account. </p>
|
|
615
661
|
*/
|
|
616
662
|
oAuthScopes?: string[];
|
|
@@ -622,90 +668,112 @@ export interface ZendeskMetadata {
|
|
|
622
668
|
*/
|
|
623
669
|
export interface ConnectorMetadata {
|
|
624
670
|
/**
|
|
671
|
+
* @public
|
|
625
672
|
* <p> The connector metadata specific to Amplitude. </p>
|
|
626
673
|
*/
|
|
627
674
|
Amplitude?: AmplitudeMetadata;
|
|
628
675
|
/**
|
|
676
|
+
* @public
|
|
629
677
|
* <p> The connector metadata specific to Datadog. </p>
|
|
630
678
|
*/
|
|
631
679
|
Datadog?: DatadogMetadata;
|
|
632
680
|
/**
|
|
681
|
+
* @public
|
|
633
682
|
* <p> The connector metadata specific to Dynatrace. </p>
|
|
634
683
|
*/
|
|
635
684
|
Dynatrace?: DynatraceMetadata;
|
|
636
685
|
/**
|
|
686
|
+
* @public
|
|
637
687
|
* <p> The connector metadata specific to Google Analytics. </p>
|
|
638
688
|
*/
|
|
639
689
|
GoogleAnalytics?: GoogleAnalyticsMetadata;
|
|
640
690
|
/**
|
|
691
|
+
* @public
|
|
641
692
|
* <p> The connector metadata specific to Infor Nexus. </p>
|
|
642
693
|
*/
|
|
643
694
|
InforNexus?: InforNexusMetadata;
|
|
644
695
|
/**
|
|
696
|
+
* @public
|
|
645
697
|
* <p> The connector metadata specific to Marketo. </p>
|
|
646
698
|
*/
|
|
647
699
|
Marketo?: MarketoMetadata;
|
|
648
700
|
/**
|
|
701
|
+
* @public
|
|
649
702
|
* <p> The connector metadata specific to Amazon Redshift. </p>
|
|
650
703
|
*/
|
|
651
704
|
Redshift?: RedshiftMetadata;
|
|
652
705
|
/**
|
|
706
|
+
* @public
|
|
653
707
|
* <p> The connector metadata specific to Amazon S3. </p>
|
|
654
708
|
*/
|
|
655
709
|
S3?: S3Metadata;
|
|
656
710
|
/**
|
|
711
|
+
* @public
|
|
657
712
|
* <p> The connector metadata specific to Salesforce. </p>
|
|
658
713
|
*/
|
|
659
714
|
Salesforce?: SalesforceMetadata;
|
|
660
715
|
/**
|
|
716
|
+
* @public
|
|
661
717
|
* <p> The connector metadata specific to ServiceNow. </p>
|
|
662
718
|
*/
|
|
663
719
|
ServiceNow?: ServiceNowMetadata;
|
|
664
720
|
/**
|
|
721
|
+
* @public
|
|
665
722
|
* <p> The connector metadata specific to Singular. </p>
|
|
666
723
|
*/
|
|
667
724
|
Singular?: SingularMetadata;
|
|
668
725
|
/**
|
|
726
|
+
* @public
|
|
669
727
|
* <p> The connector metadata specific to Slack. </p>
|
|
670
728
|
*/
|
|
671
729
|
Slack?: SlackMetadata;
|
|
672
730
|
/**
|
|
731
|
+
* @public
|
|
673
732
|
* <p> The connector metadata specific to Snowflake. </p>
|
|
674
733
|
*/
|
|
675
734
|
Snowflake?: SnowflakeMetadata;
|
|
676
735
|
/**
|
|
736
|
+
* @public
|
|
677
737
|
* <p> The connector metadata specific to Trend Micro. </p>
|
|
678
738
|
*/
|
|
679
739
|
Trendmicro?: TrendmicroMetadata;
|
|
680
740
|
/**
|
|
741
|
+
* @public
|
|
681
742
|
* <p> The connector metadata specific to Veeva. </p>
|
|
682
743
|
*/
|
|
683
744
|
Veeva?: VeevaMetadata;
|
|
684
745
|
/**
|
|
746
|
+
* @public
|
|
685
747
|
* <p> The connector metadata specific to Zendesk. </p>
|
|
686
748
|
*/
|
|
687
749
|
Zendesk?: ZendeskMetadata;
|
|
688
750
|
/**
|
|
751
|
+
* @public
|
|
689
752
|
* <p> The connector metadata specific to Amazon EventBridge. </p>
|
|
690
753
|
*/
|
|
691
754
|
EventBridge?: EventBridgeMetadata;
|
|
692
755
|
/**
|
|
756
|
+
* @public
|
|
693
757
|
* <p> The connector metadata specific to Upsolver. </p>
|
|
694
758
|
*/
|
|
695
759
|
Upsolver?: UpsolverMetadata;
|
|
696
760
|
/**
|
|
761
|
+
* @public
|
|
697
762
|
* <p> The connector metadata specific to Amazon Connect Customer Profiles. </p>
|
|
698
763
|
*/
|
|
699
764
|
CustomerProfiles?: CustomerProfilesMetadata;
|
|
700
765
|
/**
|
|
766
|
+
* @public
|
|
701
767
|
* <p> The connector metadata specific to Amazon Honeycode. </p>
|
|
702
768
|
*/
|
|
703
769
|
Honeycode?: HoneycodeMetadata;
|
|
704
770
|
/**
|
|
771
|
+
* @public
|
|
705
772
|
* <p> The connector metadata specific to SAPOData. </p>
|
|
706
773
|
*/
|
|
707
774
|
SAPOData?: SAPODataMetadata;
|
|
708
775
|
/**
|
|
776
|
+
* @public
|
|
709
777
|
* <p>The connector metadata specific to Salesforce Pardot.</p>
|
|
710
778
|
*/
|
|
711
779
|
Pardot?: PardotMetadata;
|
|
@@ -717,6 +785,7 @@ export interface ConnectorMetadata {
|
|
|
717
785
|
*/
|
|
718
786
|
export interface LambdaConnectorProvisioningConfig {
|
|
719
787
|
/**
|
|
788
|
+
* @public
|
|
720
789
|
* <p>Lambda ARN of the connector being registered.</p>
|
|
721
790
|
*/
|
|
722
791
|
lambdaArn: string | undefined;
|
|
@@ -727,6 +796,7 @@ export interface LambdaConnectorProvisioningConfig {
|
|
|
727
796
|
*/
|
|
728
797
|
export interface ConnectorProvisioningConfig {
|
|
729
798
|
/**
|
|
799
|
+
* @public
|
|
730
800
|
* <p>Contains information about the configuration of the lambda which is being registered as
|
|
731
801
|
* the connector.</p>
|
|
732
802
|
*/
|
|
@@ -750,30 +820,37 @@ export type ConnectorProvisioningType = (typeof ConnectorProvisioningType)[keyof
|
|
|
750
820
|
*/
|
|
751
821
|
export interface ConnectorRuntimeSetting {
|
|
752
822
|
/**
|
|
823
|
+
* @public
|
|
753
824
|
* <p>Contains value information about the connector runtime setting.</p>
|
|
754
825
|
*/
|
|
755
826
|
key?: string;
|
|
756
827
|
/**
|
|
828
|
+
* @public
|
|
757
829
|
* <p>Data type of the connector runtime setting.</p>
|
|
758
830
|
*/
|
|
759
831
|
dataType?: string;
|
|
760
832
|
/**
|
|
833
|
+
* @public
|
|
761
834
|
* <p>Indicates whether this connector runtime setting is required.</p>
|
|
762
835
|
*/
|
|
763
836
|
isRequired?: boolean;
|
|
764
837
|
/**
|
|
838
|
+
* @public
|
|
765
839
|
* <p>A label used for connector runtime setting.</p>
|
|
766
840
|
*/
|
|
767
841
|
label?: string;
|
|
768
842
|
/**
|
|
843
|
+
* @public
|
|
769
844
|
* <p>A description about the connector runtime setting.</p>
|
|
770
845
|
*/
|
|
771
846
|
description?: string;
|
|
772
847
|
/**
|
|
848
|
+
* @public
|
|
773
849
|
* <p>Indicates the scope of the connector runtime setting.</p>
|
|
774
850
|
*/
|
|
775
851
|
scope?: string;
|
|
776
852
|
/**
|
|
853
|
+
* @public
|
|
777
854
|
* <p>Contains default values for the connector runtime setting that are supplied by the
|
|
778
855
|
* connector.</p>
|
|
779
856
|
*/
|
|
@@ -833,10 +910,12 @@ export type DataTransferApiType = (typeof DataTransferApiType)[keyof typeof Data
|
|
|
833
910
|
*/
|
|
834
911
|
export interface DataTransferApi {
|
|
835
912
|
/**
|
|
913
|
+
* @public
|
|
836
914
|
* <p>The name of the connector application API.</p>
|
|
837
915
|
*/
|
|
838
916
|
Name?: string;
|
|
839
917
|
/**
|
|
918
|
+
* @public
|
|
840
919
|
* <p>You can specify one of the following types:</p>
|
|
841
920
|
* <dl>
|
|
842
921
|
* <dt>AUTOMATIC</dt>
|
|
@@ -950,111 +1029,138 @@ export type WriteOperationType = (typeof WriteOperationType)[keyof typeof WriteO
|
|
|
950
1029
|
*/
|
|
951
1030
|
export interface ConnectorConfiguration {
|
|
952
1031
|
/**
|
|
1032
|
+
* @public
|
|
953
1033
|
* <p> Specifies whether the connector can be used as a source. </p>
|
|
954
1034
|
*/
|
|
955
1035
|
canUseAsSource?: boolean;
|
|
956
1036
|
/**
|
|
1037
|
+
* @public
|
|
957
1038
|
* <p> Specifies whether the connector can be used as a destination. </p>
|
|
958
1039
|
*/
|
|
959
1040
|
canUseAsDestination?: boolean;
|
|
960
1041
|
/**
|
|
1042
|
+
* @public
|
|
961
1043
|
* <p> Lists the connectors that are available for use as destinations. </p>
|
|
962
1044
|
*/
|
|
963
1045
|
supportedDestinationConnectors?: (ConnectorType | string)[];
|
|
964
1046
|
/**
|
|
1047
|
+
* @public
|
|
965
1048
|
* <p> Specifies the supported flow frequency for that connector. </p>
|
|
966
1049
|
*/
|
|
967
1050
|
supportedSchedulingFrequencies?: (ScheduleFrequencyType | string)[];
|
|
968
1051
|
/**
|
|
1052
|
+
* @public
|
|
969
1053
|
* <p> Specifies if PrivateLink is enabled for that connector. </p>
|
|
970
1054
|
*/
|
|
971
1055
|
isPrivateLinkEnabled?: boolean;
|
|
972
1056
|
/**
|
|
1057
|
+
* @public
|
|
973
1058
|
* <p> Specifies if a PrivateLink endpoint URL is required. </p>
|
|
974
1059
|
*/
|
|
975
1060
|
isPrivateLinkEndpointUrlRequired?: boolean;
|
|
976
1061
|
/**
|
|
1062
|
+
* @public
|
|
977
1063
|
* <p> Specifies the supported trigger types for the flow. </p>
|
|
978
1064
|
*/
|
|
979
1065
|
supportedTriggerTypes?: (TriggerType | string)[];
|
|
980
1066
|
/**
|
|
1067
|
+
* @public
|
|
981
1068
|
* <p> Specifies connector-specific metadata such as <code>oAuthScopes</code>,
|
|
982
1069
|
* <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>
|
|
983
1070
|
*/
|
|
984
1071
|
connectorMetadata?: ConnectorMetadata;
|
|
985
1072
|
/**
|
|
1073
|
+
* @public
|
|
986
1074
|
* <p>The connector type.</p>
|
|
987
1075
|
*/
|
|
988
1076
|
connectorType?: ConnectorType | string;
|
|
989
1077
|
/**
|
|
1078
|
+
* @public
|
|
990
1079
|
* <p>The label used for registering the connector.</p>
|
|
991
1080
|
*/
|
|
992
1081
|
connectorLabel?: string;
|
|
993
1082
|
/**
|
|
1083
|
+
* @public
|
|
994
1084
|
* <p>A description about the connector.</p>
|
|
995
1085
|
*/
|
|
996
1086
|
connectorDescription?: string;
|
|
997
1087
|
/**
|
|
1088
|
+
* @public
|
|
998
1089
|
* <p>The owner who developed the connector.</p>
|
|
999
1090
|
*/
|
|
1000
1091
|
connectorOwner?: string;
|
|
1001
1092
|
/**
|
|
1093
|
+
* @public
|
|
1002
1094
|
* <p>The connector name.</p>
|
|
1003
1095
|
*/
|
|
1004
1096
|
connectorName?: string;
|
|
1005
1097
|
/**
|
|
1098
|
+
* @public
|
|
1006
1099
|
* <p>The connector version.</p>
|
|
1007
1100
|
*/
|
|
1008
1101
|
connectorVersion?: string;
|
|
1009
1102
|
/**
|
|
1103
|
+
* @public
|
|
1010
1104
|
* <p>The Amazon Resource Name (ARN) for the registered connector.</p>
|
|
1011
1105
|
*/
|
|
1012
1106
|
connectorArn?: string;
|
|
1013
1107
|
/**
|
|
1108
|
+
* @public
|
|
1014
1109
|
* <p>The connection modes that the connector supports.</p>
|
|
1015
1110
|
*/
|
|
1016
1111
|
connectorModes?: string[];
|
|
1017
1112
|
/**
|
|
1113
|
+
* @public
|
|
1018
1114
|
* <p>The authentication config required for the connector.</p>
|
|
1019
1115
|
*/
|
|
1020
1116
|
authenticationConfig?: AuthenticationConfig;
|
|
1021
1117
|
/**
|
|
1118
|
+
* @public
|
|
1022
1119
|
* <p>The required connector runtime settings.</p>
|
|
1023
1120
|
*/
|
|
1024
1121
|
connectorRuntimeSettings?: ConnectorRuntimeSetting[];
|
|
1025
1122
|
/**
|
|
1123
|
+
* @public
|
|
1026
1124
|
* <p>A list of API versions that are supported by the connector.</p>
|
|
1027
1125
|
*/
|
|
1028
1126
|
supportedApiVersions?: string[];
|
|
1029
1127
|
/**
|
|
1128
|
+
* @public
|
|
1030
1129
|
* <p>A list of operators supported by the connector.</p>
|
|
1031
1130
|
*/
|
|
1032
1131
|
supportedOperators?: (Operators | string)[];
|
|
1033
1132
|
/**
|
|
1133
|
+
* @public
|
|
1034
1134
|
* <p>A list of write operations supported by the connector.</p>
|
|
1035
1135
|
*/
|
|
1036
1136
|
supportedWriteOperations?: (WriteOperationType | string)[];
|
|
1037
1137
|
/**
|
|
1138
|
+
* @public
|
|
1038
1139
|
* <p>The provisioning type used to register the connector.</p>
|
|
1039
1140
|
*/
|
|
1040
1141
|
connectorProvisioningType?: ConnectorProvisioningType | string;
|
|
1041
1142
|
/**
|
|
1143
|
+
* @public
|
|
1042
1144
|
* <p>The configuration required for registering the connector.</p>
|
|
1043
1145
|
*/
|
|
1044
1146
|
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
1045
1147
|
/**
|
|
1148
|
+
* @public
|
|
1046
1149
|
* <p>Logo URL of the connector.</p>
|
|
1047
1150
|
*/
|
|
1048
1151
|
logoURL?: string;
|
|
1049
1152
|
/**
|
|
1153
|
+
* @public
|
|
1050
1154
|
* <p>The date on which the connector was registered.</p>
|
|
1051
1155
|
*/
|
|
1052
1156
|
registeredAt?: Date;
|
|
1053
1157
|
/**
|
|
1158
|
+
* @public
|
|
1054
1159
|
* <p>Information about who registered the connector.</p>
|
|
1055
1160
|
*/
|
|
1056
1161
|
registeredBy?: string;
|
|
1057
1162
|
/**
|
|
1163
|
+
* @public
|
|
1058
1164
|
* <p>The data transfer types that the connector supports.</p>
|
|
1059
1165
|
* <dl>
|
|
1060
1166
|
* <dt>RECORD</dt>
|
|
@@ -1069,6 +1175,7 @@ export interface ConnectorConfiguration {
|
|
|
1069
1175
|
*/
|
|
1070
1176
|
supportedDataTransferTypes?: (SupportedDataTransferType | string)[];
|
|
1071
1177
|
/**
|
|
1178
|
+
* @public
|
|
1072
1179
|
* <p>The APIs of the connector application that Amazon AppFlow can use to transfer your
|
|
1073
1180
|
* data.</p>
|
|
1074
1181
|
*/
|
|
@@ -1080,50 +1187,62 @@ export interface ConnectorConfiguration {
|
|
|
1080
1187
|
*/
|
|
1081
1188
|
export interface ConnectorDetail {
|
|
1082
1189
|
/**
|
|
1190
|
+
* @public
|
|
1083
1191
|
* <p>A description about the registered connector.</p>
|
|
1084
1192
|
*/
|
|
1085
1193
|
connectorDescription?: string;
|
|
1086
1194
|
/**
|
|
1195
|
+
* @public
|
|
1087
1196
|
* <p>The name of the connector.</p>
|
|
1088
1197
|
*/
|
|
1089
1198
|
connectorName?: string;
|
|
1090
1199
|
/**
|
|
1200
|
+
* @public
|
|
1091
1201
|
* <p>The owner of the connector.</p>
|
|
1092
1202
|
*/
|
|
1093
1203
|
connectorOwner?: string;
|
|
1094
1204
|
/**
|
|
1205
|
+
* @public
|
|
1095
1206
|
* <p>The connector version.</p>
|
|
1096
1207
|
*/
|
|
1097
1208
|
connectorVersion?: string;
|
|
1098
1209
|
/**
|
|
1210
|
+
* @public
|
|
1099
1211
|
* <p>The application type of the connector.</p>
|
|
1100
1212
|
*/
|
|
1101
1213
|
applicationType?: string;
|
|
1102
1214
|
/**
|
|
1215
|
+
* @public
|
|
1103
1216
|
* <p>The connector type.</p>
|
|
1104
1217
|
*/
|
|
1105
1218
|
connectorType?: ConnectorType | string;
|
|
1106
1219
|
/**
|
|
1220
|
+
* @public
|
|
1107
1221
|
* <p>A label used for the connector.</p>
|
|
1108
1222
|
*/
|
|
1109
1223
|
connectorLabel?: string;
|
|
1110
1224
|
/**
|
|
1225
|
+
* @public
|
|
1111
1226
|
* <p>The time at which the connector was registered.</p>
|
|
1112
1227
|
*/
|
|
1113
1228
|
registeredAt?: Date;
|
|
1114
1229
|
/**
|
|
1230
|
+
* @public
|
|
1115
1231
|
* <p>The user who registered the connector.</p>
|
|
1116
1232
|
*/
|
|
1117
1233
|
registeredBy?: string;
|
|
1118
1234
|
/**
|
|
1235
|
+
* @public
|
|
1119
1236
|
* <p>The provisioning type that the connector uses.</p>
|
|
1120
1237
|
*/
|
|
1121
1238
|
connectorProvisioningType?: ConnectorProvisioningType | string;
|
|
1122
1239
|
/**
|
|
1240
|
+
* @public
|
|
1123
1241
|
* <p>The connection mode that the connector supports.</p>
|
|
1124
1242
|
*/
|
|
1125
1243
|
connectorModes?: string[];
|
|
1126
1244
|
/**
|
|
1245
|
+
* @public
|
|
1127
1246
|
* <p>The data transfer types that the connector supports.</p>
|
|
1128
1247
|
* <dl>
|
|
1129
1248
|
* <dt>RECORD</dt>
|
|
@@ -1147,14 +1266,17 @@ export interface ConnectorDetail {
|
|
|
1147
1266
|
*/
|
|
1148
1267
|
export interface ConnectorEntity {
|
|
1149
1268
|
/**
|
|
1269
|
+
* @public
|
|
1150
1270
|
* <p> The name of the connector entity. </p>
|
|
1151
1271
|
*/
|
|
1152
1272
|
name: string | undefined;
|
|
1153
1273
|
/**
|
|
1274
|
+
* @public
|
|
1154
1275
|
* <p> The label applied to the connector entity. </p>
|
|
1155
1276
|
*/
|
|
1156
1277
|
label?: string;
|
|
1157
1278
|
/**
|
|
1279
|
+
* @public
|
|
1158
1280
|
* <p> Specifies whether the connector entity is a parent or a category and has more entities
|
|
1159
1281
|
* nested underneath it. If another call is made with <code>entitiesPath =
|
|
1160
1282
|
* "the_current_entity_name_with_hasNestedEntities_true"</code>, then it returns the nested
|
|
@@ -1170,28 +1292,34 @@ export interface ConnectorEntity {
|
|
|
1170
1292
|
*/
|
|
1171
1293
|
export interface DestinationFieldProperties {
|
|
1172
1294
|
/**
|
|
1295
|
+
* @public
|
|
1173
1296
|
* <p> Specifies if the destination field can be created by the current user. </p>
|
|
1174
1297
|
*/
|
|
1175
1298
|
isCreatable?: boolean;
|
|
1176
1299
|
/**
|
|
1300
|
+
* @public
|
|
1177
1301
|
* <p> Specifies if the destination field can have a null value. </p>
|
|
1178
1302
|
*/
|
|
1179
1303
|
isNullable?: boolean;
|
|
1180
1304
|
/**
|
|
1305
|
+
* @public
|
|
1181
1306
|
* <p> Specifies if the flow run can either insert new rows in the destination field if they do
|
|
1182
1307
|
* not already exist, or update them if they do. </p>
|
|
1183
1308
|
*/
|
|
1184
1309
|
isUpsertable?: boolean;
|
|
1185
1310
|
/**
|
|
1311
|
+
* @public
|
|
1186
1312
|
* <p> Specifies whether the field can be updated during an <code>UPDATE</code> or
|
|
1187
1313
|
* <code>UPSERT</code> write operation. </p>
|
|
1188
1314
|
*/
|
|
1189
1315
|
isUpdatable?: boolean;
|
|
1190
1316
|
/**
|
|
1317
|
+
* @public
|
|
1191
1318
|
* <p>Specifies whether the field can use the default value during a Create operation.</p>
|
|
1192
1319
|
*/
|
|
1193
1320
|
isDefaultedOnCreate?: boolean;
|
|
1194
1321
|
/**
|
|
1322
|
+
* @public
|
|
1195
1323
|
* <p> A list of supported write operations. For each write operation listed, this field can be
|
|
1196
1324
|
* used in <code>idFieldNames</code> when that write operation is present as a destination
|
|
1197
1325
|
* option. </p>
|
|
@@ -1205,14 +1333,17 @@ export interface DestinationFieldProperties {
|
|
|
1205
1333
|
*/
|
|
1206
1334
|
export interface SourceFieldProperties {
|
|
1207
1335
|
/**
|
|
1336
|
+
* @public
|
|
1208
1337
|
* <p> Indicates whether the field can be returned in a search result. </p>
|
|
1209
1338
|
*/
|
|
1210
1339
|
isRetrievable?: boolean;
|
|
1211
1340
|
/**
|
|
1341
|
+
* @public
|
|
1212
1342
|
* <p> Indicates if the field can be queried. </p>
|
|
1213
1343
|
*/
|
|
1214
1344
|
isQueryable?: boolean;
|
|
1215
1345
|
/**
|
|
1346
|
+
* @public
|
|
1216
1347
|
* <p>Indicates if this timestamp field can be used for incremental queries.</p>
|
|
1217
1348
|
*/
|
|
1218
1349
|
isTimestampFieldForIncrementalQueries?: boolean;
|
|
@@ -1223,10 +1354,12 @@ export interface SourceFieldProperties {
|
|
|
1223
1354
|
*/
|
|
1224
1355
|
export interface Range {
|
|
1225
1356
|
/**
|
|
1357
|
+
* @public
|
|
1226
1358
|
* <p>Maximum value supported by the field.</p>
|
|
1227
1359
|
*/
|
|
1228
1360
|
maximum?: number;
|
|
1229
1361
|
/**
|
|
1362
|
+
* @public
|
|
1230
1363
|
* <p>Minimum value supported by the field.</p>
|
|
1231
1364
|
*/
|
|
1232
1365
|
minimum?: number;
|
|
@@ -1269,31 +1402,38 @@ export type Operator = (typeof Operator)[keyof typeof Operator];
|
|
|
1269
1402
|
*/
|
|
1270
1403
|
export interface FieldTypeDetails {
|
|
1271
1404
|
/**
|
|
1405
|
+
* @public
|
|
1272
1406
|
* <p> The type of field, such as string, integer, date, and so on. </p>
|
|
1273
1407
|
*/
|
|
1274
1408
|
fieldType: string | undefined;
|
|
1275
1409
|
/**
|
|
1410
|
+
* @public
|
|
1276
1411
|
* <p> The list of operators supported by a field. </p>
|
|
1277
1412
|
*/
|
|
1278
1413
|
filterOperators: (Operator | string)[] | undefined;
|
|
1279
1414
|
/**
|
|
1415
|
+
* @public
|
|
1280
1416
|
* <p> The list of values that a field can contain. For example, a Boolean
|
|
1281
1417
|
* <code>fieldType</code> can have two values: "true" and "false". </p>
|
|
1282
1418
|
*/
|
|
1283
1419
|
supportedValues?: string[];
|
|
1284
1420
|
/**
|
|
1421
|
+
* @public
|
|
1285
1422
|
* <p>The regular expression pattern for the field name.</p>
|
|
1286
1423
|
*/
|
|
1287
1424
|
valueRegexPattern?: string;
|
|
1288
1425
|
/**
|
|
1426
|
+
* @public
|
|
1289
1427
|
* <p>The date format that the field supports.</p>
|
|
1290
1428
|
*/
|
|
1291
1429
|
supportedDateFormat?: string;
|
|
1292
1430
|
/**
|
|
1431
|
+
* @public
|
|
1293
1432
|
* <p>The range of values this field can hold.</p>
|
|
1294
1433
|
*/
|
|
1295
1434
|
fieldValueRange?: Range;
|
|
1296
1435
|
/**
|
|
1436
|
+
* @public
|
|
1297
1437
|
* <p>This is the allowable length range for this field's value.</p>
|
|
1298
1438
|
*/
|
|
1299
1439
|
fieldLengthRange?: Range;
|
|
@@ -1305,6 +1445,7 @@ export interface FieldTypeDetails {
|
|
|
1305
1445
|
*/
|
|
1306
1446
|
export interface SupportedFieldTypeDetails {
|
|
1307
1447
|
/**
|
|
1448
|
+
* @public
|
|
1308
1449
|
* <p> The initial supported version for <code>fieldType</code>. If this is later changed to a
|
|
1309
1450
|
* different version, v2 will be introduced. </p>
|
|
1310
1451
|
*/
|
|
@@ -1318,49 +1459,60 @@ export interface SupportedFieldTypeDetails {
|
|
|
1318
1459
|
*/
|
|
1319
1460
|
export interface ConnectorEntityField {
|
|
1320
1461
|
/**
|
|
1462
|
+
* @public
|
|
1321
1463
|
* <p> The unique identifier of the connector field. </p>
|
|
1322
1464
|
*/
|
|
1323
1465
|
identifier: string | undefined;
|
|
1324
1466
|
/**
|
|
1467
|
+
* @public
|
|
1325
1468
|
* <p>The parent identifier of the connector field.</p>
|
|
1326
1469
|
*/
|
|
1327
1470
|
parentIdentifier?: string;
|
|
1328
1471
|
/**
|
|
1472
|
+
* @public
|
|
1329
1473
|
* <p> The label applied to a connector entity field. </p>
|
|
1330
1474
|
*/
|
|
1331
1475
|
label?: string;
|
|
1332
1476
|
/**
|
|
1477
|
+
* @public
|
|
1333
1478
|
* <p>Booelan value that indicates whether this field can be used as a primary key.</p>
|
|
1334
1479
|
*/
|
|
1335
1480
|
isPrimaryKey?: boolean;
|
|
1336
1481
|
/**
|
|
1482
|
+
* @public
|
|
1337
1483
|
* <p>Default value that can be assigned to this field.</p>
|
|
1338
1484
|
*/
|
|
1339
1485
|
defaultValue?: string;
|
|
1340
1486
|
/**
|
|
1487
|
+
* @public
|
|
1341
1488
|
* <p>Booelan value that indicates whether this field is deprecated or not.</p>
|
|
1342
1489
|
*/
|
|
1343
1490
|
isDeprecated?: boolean;
|
|
1344
1491
|
/**
|
|
1492
|
+
* @public
|
|
1345
1493
|
* <p> Contains details regarding the supported <code>FieldType</code>, including the
|
|
1346
1494
|
* corresponding <code>filterOperators</code> and <code>supportedValues</code>. </p>
|
|
1347
1495
|
*/
|
|
1348
1496
|
supportedFieldTypeDetails?: SupportedFieldTypeDetails;
|
|
1349
1497
|
/**
|
|
1498
|
+
* @public
|
|
1350
1499
|
* <p> A description of the connector entity field. </p>
|
|
1351
1500
|
*/
|
|
1352
1501
|
description?: string;
|
|
1353
1502
|
/**
|
|
1503
|
+
* @public
|
|
1354
1504
|
* <p> The properties that can be applied to a field when the connector is being used as a
|
|
1355
1505
|
* source. </p>
|
|
1356
1506
|
*/
|
|
1357
1507
|
sourceProperties?: SourceFieldProperties;
|
|
1358
1508
|
/**
|
|
1509
|
+
* @public
|
|
1359
1510
|
* <p> The properties applied to a field when the connector is being used as a destination.
|
|
1360
1511
|
* </p>
|
|
1361
1512
|
*/
|
|
1362
1513
|
destinationProperties?: DestinationFieldProperties;
|
|
1363
1514
|
/**
|
|
1515
|
+
* @public
|
|
1364
1516
|
* <p>A map that has specific properties related to the ConnectorEntityField.</p>
|
|
1365
1517
|
*/
|
|
1366
1518
|
customProperties?: Record<string, string>;
|
|
@@ -1372,11 +1524,13 @@ export interface ConnectorEntityField {
|
|
|
1372
1524
|
*/
|
|
1373
1525
|
export interface ConnectorOAuthRequest {
|
|
1374
1526
|
/**
|
|
1527
|
+
* @public
|
|
1375
1528
|
* <p> The code provided by the connector when it has been authenticated via the connected app.
|
|
1376
1529
|
* </p>
|
|
1377
1530
|
*/
|
|
1378
1531
|
authCode?: string;
|
|
1379
1532
|
/**
|
|
1533
|
+
* @public
|
|
1380
1534
|
* <p> The URL to which the authentication server redirects the browser after authorization has
|
|
1381
1535
|
* been granted. </p>
|
|
1382
1536
|
*/
|
|
@@ -1780,70 +1934,87 @@ export type ZendeskConnectorOperator = (typeof ZendeskConnectorOperator)[keyof t
|
|
|
1780
1934
|
*/
|
|
1781
1935
|
export interface ConnectorOperator {
|
|
1782
1936
|
/**
|
|
1937
|
+
* @public
|
|
1783
1938
|
* <p> The operation to be performed on the provided Amplitude source fields. </p>
|
|
1784
1939
|
*/
|
|
1785
1940
|
Amplitude?: AmplitudeConnectorOperator | string;
|
|
1786
1941
|
/**
|
|
1942
|
+
* @public
|
|
1787
1943
|
* <p> The operation to be performed on the provided Datadog source fields. </p>
|
|
1788
1944
|
*/
|
|
1789
1945
|
Datadog?: DatadogConnectorOperator | string;
|
|
1790
1946
|
/**
|
|
1947
|
+
* @public
|
|
1791
1948
|
* <p> The operation to be performed on the provided Dynatrace source fields. </p>
|
|
1792
1949
|
*/
|
|
1793
1950
|
Dynatrace?: DynatraceConnectorOperator | string;
|
|
1794
1951
|
/**
|
|
1952
|
+
* @public
|
|
1795
1953
|
* <p> The operation to be performed on the provided Google Analytics source fields. </p>
|
|
1796
1954
|
*/
|
|
1797
1955
|
GoogleAnalytics?: GoogleAnalyticsConnectorOperator | string;
|
|
1798
1956
|
/**
|
|
1957
|
+
* @public
|
|
1799
1958
|
* <p> The operation to be performed on the provided Infor Nexus source fields. </p>
|
|
1800
1959
|
*/
|
|
1801
1960
|
InforNexus?: InforNexusConnectorOperator | string;
|
|
1802
1961
|
/**
|
|
1962
|
+
* @public
|
|
1803
1963
|
* <p> The operation to be performed on the provided Marketo source fields. </p>
|
|
1804
1964
|
*/
|
|
1805
1965
|
Marketo?: MarketoConnectorOperator | string;
|
|
1806
1966
|
/**
|
|
1967
|
+
* @public
|
|
1807
1968
|
* <p> The operation to be performed on the provided Amazon S3 source fields. </p>
|
|
1808
1969
|
*/
|
|
1809
1970
|
S3?: S3ConnectorOperator | string;
|
|
1810
1971
|
/**
|
|
1972
|
+
* @public
|
|
1811
1973
|
* <p> The operation to be performed on the provided Salesforce source fields. </p>
|
|
1812
1974
|
*/
|
|
1813
1975
|
Salesforce?: SalesforceConnectorOperator | string;
|
|
1814
1976
|
/**
|
|
1977
|
+
* @public
|
|
1815
1978
|
* <p> The operation to be performed on the provided ServiceNow source fields. </p>
|
|
1816
1979
|
*/
|
|
1817
1980
|
ServiceNow?: ServiceNowConnectorOperator | string;
|
|
1818
1981
|
/**
|
|
1982
|
+
* @public
|
|
1819
1983
|
* <p> The operation to be performed on the provided Singular source fields. </p>
|
|
1820
1984
|
*/
|
|
1821
1985
|
Singular?: SingularConnectorOperator | string;
|
|
1822
1986
|
/**
|
|
1987
|
+
* @public
|
|
1823
1988
|
* <p> The operation to be performed on the provided Slack source fields. </p>
|
|
1824
1989
|
*/
|
|
1825
1990
|
Slack?: SlackConnectorOperator | string;
|
|
1826
1991
|
/**
|
|
1992
|
+
* @public
|
|
1827
1993
|
* <p> The operation to be performed on the provided Trend Micro source fields. </p>
|
|
1828
1994
|
*/
|
|
1829
1995
|
Trendmicro?: TrendmicroConnectorOperator | string;
|
|
1830
1996
|
/**
|
|
1997
|
+
* @public
|
|
1831
1998
|
* <p> The operation to be performed on the provided Veeva source fields. </p>
|
|
1832
1999
|
*/
|
|
1833
2000
|
Veeva?: VeevaConnectorOperator | string;
|
|
1834
2001
|
/**
|
|
2002
|
+
* @public
|
|
1835
2003
|
* <p> The operation to be performed on the provided Zendesk source fields. </p>
|
|
1836
2004
|
*/
|
|
1837
2005
|
Zendesk?: ZendeskConnectorOperator | string;
|
|
1838
2006
|
/**
|
|
2007
|
+
* @public
|
|
1839
2008
|
* <p> The operation to be performed on the provided SAPOData source fields. </p>
|
|
1840
2009
|
*/
|
|
1841
2010
|
SAPOData?: SAPODataConnectorOperator | string;
|
|
1842
2011
|
/**
|
|
2012
|
+
* @public
|
|
1843
2013
|
* <p>Operators supported by the custom connector.</p>
|
|
1844
2014
|
*/
|
|
1845
2015
|
CustomConnector?: Operator | string;
|
|
1846
2016
|
/**
|
|
2017
|
+
* @public
|
|
1847
2018
|
* <p>The operation to be performed on the provided Salesforce Pardot source fields.</p>
|
|
1848
2019
|
*/
|
|
1849
2020
|
Pardot?: PardotConnectorOperator | string;
|
|
@@ -1854,14 +2025,17 @@ export interface ConnectorOperator {
|
|
|
1854
2025
|
*/
|
|
1855
2026
|
export interface OAuth2Properties {
|
|
1856
2027
|
/**
|
|
2028
|
+
* @public
|
|
1857
2029
|
* <p>The token URL required for OAuth 2.0 authentication.</p>
|
|
1858
2030
|
*/
|
|
1859
2031
|
tokenUrl: string | undefined;
|
|
1860
2032
|
/**
|
|
2033
|
+
* @public
|
|
1861
2034
|
* <p>The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.</p>
|
|
1862
2035
|
*/
|
|
1863
2036
|
oAuth2GrantType: OAuth2GrantType | string | undefined;
|
|
1864
2037
|
/**
|
|
2038
|
+
* @public
|
|
1865
2039
|
* <p>Associates your token URL with a map of properties that you define. Use this parameter to
|
|
1866
2040
|
* provide any additional details that the connector requires to authenticate your
|
|
1867
2041
|
* request.</p>
|
|
@@ -1874,10 +2048,12 @@ export interface OAuth2Properties {
|
|
|
1874
2048
|
*/
|
|
1875
2049
|
export interface CustomConnectorProfileProperties {
|
|
1876
2050
|
/**
|
|
2051
|
+
* @public
|
|
1877
2052
|
* <p>A map of properties that are required to create a profile for the custom connector.</p>
|
|
1878
2053
|
*/
|
|
1879
2054
|
profileProperties?: Record<string, string>;
|
|
1880
2055
|
/**
|
|
2056
|
+
* @public
|
|
1881
2057
|
* <p>The OAuth 2.0 properties required for OAuth 2.0 authentication.</p>
|
|
1882
2058
|
*/
|
|
1883
2059
|
oAuth2Properties?: OAuth2Properties;
|
|
@@ -1888,6 +2064,7 @@ export interface CustomConnectorProfileProperties {
|
|
|
1888
2064
|
*/
|
|
1889
2065
|
export interface DatadogConnectorProfileProperties {
|
|
1890
2066
|
/**
|
|
2067
|
+
* @public
|
|
1891
2068
|
* <p> The location of the Datadog resource. </p>
|
|
1892
2069
|
*/
|
|
1893
2070
|
instanceUrl: string | undefined;
|
|
@@ -1898,6 +2075,7 @@ export interface DatadogConnectorProfileProperties {
|
|
|
1898
2075
|
*/
|
|
1899
2076
|
export interface DynatraceConnectorProfileProperties {
|
|
1900
2077
|
/**
|
|
2078
|
+
* @public
|
|
1901
2079
|
* <p> The location of the Dynatrace resource. </p>
|
|
1902
2080
|
*/
|
|
1903
2081
|
instanceUrl: string | undefined;
|
|
@@ -1920,6 +2098,7 @@ export interface HoneycodeConnectorProfileProperties {
|
|
|
1920
2098
|
*/
|
|
1921
2099
|
export interface InforNexusConnectorProfileProperties {
|
|
1922
2100
|
/**
|
|
2101
|
+
* @public
|
|
1923
2102
|
* <p> The location of the Infor Nexus resource. </p>
|
|
1924
2103
|
*/
|
|
1925
2104
|
instanceUrl: string | undefined;
|
|
@@ -1930,6 +2109,7 @@ export interface InforNexusConnectorProfileProperties {
|
|
|
1930
2109
|
*/
|
|
1931
2110
|
export interface MarketoConnectorProfileProperties {
|
|
1932
2111
|
/**
|
|
2112
|
+
* @public
|
|
1933
2113
|
* <p> The location of the Marketo resource. </p>
|
|
1934
2114
|
*/
|
|
1935
2115
|
instanceUrl: string | undefined;
|
|
@@ -1940,15 +2120,18 @@ export interface MarketoConnectorProfileProperties {
|
|
|
1940
2120
|
*/
|
|
1941
2121
|
export interface PardotConnectorProfileProperties {
|
|
1942
2122
|
/**
|
|
2123
|
+
* @public
|
|
1943
2124
|
* <p>The location of the Salesforce Pardot resource.</p>
|
|
1944
2125
|
*/
|
|
1945
2126
|
instanceUrl?: string;
|
|
1946
2127
|
/**
|
|
2128
|
+
* @public
|
|
1947
2129
|
* <p>Indicates whether the connector profile applies to a sandbox or production
|
|
1948
2130
|
* environment.</p>
|
|
1949
2131
|
*/
|
|
1950
2132
|
isSandboxEnvironment?: boolean;
|
|
1951
2133
|
/**
|
|
2134
|
+
* @public
|
|
1952
2135
|
* <p>The business unit id of Salesforce Pardot instance.</p>
|
|
1953
2136
|
*/
|
|
1954
2137
|
businessUnitId?: string;
|
|
@@ -1959,44 +2142,53 @@ export interface PardotConnectorProfileProperties {
|
|
|
1959
2142
|
*/
|
|
1960
2143
|
export interface RedshiftConnectorProfileProperties {
|
|
1961
2144
|
/**
|
|
2145
|
+
* @public
|
|
1962
2146
|
* <p> The JDBC URL of the Amazon Redshift cluster. </p>
|
|
1963
2147
|
*/
|
|
1964
2148
|
databaseUrl?: string;
|
|
1965
2149
|
/**
|
|
2150
|
+
* @public
|
|
1966
2151
|
* <p> A name for the associated Amazon S3 bucket. </p>
|
|
1967
2152
|
*/
|
|
1968
2153
|
bucketName: string | undefined;
|
|
1969
2154
|
/**
|
|
2155
|
+
* @public
|
|
1970
2156
|
* <p> The object key for the destination bucket in which Amazon AppFlow places the files.
|
|
1971
2157
|
* </p>
|
|
1972
2158
|
*/
|
|
1973
2159
|
bucketPrefix?: string;
|
|
1974
2160
|
/**
|
|
2161
|
+
* @public
|
|
1975
2162
|
* <p> The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift
|
|
1976
2163
|
* read-only access to Amazon S3. For more information, and for the polices that you
|
|
1977
2164
|
* attach to this role, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#redshift-access-s3">Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3</a>.</p>
|
|
1978
2165
|
*/
|
|
1979
2166
|
roleArn: string | undefined;
|
|
1980
2167
|
/**
|
|
2168
|
+
* @public
|
|
1981
2169
|
* <p>The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more
|
|
1982
2170
|
* information, and for the polices that you attach to this role, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_service-role-policies.html#access-redshift">Allow Amazon AppFlow to access Amazon Redshift databases with the Data
|
|
1983
2171
|
* API</a>.</p>
|
|
1984
2172
|
*/
|
|
1985
2173
|
dataApiRoleArn?: string;
|
|
1986
2174
|
/**
|
|
2175
|
+
* @public
|
|
1987
2176
|
* <p>Indicates whether the connector profile defines a connection to an Amazon Redshift
|
|
1988
2177
|
* Serverless data warehouse.</p>
|
|
1989
2178
|
*/
|
|
1990
2179
|
isRedshiftServerless?: boolean;
|
|
1991
2180
|
/**
|
|
2181
|
+
* @public
|
|
1992
2182
|
* <p>The unique ID that's assigned to an Amazon Redshift cluster.</p>
|
|
1993
2183
|
*/
|
|
1994
2184
|
clusterIdentifier?: string;
|
|
1995
2185
|
/**
|
|
2186
|
+
* @public
|
|
1996
2187
|
* <p>The name of an Amazon Redshift workgroup.</p>
|
|
1997
2188
|
*/
|
|
1998
2189
|
workgroupName?: string;
|
|
1999
2190
|
/**
|
|
2191
|
+
* @public
|
|
2000
2192
|
* <p>The name of an Amazon Redshift database.</p>
|
|
2001
2193
|
*/
|
|
2002
2194
|
databaseName?: string;
|
|
@@ -2007,15 +2199,18 @@ export interface RedshiftConnectorProfileProperties {
|
|
|
2007
2199
|
*/
|
|
2008
2200
|
export interface SalesforceConnectorProfileProperties {
|
|
2009
2201
|
/**
|
|
2202
|
+
* @public
|
|
2010
2203
|
* <p> The location of the Salesforce resource. </p>
|
|
2011
2204
|
*/
|
|
2012
2205
|
instanceUrl?: string;
|
|
2013
2206
|
/**
|
|
2207
|
+
* @public
|
|
2014
2208
|
* <p> Indicates whether the connector profile applies to a sandbox or production environment.
|
|
2015
2209
|
* </p>
|
|
2016
2210
|
*/
|
|
2017
2211
|
isSandboxEnvironment?: boolean;
|
|
2018
2212
|
/**
|
|
2213
|
+
* @public
|
|
2019
2214
|
* <p>If the connection mode for the connector profile is private, this parameter sets whether
|
|
2020
2215
|
* Amazon AppFlow uses the private network to send metadata and authorization calls to
|
|
2021
2216
|
* Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These
|
|
@@ -2071,16 +2266,19 @@ export interface SalesforceConnectorProfileProperties {
|
|
|
2071
2266
|
*/
|
|
2072
2267
|
export interface OAuthProperties {
|
|
2073
2268
|
/**
|
|
2269
|
+
* @public
|
|
2074
2270
|
* <p> The token url required to fetch access/refresh tokens using authorization code and also
|
|
2075
2271
|
* to refresh expired access token using refresh token.</p>
|
|
2076
2272
|
*/
|
|
2077
2273
|
tokenUrl: string | undefined;
|
|
2078
2274
|
/**
|
|
2275
|
+
* @public
|
|
2079
2276
|
* <p> The authorization code url required to redirect to SAP Login Page to fetch authorization
|
|
2080
2277
|
* code for OAuth type authentication. </p>
|
|
2081
2278
|
*/
|
|
2082
2279
|
authCodeUrl: string | undefined;
|
|
2083
2280
|
/**
|
|
2281
|
+
* @public
|
|
2084
2282
|
* <p> The OAuth scopes required for OAuth type authentication. </p>
|
|
2085
2283
|
*/
|
|
2086
2284
|
oAuthScopes: string[] | undefined;
|
|
@@ -2091,34 +2289,42 @@ export interface OAuthProperties {
|
|
|
2091
2289
|
*/
|
|
2092
2290
|
export interface SAPODataConnectorProfileProperties {
|
|
2093
2291
|
/**
|
|
2292
|
+
* @public
|
|
2094
2293
|
* <p> The location of the SAPOData resource. </p>
|
|
2095
2294
|
*/
|
|
2096
2295
|
applicationHostUrl: string | undefined;
|
|
2097
2296
|
/**
|
|
2297
|
+
* @public
|
|
2098
2298
|
* <p> The application path to catalog service. </p>
|
|
2099
2299
|
*/
|
|
2100
2300
|
applicationServicePath: string | undefined;
|
|
2101
2301
|
/**
|
|
2302
|
+
* @public
|
|
2102
2303
|
* <p> The port number of the SAPOData instance. </p>
|
|
2103
2304
|
*/
|
|
2104
2305
|
portNumber: number | undefined;
|
|
2105
2306
|
/**
|
|
2307
|
+
* @public
|
|
2106
2308
|
* <p> The client number for the client creating the connection. </p>
|
|
2107
2309
|
*/
|
|
2108
2310
|
clientNumber: string | undefined;
|
|
2109
2311
|
/**
|
|
2312
|
+
* @public
|
|
2110
2313
|
* <p> The logon language of SAPOData instance. </p>
|
|
2111
2314
|
*/
|
|
2112
2315
|
logonLanguage?: string;
|
|
2113
2316
|
/**
|
|
2317
|
+
* @public
|
|
2114
2318
|
* <p> The SAPOData Private Link service name to be used for private data transfers. </p>
|
|
2115
2319
|
*/
|
|
2116
2320
|
privateLinkServiceName?: string;
|
|
2117
2321
|
/**
|
|
2322
|
+
* @public
|
|
2118
2323
|
* <p> The SAPOData OAuth properties required for OAuth type authentication. </p>
|
|
2119
2324
|
*/
|
|
2120
2325
|
oAuthProperties?: OAuthProperties;
|
|
2121
2326
|
/**
|
|
2327
|
+
* @public
|
|
2122
2328
|
* <p>If you set this parameter to <code>true</code>, Amazon AppFlow bypasses the single
|
|
2123
2329
|
* sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.</p>
|
|
2124
2330
|
* <p>Whether you need this option depends on the types of credentials that you applied to
|
|
@@ -2136,6 +2342,7 @@ export interface SAPODataConnectorProfileProperties {
|
|
|
2136
2342
|
*/
|
|
2137
2343
|
export interface ServiceNowConnectorProfileProperties {
|
|
2138
2344
|
/**
|
|
2345
|
+
* @public
|
|
2139
2346
|
* <p> The location of the ServiceNow resource. </p>
|
|
2140
2347
|
*/
|
|
2141
2348
|
instanceUrl: string | undefined;
|
|
@@ -2152,6 +2359,7 @@ export interface SingularConnectorProfileProperties {
|
|
|
2152
2359
|
*/
|
|
2153
2360
|
export interface SlackConnectorProfileProperties {
|
|
2154
2361
|
/**
|
|
2362
|
+
* @public
|
|
2155
2363
|
* <p> The location of the Slack resource. </p>
|
|
2156
2364
|
*/
|
|
2157
2365
|
instanceUrl: string | undefined;
|
|
@@ -2162,32 +2370,39 @@ export interface SlackConnectorProfileProperties {
|
|
|
2162
2370
|
*/
|
|
2163
2371
|
export interface SnowflakeConnectorProfileProperties {
|
|
2164
2372
|
/**
|
|
2373
|
+
* @public
|
|
2165
2374
|
* <p> The name of the Snowflake warehouse. </p>
|
|
2166
2375
|
*/
|
|
2167
2376
|
warehouse: string | undefined;
|
|
2168
2377
|
/**
|
|
2378
|
+
* @public
|
|
2169
2379
|
* <p> The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: <
|
|
2170
2380
|
* Database>< Schema><Stage Name>. </p>
|
|
2171
2381
|
*/
|
|
2172
2382
|
stage: string | undefined;
|
|
2173
2383
|
/**
|
|
2384
|
+
* @public
|
|
2174
2385
|
* <p> The name of the Amazon S3 bucket associated with Snowflake. </p>
|
|
2175
2386
|
*/
|
|
2176
2387
|
bucketName: string | undefined;
|
|
2177
2388
|
/**
|
|
2389
|
+
* @public
|
|
2178
2390
|
* <p> The bucket path that refers to the Amazon S3 bucket associated with Snowflake.
|
|
2179
2391
|
* </p>
|
|
2180
2392
|
*/
|
|
2181
2393
|
bucketPrefix?: string;
|
|
2182
2394
|
/**
|
|
2395
|
+
* @public
|
|
2183
2396
|
* <p> The Snowflake Private Link service name to be used for private data transfers. </p>
|
|
2184
2397
|
*/
|
|
2185
2398
|
privateLinkServiceName?: string;
|
|
2186
2399
|
/**
|
|
2400
|
+
* @public
|
|
2187
2401
|
* <p> The name of the account. </p>
|
|
2188
2402
|
*/
|
|
2189
2403
|
accountName?: string;
|
|
2190
2404
|
/**
|
|
2405
|
+
* @public
|
|
2191
2406
|
* <p> The Amazon Web Services Region of the Snowflake account. </p>
|
|
2192
2407
|
*/
|
|
2193
2408
|
region?: string;
|
|
@@ -2204,6 +2419,7 @@ export interface TrendmicroConnectorProfileProperties {
|
|
|
2204
2419
|
*/
|
|
2205
2420
|
export interface VeevaConnectorProfileProperties {
|
|
2206
2421
|
/**
|
|
2422
|
+
* @public
|
|
2207
2423
|
* <p> The location of the Veeva resource. </p>
|
|
2208
2424
|
*/
|
|
2209
2425
|
instanceUrl: string | undefined;
|
|
@@ -2214,6 +2430,7 @@ export interface VeevaConnectorProfileProperties {
|
|
|
2214
2430
|
*/
|
|
2215
2431
|
export interface ZendeskConnectorProfileProperties {
|
|
2216
2432
|
/**
|
|
2433
|
+
* @public
|
|
2217
2434
|
* <p> The location of the Zendesk resource. </p>
|
|
2218
2435
|
*/
|
|
2219
2436
|
instanceUrl: string | undefined;
|
|
@@ -2224,78 +2441,97 @@ export interface ZendeskConnectorProfileProperties {
|
|
|
2224
2441
|
*/
|
|
2225
2442
|
export interface ConnectorProfileProperties {
|
|
2226
2443
|
/**
|
|
2444
|
+
* @public
|
|
2227
2445
|
* <p> The connector-specific properties required by Amplitude. </p>
|
|
2228
2446
|
*/
|
|
2229
2447
|
Amplitude?: AmplitudeConnectorProfileProperties;
|
|
2230
2448
|
/**
|
|
2449
|
+
* @public
|
|
2231
2450
|
* <p> The connector-specific properties required by Datadog. </p>
|
|
2232
2451
|
*/
|
|
2233
2452
|
Datadog?: DatadogConnectorProfileProperties;
|
|
2234
2453
|
/**
|
|
2454
|
+
* @public
|
|
2235
2455
|
* <p> The connector-specific properties required by Dynatrace. </p>
|
|
2236
2456
|
*/
|
|
2237
2457
|
Dynatrace?: DynatraceConnectorProfileProperties;
|
|
2238
2458
|
/**
|
|
2459
|
+
* @public
|
|
2239
2460
|
* <p> The connector-specific properties required Google Analytics. </p>
|
|
2240
2461
|
*/
|
|
2241
2462
|
GoogleAnalytics?: GoogleAnalyticsConnectorProfileProperties;
|
|
2242
2463
|
/**
|
|
2464
|
+
* @public
|
|
2243
2465
|
* <p> The connector-specific properties required by Amazon Honeycode. </p>
|
|
2244
2466
|
*/
|
|
2245
2467
|
Honeycode?: HoneycodeConnectorProfileProperties;
|
|
2246
2468
|
/**
|
|
2469
|
+
* @public
|
|
2247
2470
|
* <p> The connector-specific properties required by Infor Nexus. </p>
|
|
2248
2471
|
*/
|
|
2249
2472
|
InforNexus?: InforNexusConnectorProfileProperties;
|
|
2250
2473
|
/**
|
|
2474
|
+
* @public
|
|
2251
2475
|
* <p> The connector-specific properties required by Marketo. </p>
|
|
2252
2476
|
*/
|
|
2253
2477
|
Marketo?: MarketoConnectorProfileProperties;
|
|
2254
2478
|
/**
|
|
2479
|
+
* @public
|
|
2255
2480
|
* <p> The connector-specific properties required by Amazon Redshift. </p>
|
|
2256
2481
|
*/
|
|
2257
2482
|
Redshift?: RedshiftConnectorProfileProperties;
|
|
2258
2483
|
/**
|
|
2484
|
+
* @public
|
|
2259
2485
|
* <p> The connector-specific properties required by Salesforce. </p>
|
|
2260
2486
|
*/
|
|
2261
2487
|
Salesforce?: SalesforceConnectorProfileProperties;
|
|
2262
2488
|
/**
|
|
2489
|
+
* @public
|
|
2263
2490
|
* <p> The connector-specific properties required by serviceNow. </p>
|
|
2264
2491
|
*/
|
|
2265
2492
|
ServiceNow?: ServiceNowConnectorProfileProperties;
|
|
2266
2493
|
/**
|
|
2494
|
+
* @public
|
|
2267
2495
|
* <p> The connector-specific properties required by Singular. </p>
|
|
2268
2496
|
*/
|
|
2269
2497
|
Singular?: SingularConnectorProfileProperties;
|
|
2270
2498
|
/**
|
|
2499
|
+
* @public
|
|
2271
2500
|
* <p> The connector-specific properties required by Slack. </p>
|
|
2272
2501
|
*/
|
|
2273
2502
|
Slack?: SlackConnectorProfileProperties;
|
|
2274
2503
|
/**
|
|
2504
|
+
* @public
|
|
2275
2505
|
* <p> The connector-specific properties required by Snowflake. </p>
|
|
2276
2506
|
*/
|
|
2277
2507
|
Snowflake?: SnowflakeConnectorProfileProperties;
|
|
2278
2508
|
/**
|
|
2509
|
+
* @public
|
|
2279
2510
|
* <p> The connector-specific properties required by Trend Micro. </p>
|
|
2280
2511
|
*/
|
|
2281
2512
|
Trendmicro?: TrendmicroConnectorProfileProperties;
|
|
2282
2513
|
/**
|
|
2514
|
+
* @public
|
|
2283
2515
|
* <p> The connector-specific properties required by Veeva. </p>
|
|
2284
2516
|
*/
|
|
2285
2517
|
Veeva?: VeevaConnectorProfileProperties;
|
|
2286
2518
|
/**
|
|
2519
|
+
* @public
|
|
2287
2520
|
* <p> The connector-specific properties required by Zendesk. </p>
|
|
2288
2521
|
*/
|
|
2289
2522
|
Zendesk?: ZendeskConnectorProfileProperties;
|
|
2290
2523
|
/**
|
|
2524
|
+
* @public
|
|
2291
2525
|
* <p> The connector-specific profile properties required when using SAPOData. </p>
|
|
2292
2526
|
*/
|
|
2293
2527
|
SAPOData?: SAPODataConnectorProfileProperties;
|
|
2294
2528
|
/**
|
|
2529
|
+
* @public
|
|
2295
2530
|
* <p>The properties required by the custom connector.</p>
|
|
2296
2531
|
*/
|
|
2297
2532
|
CustomConnector?: CustomConnectorProfileProperties;
|
|
2298
2533
|
/**
|
|
2534
|
+
* @public
|
|
2299
2535
|
* <p>The connector-specific properties required by Salesforce Pardot.</p>
|
|
2300
2536
|
*/
|
|
2301
2537
|
Pardot?: PardotConnectorProfileProperties;
|
|
@@ -2334,14 +2570,17 @@ export type PrivateConnectionProvisioningStatus = (typeof PrivateConnectionProvi
|
|
|
2334
2570
|
*/
|
|
2335
2571
|
export interface PrivateConnectionProvisioningState {
|
|
2336
2572
|
/**
|
|
2573
|
+
* @public
|
|
2337
2574
|
* <p> Specifies the private connection provisioning status. </p>
|
|
2338
2575
|
*/
|
|
2339
2576
|
status?: PrivateConnectionProvisioningStatus | string;
|
|
2340
2577
|
/**
|
|
2578
|
+
* @public
|
|
2341
2579
|
* <p> Specifies the private connection provisioning failure reason. </p>
|
|
2342
2580
|
*/
|
|
2343
2581
|
failureMessage?: string;
|
|
2344
2582
|
/**
|
|
2583
|
+
* @public
|
|
2345
2584
|
* <p> Specifies the private connection provisioning failure cause. </p>
|
|
2346
2585
|
*/
|
|
2347
2586
|
failureCause?: PrivateConnectionProvisioningFailureCause | string;
|
|
@@ -2356,43 +2595,53 @@ export interface PrivateConnectionProvisioningState {
|
|
|
2356
2595
|
*/
|
|
2357
2596
|
export interface ConnectorProfile {
|
|
2358
2597
|
/**
|
|
2598
|
+
* @public
|
|
2359
2599
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
2360
2600
|
*/
|
|
2361
2601
|
connectorProfileArn?: string;
|
|
2362
2602
|
/**
|
|
2603
|
+
* @public
|
|
2363
2604
|
* <p> The name of the connector profile. The name is unique for each
|
|
2364
2605
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
2365
2606
|
*/
|
|
2366
2607
|
connectorProfileName?: string;
|
|
2367
2608
|
/**
|
|
2609
|
+
* @public
|
|
2368
2610
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
2369
2611
|
*/
|
|
2370
2612
|
connectorType?: ConnectorType | string;
|
|
2371
2613
|
/**
|
|
2614
|
+
* @public
|
|
2372
2615
|
* <p>The label for the connector profile being created.</p>
|
|
2373
2616
|
*/
|
|
2374
2617
|
connectorLabel?: string;
|
|
2375
2618
|
/**
|
|
2619
|
+
* @public
|
|
2376
2620
|
* <p> Indicates the connection mode and if it is public or private. </p>
|
|
2377
2621
|
*/
|
|
2378
2622
|
connectionMode?: ConnectionMode | string;
|
|
2379
2623
|
/**
|
|
2624
|
+
* @public
|
|
2380
2625
|
* <p> The Amazon Resource Name (ARN) of the connector profile credentials. </p>
|
|
2381
2626
|
*/
|
|
2382
2627
|
credentialsArn?: string;
|
|
2383
2628
|
/**
|
|
2629
|
+
* @public
|
|
2384
2630
|
* <p> The connector-specific properties of the profile configuration. </p>
|
|
2385
2631
|
*/
|
|
2386
2632
|
connectorProfileProperties?: ConnectorProfileProperties;
|
|
2387
2633
|
/**
|
|
2634
|
+
* @public
|
|
2388
2635
|
* <p> Specifies when the connector profile was created. </p>
|
|
2389
2636
|
*/
|
|
2390
2637
|
createdAt?: Date;
|
|
2391
2638
|
/**
|
|
2639
|
+
* @public
|
|
2392
2640
|
* <p> Specifies when the connector profile was last updated. </p>
|
|
2393
2641
|
*/
|
|
2394
2642
|
lastUpdatedAt?: Date;
|
|
2395
2643
|
/**
|
|
2644
|
+
* @public
|
|
2396
2645
|
* <p> Specifies the private connection provisioning state. </p>
|
|
2397
2646
|
*/
|
|
2398
2647
|
privateConnectionProvisioningState?: PrivateConnectionProvisioningState;
|
|
@@ -2403,10 +2652,12 @@ export interface ConnectorProfile {
|
|
|
2403
2652
|
*/
|
|
2404
2653
|
export interface CustomAuthCredentials {
|
|
2405
2654
|
/**
|
|
2655
|
+
* @public
|
|
2406
2656
|
* <p>The custom authentication type that the connector uses.</p>
|
|
2407
2657
|
*/
|
|
2408
2658
|
customAuthenticationType: string | undefined;
|
|
2409
2659
|
/**
|
|
2660
|
+
* @public
|
|
2410
2661
|
* <p>A map that holds custom authentication credentials.</p>
|
|
2411
2662
|
*/
|
|
2412
2663
|
credentialsMap?: Record<string, string>;
|
|
@@ -2417,23 +2668,28 @@ export interface CustomAuthCredentials {
|
|
|
2417
2668
|
*/
|
|
2418
2669
|
export interface OAuth2Credentials {
|
|
2419
2670
|
/**
|
|
2671
|
+
* @public
|
|
2420
2672
|
* <p>The identifier for the desired client.</p>
|
|
2421
2673
|
*/
|
|
2422
2674
|
clientId?: string;
|
|
2423
2675
|
/**
|
|
2676
|
+
* @public
|
|
2424
2677
|
* <p>The client secret used by the OAuth client to authenticate to the authorization
|
|
2425
2678
|
* server.</p>
|
|
2426
2679
|
*/
|
|
2427
2680
|
clientSecret?: string;
|
|
2428
2681
|
/**
|
|
2682
|
+
* @public
|
|
2429
2683
|
* <p>The access token used to access the connector on your behalf.</p>
|
|
2430
2684
|
*/
|
|
2431
2685
|
accessToken?: string;
|
|
2432
2686
|
/**
|
|
2687
|
+
* @public
|
|
2433
2688
|
* <p>The refresh token used to refresh an expired access token.</p>
|
|
2434
2689
|
*/
|
|
2435
2690
|
refreshToken?: string;
|
|
2436
2691
|
/**
|
|
2692
|
+
* @public
|
|
2437
2693
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2438
2694
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2439
2695
|
*/
|
|
@@ -2446,23 +2702,28 @@ export interface OAuth2Credentials {
|
|
|
2446
2702
|
*/
|
|
2447
2703
|
export interface CustomConnectorProfileCredentials {
|
|
2448
2704
|
/**
|
|
2705
|
+
* @public
|
|
2449
2706
|
* <p>The authentication type that the custom connector uses for authenticating while creating a
|
|
2450
2707
|
* connector profile.</p>
|
|
2451
2708
|
*/
|
|
2452
2709
|
authenticationType: AuthenticationType | string | undefined;
|
|
2453
2710
|
/**
|
|
2711
|
+
* @public
|
|
2454
2712
|
* <p>The basic credentials that are required for the authentication of the user.</p>
|
|
2455
2713
|
*/
|
|
2456
2714
|
basic?: BasicAuthCredentials;
|
|
2457
2715
|
/**
|
|
2716
|
+
* @public
|
|
2458
2717
|
* <p>The OAuth 2.0 credentials required for the authentication of the user.</p>
|
|
2459
2718
|
*/
|
|
2460
2719
|
oauth2?: OAuth2Credentials;
|
|
2461
2720
|
/**
|
|
2721
|
+
* @public
|
|
2462
2722
|
* <p>The API keys required for the authentication of the user.</p>
|
|
2463
2723
|
*/
|
|
2464
2724
|
apiKey?: ApiKeyCredentials;
|
|
2465
2725
|
/**
|
|
2726
|
+
* @public
|
|
2466
2727
|
* <p>If the connector uses the custom authentication mechanism, this holds the required
|
|
2467
2728
|
* credentials.</p>
|
|
2468
2729
|
*/
|
|
@@ -2474,11 +2735,13 @@ export interface CustomConnectorProfileCredentials {
|
|
|
2474
2735
|
*/
|
|
2475
2736
|
export interface DatadogConnectorProfileCredentials {
|
|
2476
2737
|
/**
|
|
2738
|
+
* @public
|
|
2477
2739
|
* <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
|
|
2478
2740
|
* program to your API. </p>
|
|
2479
2741
|
*/
|
|
2480
2742
|
apiKey: string | undefined;
|
|
2481
2743
|
/**
|
|
2744
|
+
* @public
|
|
2482
2745
|
* <p> Application keys, in conjunction with your API key, give you full access to Datadog’s
|
|
2483
2746
|
* programmatic API. Application keys are associated with the user account that created them. The
|
|
2484
2747
|
* application key is used to log all requests made to the API. </p>
|
|
@@ -2491,6 +2754,7 @@ export interface DatadogConnectorProfileCredentials {
|
|
|
2491
2754
|
*/
|
|
2492
2755
|
export interface DynatraceConnectorProfileCredentials {
|
|
2493
2756
|
/**
|
|
2757
|
+
* @public
|
|
2494
2758
|
* <p> The API tokens used by Dynatrace API to authenticate various API calls. </p>
|
|
2495
2759
|
*/
|
|
2496
2760
|
apiToken: string | undefined;
|
|
@@ -2501,24 +2765,29 @@ export interface DynatraceConnectorProfileCredentials {
|
|
|
2501
2765
|
*/
|
|
2502
2766
|
export interface GoogleAnalyticsConnectorProfileCredentials {
|
|
2503
2767
|
/**
|
|
2768
|
+
* @public
|
|
2504
2769
|
* <p> The identifier for the desired client. </p>
|
|
2505
2770
|
*/
|
|
2506
2771
|
clientId: string | undefined;
|
|
2507
2772
|
/**
|
|
2773
|
+
* @public
|
|
2508
2774
|
* <p> The client secret used by the OAuth client to authenticate to the authorization server.
|
|
2509
2775
|
* </p>
|
|
2510
2776
|
*/
|
|
2511
2777
|
clientSecret: string | undefined;
|
|
2512
2778
|
/**
|
|
2779
|
+
* @public
|
|
2513
2780
|
* <p> The credentials used to access protected Google Analytics resources. </p>
|
|
2514
2781
|
*/
|
|
2515
2782
|
accessToken?: string;
|
|
2516
2783
|
/**
|
|
2784
|
+
* @public
|
|
2517
2785
|
* <p> The credentials used to acquire new access tokens. This is required only for OAuth2
|
|
2518
2786
|
* access tokens, and is not required for OAuth1 access tokens. </p>
|
|
2519
2787
|
*/
|
|
2520
2788
|
refreshToken?: string;
|
|
2521
2789
|
/**
|
|
2790
|
+
* @public
|
|
2522
2791
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2523
2792
|
* </p>
|
|
2524
2793
|
*/
|
|
@@ -2530,14 +2799,17 @@ export interface GoogleAnalyticsConnectorProfileCredentials {
|
|
|
2530
2799
|
*/
|
|
2531
2800
|
export interface HoneycodeConnectorProfileCredentials {
|
|
2532
2801
|
/**
|
|
2802
|
+
* @public
|
|
2533
2803
|
* <p> The credentials used to access protected Amazon Honeycode resources. </p>
|
|
2534
2804
|
*/
|
|
2535
2805
|
accessToken?: string;
|
|
2536
2806
|
/**
|
|
2807
|
+
* @public
|
|
2537
2808
|
* <p> The credentials used to acquire new access tokens. </p>
|
|
2538
2809
|
*/
|
|
2539
2810
|
refreshToken?: string;
|
|
2540
2811
|
/**
|
|
2812
|
+
* @public
|
|
2541
2813
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2542
2814
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2543
2815
|
*/
|
|
@@ -2549,18 +2821,22 @@ export interface HoneycodeConnectorProfileCredentials {
|
|
|
2549
2821
|
*/
|
|
2550
2822
|
export interface InforNexusConnectorProfileCredentials {
|
|
2551
2823
|
/**
|
|
2824
|
+
* @public
|
|
2552
2825
|
* <p> The Access Key portion of the credentials. </p>
|
|
2553
2826
|
*/
|
|
2554
2827
|
accessKeyId: string | undefined;
|
|
2555
2828
|
/**
|
|
2829
|
+
* @public
|
|
2556
2830
|
* <p> The identifier for the user. </p>
|
|
2557
2831
|
*/
|
|
2558
2832
|
userId: string | undefined;
|
|
2559
2833
|
/**
|
|
2834
|
+
* @public
|
|
2560
2835
|
* <p> The secret key used to sign requests. </p>
|
|
2561
2836
|
*/
|
|
2562
2837
|
secretAccessKey: string | undefined;
|
|
2563
2838
|
/**
|
|
2839
|
+
* @public
|
|
2564
2840
|
* <p> The encryption keys used to encrypt data. </p>
|
|
2565
2841
|
*/
|
|
2566
2842
|
datakey: string | undefined;
|
|
@@ -2571,19 +2847,23 @@ export interface InforNexusConnectorProfileCredentials {
|
|
|
2571
2847
|
*/
|
|
2572
2848
|
export interface MarketoConnectorProfileCredentials {
|
|
2573
2849
|
/**
|
|
2850
|
+
* @public
|
|
2574
2851
|
* <p> The identifier for the desired client. </p>
|
|
2575
2852
|
*/
|
|
2576
2853
|
clientId: string | undefined;
|
|
2577
2854
|
/**
|
|
2855
|
+
* @public
|
|
2578
2856
|
* <p> The client secret used by the OAuth client to authenticate to the authorization server.
|
|
2579
2857
|
* </p>
|
|
2580
2858
|
*/
|
|
2581
2859
|
clientSecret: string | undefined;
|
|
2582
2860
|
/**
|
|
2861
|
+
* @public
|
|
2583
2862
|
* <p> The credentials used to access protected Marketo resources. </p>
|
|
2584
2863
|
*/
|
|
2585
2864
|
accessToken?: string;
|
|
2586
2865
|
/**
|
|
2866
|
+
* @public
|
|
2587
2867
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2588
2868
|
* </p>
|
|
2589
2869
|
*/
|
|
@@ -2595,19 +2875,23 @@ export interface MarketoConnectorProfileCredentials {
|
|
|
2595
2875
|
*/
|
|
2596
2876
|
export interface PardotConnectorProfileCredentials {
|
|
2597
2877
|
/**
|
|
2878
|
+
* @public
|
|
2598
2879
|
* <p>The credentials used to access protected Salesforce Pardot resources.</p>
|
|
2599
2880
|
*/
|
|
2600
2881
|
accessToken?: string;
|
|
2601
2882
|
/**
|
|
2883
|
+
* @public
|
|
2602
2884
|
* <p>The credentials used to acquire new access tokens.</p>
|
|
2603
2885
|
*/
|
|
2604
2886
|
refreshToken?: string;
|
|
2605
2887
|
/**
|
|
2888
|
+
* @public
|
|
2606
2889
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2607
2890
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2608
2891
|
*/
|
|
2609
2892
|
oAuthRequest?: ConnectorOAuthRequest;
|
|
2610
2893
|
/**
|
|
2894
|
+
* @public
|
|
2611
2895
|
* <p>The secret manager ARN, which contains the client ID and client secret of the connected
|
|
2612
2896
|
* app.</p>
|
|
2613
2897
|
*/
|
|
@@ -2619,10 +2903,12 @@ export interface PardotConnectorProfileCredentials {
|
|
|
2619
2903
|
*/
|
|
2620
2904
|
export interface RedshiftConnectorProfileCredentials {
|
|
2621
2905
|
/**
|
|
2906
|
+
* @public
|
|
2622
2907
|
* <p> The name of the user. </p>
|
|
2623
2908
|
*/
|
|
2624
2909
|
username?: string;
|
|
2625
2910
|
/**
|
|
2911
|
+
* @public
|
|
2626
2912
|
* <p> The password that corresponds to the user name. </p>
|
|
2627
2913
|
*/
|
|
2628
2914
|
password?: string;
|
|
@@ -2633,24 +2919,29 @@ export interface RedshiftConnectorProfileCredentials {
|
|
|
2633
2919
|
*/
|
|
2634
2920
|
export interface SalesforceConnectorProfileCredentials {
|
|
2635
2921
|
/**
|
|
2922
|
+
* @public
|
|
2636
2923
|
* <p> The credentials used to access protected Salesforce resources. </p>
|
|
2637
2924
|
*/
|
|
2638
2925
|
accessToken?: string;
|
|
2639
2926
|
/**
|
|
2927
|
+
* @public
|
|
2640
2928
|
* <p> The credentials used to acquire new access tokens. </p>
|
|
2641
2929
|
*/
|
|
2642
2930
|
refreshToken?: string;
|
|
2643
2931
|
/**
|
|
2932
|
+
* @public
|
|
2644
2933
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2645
2934
|
* </p>
|
|
2646
2935
|
*/
|
|
2647
2936
|
oAuthRequest?: ConnectorOAuthRequest;
|
|
2648
2937
|
/**
|
|
2938
|
+
* @public
|
|
2649
2939
|
* <p> The secret manager ARN, which contains the client ID and client secret of the connected
|
|
2650
2940
|
* app. </p>
|
|
2651
2941
|
*/
|
|
2652
2942
|
clientCredentialsArn?: string;
|
|
2653
2943
|
/**
|
|
2944
|
+
* @public
|
|
2654
2945
|
* <p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an
|
|
2655
2946
|
* access token from Salesforce. Amazon AppFlow requires an access token each time it
|
|
2656
2947
|
* attempts to access your Salesforce records.</p>
|
|
@@ -2680,6 +2971,7 @@ export interface SalesforceConnectorProfileCredentials {
|
|
|
2680
2971
|
*/
|
|
2681
2972
|
oAuth2GrantType?: OAuth2GrantType | string;
|
|
2682
2973
|
/**
|
|
2974
|
+
* @public
|
|
2683
2975
|
* <p>A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce
|
|
2684
2976
|
* records.</p>
|
|
2685
2977
|
*/
|
|
@@ -2691,23 +2983,28 @@ export interface SalesforceConnectorProfileCredentials {
|
|
|
2691
2983
|
*/
|
|
2692
2984
|
export interface OAuthCredentials {
|
|
2693
2985
|
/**
|
|
2986
|
+
* @public
|
|
2694
2987
|
* <p> The identifier for the desired client. </p>
|
|
2695
2988
|
*/
|
|
2696
2989
|
clientId: string | undefined;
|
|
2697
2990
|
/**
|
|
2991
|
+
* @public
|
|
2698
2992
|
* <p> The client secret used by the OAuth client to authenticate to the authorization server.
|
|
2699
2993
|
* </p>
|
|
2700
2994
|
*/
|
|
2701
2995
|
clientSecret: string | undefined;
|
|
2702
2996
|
/**
|
|
2997
|
+
* @public
|
|
2703
2998
|
* <p> The access token used to access protected SAPOData resources. </p>
|
|
2704
2999
|
*/
|
|
2705
3000
|
accessToken?: string;
|
|
2706
3001
|
/**
|
|
3002
|
+
* @public
|
|
2707
3003
|
* <p> The refresh token used to refresh expired access token. </p>
|
|
2708
3004
|
*/
|
|
2709
3005
|
refreshToken?: string;
|
|
2710
3006
|
/**
|
|
3007
|
+
* @public
|
|
2711
3008
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2712
3009
|
* </p>
|
|
2713
3010
|
*/
|
|
@@ -2719,10 +3016,12 @@ export interface OAuthCredentials {
|
|
|
2719
3016
|
*/
|
|
2720
3017
|
export interface SAPODataConnectorProfileCredentials {
|
|
2721
3018
|
/**
|
|
3019
|
+
* @public
|
|
2722
3020
|
* <p> The SAPOData basic authentication credentials. </p>
|
|
2723
3021
|
*/
|
|
2724
3022
|
basicAuthCredentials?: BasicAuthCredentials;
|
|
2725
3023
|
/**
|
|
3024
|
+
* @public
|
|
2726
3025
|
* <p> The SAPOData OAuth type authentication credentials. </p>
|
|
2727
3026
|
*/
|
|
2728
3027
|
oAuthCredentials?: OAuthCredentials;
|
|
@@ -2733,10 +3032,12 @@ export interface SAPODataConnectorProfileCredentials {
|
|
|
2733
3032
|
*/
|
|
2734
3033
|
export interface ServiceNowConnectorProfileCredentials {
|
|
2735
3034
|
/**
|
|
3035
|
+
* @public
|
|
2736
3036
|
* <p> The name of the user. </p>
|
|
2737
3037
|
*/
|
|
2738
3038
|
username: string | undefined;
|
|
2739
3039
|
/**
|
|
3040
|
+
* @public
|
|
2740
3041
|
* <p> The password that corresponds to the user name. </p>
|
|
2741
3042
|
*/
|
|
2742
3043
|
password: string | undefined;
|
|
@@ -2747,6 +3048,7 @@ export interface ServiceNowConnectorProfileCredentials {
|
|
|
2747
3048
|
*/
|
|
2748
3049
|
export interface SingularConnectorProfileCredentials {
|
|
2749
3050
|
/**
|
|
3051
|
+
* @public
|
|
2750
3052
|
* <p> A unique alphanumeric identifier used to authenticate a user, developer, or calling
|
|
2751
3053
|
* program to your API. </p>
|
|
2752
3054
|
*/
|
|
@@ -2758,19 +3060,23 @@ export interface SingularConnectorProfileCredentials {
|
|
|
2758
3060
|
*/
|
|
2759
3061
|
export interface SlackConnectorProfileCredentials {
|
|
2760
3062
|
/**
|
|
3063
|
+
* @public
|
|
2761
3064
|
* <p> The identifier for the client. </p>
|
|
2762
3065
|
*/
|
|
2763
3066
|
clientId: string | undefined;
|
|
2764
3067
|
/**
|
|
3068
|
+
* @public
|
|
2765
3069
|
* <p> The client secret used by the OAuth client to authenticate to the authorization server.
|
|
2766
3070
|
* </p>
|
|
2767
3071
|
*/
|
|
2768
3072
|
clientSecret: string | undefined;
|
|
2769
3073
|
/**
|
|
3074
|
+
* @public
|
|
2770
3075
|
* <p> The credentials used to access protected Slack resources. </p>
|
|
2771
3076
|
*/
|
|
2772
3077
|
accessToken?: string;
|
|
2773
3078
|
/**
|
|
3079
|
+
* @public
|
|
2774
3080
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2775
3081
|
* </p>
|
|
2776
3082
|
*/
|
|
@@ -2782,10 +3088,12 @@ export interface SlackConnectorProfileCredentials {
|
|
|
2782
3088
|
*/
|
|
2783
3089
|
export interface SnowflakeConnectorProfileCredentials {
|
|
2784
3090
|
/**
|
|
3091
|
+
* @public
|
|
2785
3092
|
* <p> The name of the user. </p>
|
|
2786
3093
|
*/
|
|
2787
3094
|
username: string | undefined;
|
|
2788
3095
|
/**
|
|
3096
|
+
* @public
|
|
2789
3097
|
* <p> The password that corresponds to the user name. </p>
|
|
2790
3098
|
*/
|
|
2791
3099
|
password: string | undefined;
|
|
@@ -2796,6 +3104,7 @@ export interface SnowflakeConnectorProfileCredentials {
|
|
|
2796
3104
|
*/
|
|
2797
3105
|
export interface TrendmicroConnectorProfileCredentials {
|
|
2798
3106
|
/**
|
|
3107
|
+
* @public
|
|
2799
3108
|
* <p> The Secret Access Key portion of the credentials. </p>
|
|
2800
3109
|
*/
|
|
2801
3110
|
apiSecretKey: string | undefined;
|
|
@@ -2806,10 +3115,12 @@ export interface TrendmicroConnectorProfileCredentials {
|
|
|
2806
3115
|
*/
|
|
2807
3116
|
export interface VeevaConnectorProfileCredentials {
|
|
2808
3117
|
/**
|
|
3118
|
+
* @public
|
|
2809
3119
|
* <p> The name of the user. </p>
|
|
2810
3120
|
*/
|
|
2811
3121
|
username: string | undefined;
|
|
2812
3122
|
/**
|
|
3123
|
+
* @public
|
|
2813
3124
|
* <p> The password that corresponds to the user name. </p>
|
|
2814
3125
|
*/
|
|
2815
3126
|
password: string | undefined;
|
|
@@ -2820,19 +3131,23 @@ export interface VeevaConnectorProfileCredentials {
|
|
|
2820
3131
|
*/
|
|
2821
3132
|
export interface ZendeskConnectorProfileCredentials {
|
|
2822
3133
|
/**
|
|
3134
|
+
* @public
|
|
2823
3135
|
* <p> The identifier for the desired client. </p>
|
|
2824
3136
|
*/
|
|
2825
3137
|
clientId: string | undefined;
|
|
2826
3138
|
/**
|
|
3139
|
+
* @public
|
|
2827
3140
|
* <p> The client secret used by the OAuth client to authenticate to the authorization server.
|
|
2828
3141
|
* </p>
|
|
2829
3142
|
*/
|
|
2830
3143
|
clientSecret: string | undefined;
|
|
2831
3144
|
/**
|
|
3145
|
+
* @public
|
|
2832
3146
|
* <p> The credentials used to access protected Zendesk resources. </p>
|
|
2833
3147
|
*/
|
|
2834
3148
|
accessToken?: string;
|
|
2835
3149
|
/**
|
|
3150
|
+
* @public
|
|
2836
3151
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2837
3152
|
* </p>
|
|
2838
3153
|
*/
|
|
@@ -2844,79 +3159,98 @@ export interface ZendeskConnectorProfileCredentials {
|
|
|
2844
3159
|
*/
|
|
2845
3160
|
export interface ConnectorProfileCredentials {
|
|
2846
3161
|
/**
|
|
3162
|
+
* @public
|
|
2847
3163
|
* <p> The connector-specific credentials required when using Amplitude. </p>
|
|
2848
3164
|
*/
|
|
2849
3165
|
Amplitude?: AmplitudeConnectorProfileCredentials;
|
|
2850
3166
|
/**
|
|
3167
|
+
* @public
|
|
2851
3168
|
* <p> The connector-specific credentials required when using Datadog. </p>
|
|
2852
3169
|
*/
|
|
2853
3170
|
Datadog?: DatadogConnectorProfileCredentials;
|
|
2854
3171
|
/**
|
|
3172
|
+
* @public
|
|
2855
3173
|
* <p> The connector-specific credentials required when using Dynatrace. </p>
|
|
2856
3174
|
*/
|
|
2857
3175
|
Dynatrace?: DynatraceConnectorProfileCredentials;
|
|
2858
3176
|
/**
|
|
3177
|
+
* @public
|
|
2859
3178
|
* <p> The connector-specific credentials required when using Google Analytics. </p>
|
|
2860
3179
|
*/
|
|
2861
3180
|
GoogleAnalytics?: GoogleAnalyticsConnectorProfileCredentials;
|
|
2862
3181
|
/**
|
|
3182
|
+
* @public
|
|
2863
3183
|
* <p> The connector-specific credentials required when using Amazon Honeycode. </p>
|
|
2864
3184
|
*/
|
|
2865
3185
|
Honeycode?: HoneycodeConnectorProfileCredentials;
|
|
2866
3186
|
/**
|
|
3187
|
+
* @public
|
|
2867
3188
|
* <p> The connector-specific credentials required when using Infor Nexus. </p>
|
|
2868
3189
|
*/
|
|
2869
3190
|
InforNexus?: InforNexusConnectorProfileCredentials;
|
|
2870
3191
|
/**
|
|
3192
|
+
* @public
|
|
2871
3193
|
* <p> The connector-specific credentials required when using Marketo. </p>
|
|
2872
3194
|
*/
|
|
2873
3195
|
Marketo?: MarketoConnectorProfileCredentials;
|
|
2874
3196
|
/**
|
|
3197
|
+
* @public
|
|
2875
3198
|
* <p> The connector-specific credentials required when using Amazon Redshift. </p>
|
|
2876
3199
|
*/
|
|
2877
3200
|
Redshift?: RedshiftConnectorProfileCredentials;
|
|
2878
3201
|
/**
|
|
3202
|
+
* @public
|
|
2879
3203
|
* <p> The connector-specific credentials required when using Salesforce. </p>
|
|
2880
3204
|
*/
|
|
2881
3205
|
Salesforce?: SalesforceConnectorProfileCredentials;
|
|
2882
3206
|
/**
|
|
3207
|
+
* @public
|
|
2883
3208
|
* <p> The connector-specific credentials required when using ServiceNow. </p>
|
|
2884
3209
|
*/
|
|
2885
3210
|
ServiceNow?: ServiceNowConnectorProfileCredentials;
|
|
2886
3211
|
/**
|
|
3212
|
+
* @public
|
|
2887
3213
|
* <p> The connector-specific credentials required when using Singular. </p>
|
|
2888
3214
|
*/
|
|
2889
3215
|
Singular?: SingularConnectorProfileCredentials;
|
|
2890
3216
|
/**
|
|
3217
|
+
* @public
|
|
2891
3218
|
* <p> The connector-specific credentials required when using Slack. </p>
|
|
2892
3219
|
*/
|
|
2893
3220
|
Slack?: SlackConnectorProfileCredentials;
|
|
2894
3221
|
/**
|
|
3222
|
+
* @public
|
|
2895
3223
|
* <p> The connector-specific credentials required when using Snowflake. </p>
|
|
2896
3224
|
*/
|
|
2897
3225
|
Snowflake?: SnowflakeConnectorProfileCredentials;
|
|
2898
3226
|
/**
|
|
3227
|
+
* @public
|
|
2899
3228
|
* <p> The connector-specific credentials required when using Trend Micro. </p>
|
|
2900
3229
|
*/
|
|
2901
3230
|
Trendmicro?: TrendmicroConnectorProfileCredentials;
|
|
2902
3231
|
/**
|
|
3232
|
+
* @public
|
|
2903
3233
|
* <p> The connector-specific credentials required when using Veeva. </p>
|
|
2904
3234
|
*/
|
|
2905
3235
|
Veeva?: VeevaConnectorProfileCredentials;
|
|
2906
3236
|
/**
|
|
3237
|
+
* @public
|
|
2907
3238
|
* <p> The connector-specific credentials required when using Zendesk. </p>
|
|
2908
3239
|
*/
|
|
2909
3240
|
Zendesk?: ZendeskConnectorProfileCredentials;
|
|
2910
3241
|
/**
|
|
3242
|
+
* @public
|
|
2911
3243
|
* <p> The connector-specific profile credentials required when using SAPOData. </p>
|
|
2912
3244
|
*/
|
|
2913
3245
|
SAPOData?: SAPODataConnectorProfileCredentials;
|
|
2914
3246
|
/**
|
|
3247
|
+
* @public
|
|
2915
3248
|
* <p>The connector-specific profile credentials that are required when using the custom
|
|
2916
3249
|
* connector.</p>
|
|
2917
3250
|
*/
|
|
2918
3251
|
CustomConnector?: CustomConnectorProfileCredentials;
|
|
2919
3252
|
/**
|
|
3253
|
+
* @public
|
|
2920
3254
|
* <p>The connector-specific credentials required when using Salesforce Pardot.</p>
|
|
2921
3255
|
*/
|
|
2922
3256
|
Pardot?: PardotConnectorProfileCredentials;
|
|
@@ -2928,10 +3262,12 @@ export interface ConnectorProfileCredentials {
|
|
|
2928
3262
|
*/
|
|
2929
3263
|
export interface ConnectorProfileConfig {
|
|
2930
3264
|
/**
|
|
3265
|
+
* @public
|
|
2931
3266
|
* <p> The connector-specific properties of the profile configuration. </p>
|
|
2932
3267
|
*/
|
|
2933
3268
|
connectorProfileProperties: ConnectorProfileProperties | undefined;
|
|
2934
3269
|
/**
|
|
3270
|
+
* @public
|
|
2935
3271
|
* <p> The connector-specific credentials required by each connector. </p>
|
|
2936
3272
|
*/
|
|
2937
3273
|
connectorProfileCredentials?: ConnectorProfileCredentials;
|
|
@@ -2953,37 +3289,44 @@ export declare class ConnectorServerException extends __BaseException {
|
|
|
2953
3289
|
*/
|
|
2954
3290
|
export interface CreateConnectorProfileRequest {
|
|
2955
3291
|
/**
|
|
3292
|
+
* @public
|
|
2956
3293
|
* <p> The name of the connector profile. The name is unique for each
|
|
2957
3294
|
* <code>ConnectorProfile</code> in your Amazon Web Services account. </p>
|
|
2958
3295
|
*/
|
|
2959
3296
|
connectorProfileName: string | undefined;
|
|
2960
3297
|
/**
|
|
3298
|
+
* @public
|
|
2961
3299
|
* <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
|
|
2962
3300
|
* encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS
|
|
2963
3301
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
2964
3302
|
*/
|
|
2965
3303
|
kmsArn?: string;
|
|
2966
3304
|
/**
|
|
3305
|
+
* @public
|
|
2967
3306
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
2968
3307
|
*/
|
|
2969
3308
|
connectorType: ConnectorType | string | undefined;
|
|
2970
3309
|
/**
|
|
3310
|
+
* @public
|
|
2971
3311
|
* <p>The label of the connector. The label is unique for each
|
|
2972
3312
|
* <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if
|
|
2973
3313
|
* calling for CUSTOMCONNECTOR connector type/.</p>
|
|
2974
3314
|
*/
|
|
2975
3315
|
connectorLabel?: string;
|
|
2976
3316
|
/**
|
|
3317
|
+
* @public
|
|
2977
3318
|
* <p> Indicates the connection mode and specifies whether it is public or private. Private
|
|
2978
3319
|
* flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure
|
|
2979
3320
|
* without exposing it to the public internet. </p>
|
|
2980
3321
|
*/
|
|
2981
3322
|
connectionMode: ConnectionMode | string | undefined;
|
|
2982
3323
|
/**
|
|
3324
|
+
* @public
|
|
2983
3325
|
* <p> Defines the connector-specific configuration and credentials. </p>
|
|
2984
3326
|
*/
|
|
2985
3327
|
connectorProfileConfig: ConnectorProfileConfig | undefined;
|
|
2986
3328
|
/**
|
|
3329
|
+
* @public
|
|
2987
3330
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
2988
3331
|
* <code>CreateConnectorProfile</code> request completes only once. You choose the value to
|
|
2989
3332
|
* pass. For example, if you don't receive a response from your request, you can safely retry the
|
|
@@ -3002,6 +3345,7 @@ export interface CreateConnectorProfileRequest {
|
|
|
3002
3345
|
*/
|
|
3003
3346
|
export interface CreateConnectorProfileResponse {
|
|
3004
3347
|
/**
|
|
3348
|
+
* @public
|
|
3005
3349
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
3006
3350
|
*/
|
|
3007
3351
|
connectorProfileArn?: string;
|
|
@@ -3029,15 +3373,18 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
3029
3373
|
*/
|
|
3030
3374
|
export interface ErrorHandlingConfig {
|
|
3031
3375
|
/**
|
|
3376
|
+
* @public
|
|
3032
3377
|
* <p> Specifies if the flow should fail after the first instance of a failure when attempting
|
|
3033
3378
|
* to place data in the destination. </p>
|
|
3034
3379
|
*/
|
|
3035
3380
|
failOnFirstDestinationError?: boolean;
|
|
3036
3381
|
/**
|
|
3382
|
+
* @public
|
|
3037
3383
|
* <p> Specifies the Amazon S3 bucket prefix. </p>
|
|
3038
3384
|
*/
|
|
3039
3385
|
bucketPrefix?: string;
|
|
3040
3386
|
/**
|
|
3387
|
+
* @public
|
|
3041
3388
|
* <p> Specifies the name of the Amazon S3 bucket. </p>
|
|
3042
3389
|
*/
|
|
3043
3390
|
bucketName?: string;
|
|
@@ -3049,25 +3396,30 @@ export interface ErrorHandlingConfig {
|
|
|
3049
3396
|
*/
|
|
3050
3397
|
export interface CustomConnectorDestinationProperties {
|
|
3051
3398
|
/**
|
|
3399
|
+
* @public
|
|
3052
3400
|
* <p>The entity specified in the custom connector as a destination in the flow.</p>
|
|
3053
3401
|
*/
|
|
3054
3402
|
entityName: string | undefined;
|
|
3055
3403
|
/**
|
|
3404
|
+
* @public
|
|
3056
3405
|
* <p>The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3057
3406
|
* the custom connector as destination.</p>
|
|
3058
3407
|
*/
|
|
3059
3408
|
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3060
3409
|
/**
|
|
3410
|
+
* @public
|
|
3061
3411
|
* <p>Specifies the type of write operation to be performed in the custom connector when it's
|
|
3062
3412
|
* used as destination.</p>
|
|
3063
3413
|
*/
|
|
3064
3414
|
writeOperationType?: WriteOperationType | string;
|
|
3065
3415
|
/**
|
|
3416
|
+
* @public
|
|
3066
3417
|
* <p>The name of the field that Amazon AppFlow uses as an ID when performing a write
|
|
3067
3418
|
* operation such as update, delete, or upsert.</p>
|
|
3068
3419
|
*/
|
|
3069
3420
|
idFieldNames?: string[];
|
|
3070
3421
|
/**
|
|
3422
|
+
* @public
|
|
3071
3423
|
* <p>The custom properties that are specific to the connector when it's used as a destination
|
|
3072
3424
|
* in the flow.</p>
|
|
3073
3425
|
*/
|
|
@@ -3080,10 +3432,12 @@ export interface CustomConnectorDestinationProperties {
|
|
|
3080
3432
|
*/
|
|
3081
3433
|
export interface CustomerProfilesDestinationProperties {
|
|
3082
3434
|
/**
|
|
3435
|
+
* @public
|
|
3083
3436
|
* <p> The unique name of the Amazon Connect Customer Profiles domain. </p>
|
|
3084
3437
|
*/
|
|
3085
3438
|
domainName: string | undefined;
|
|
3086
3439
|
/**
|
|
3440
|
+
* @public
|
|
3087
3441
|
* <p> The object specified in the Amazon Connect Customer Profiles flow destination.
|
|
3088
3442
|
* </p>
|
|
3089
3443
|
*/
|
|
@@ -3096,10 +3450,12 @@ export interface CustomerProfilesDestinationProperties {
|
|
|
3096
3450
|
*/
|
|
3097
3451
|
export interface EventBridgeDestinationProperties {
|
|
3098
3452
|
/**
|
|
3453
|
+
* @public
|
|
3099
3454
|
* <p> The object specified in the Amazon EventBridge flow destination. </p>
|
|
3100
3455
|
*/
|
|
3101
3456
|
object: string | undefined;
|
|
3102
3457
|
/**
|
|
3458
|
+
* @public
|
|
3103
3459
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3104
3460
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
3105
3461
|
* insertion error, or continue and attempt to insert every record regardless of the initial
|
|
@@ -3114,10 +3470,12 @@ export interface EventBridgeDestinationProperties {
|
|
|
3114
3470
|
*/
|
|
3115
3471
|
export interface HoneycodeDestinationProperties {
|
|
3116
3472
|
/**
|
|
3473
|
+
* @public
|
|
3117
3474
|
* <p> The object specified in the Amazon Honeycode flow destination. </p>
|
|
3118
3475
|
*/
|
|
3119
3476
|
object: string | undefined;
|
|
3120
3477
|
/**
|
|
3478
|
+
* @public
|
|
3121
3479
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3122
3480
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
3123
3481
|
* insertion error, or continue and attempt to insert every record regardless of the initial
|
|
@@ -3140,10 +3498,12 @@ export interface LookoutMetricsDestinationProperties {
|
|
|
3140
3498
|
*/
|
|
3141
3499
|
export interface MarketoDestinationProperties {
|
|
3142
3500
|
/**
|
|
3501
|
+
* @public
|
|
3143
3502
|
* <p>The object specified in the Marketo flow destination.</p>
|
|
3144
3503
|
*/
|
|
3145
3504
|
object: string | undefined;
|
|
3146
3505
|
/**
|
|
3506
|
+
* @public
|
|
3147
3507
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3148
3508
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
3149
3509
|
* insertion error, or continue and attempt to insert every record regardless of the initial
|
|
@@ -3159,19 +3519,23 @@ export interface MarketoDestinationProperties {
|
|
|
3159
3519
|
*/
|
|
3160
3520
|
export interface RedshiftDestinationProperties {
|
|
3161
3521
|
/**
|
|
3522
|
+
* @public
|
|
3162
3523
|
* <p> The object specified in the Amazon Redshift flow destination. </p>
|
|
3163
3524
|
*/
|
|
3164
3525
|
object: string | undefined;
|
|
3165
3526
|
/**
|
|
3527
|
+
* @public
|
|
3166
3528
|
* <p> The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift. </p>
|
|
3167
3529
|
*/
|
|
3168
3530
|
intermediateBucketName: string | undefined;
|
|
3169
3531
|
/**
|
|
3532
|
+
* @public
|
|
3170
3533
|
* <p> The object key for the bucket in which Amazon AppFlow places the destination files.
|
|
3171
3534
|
* </p>
|
|
3172
3535
|
*/
|
|
3173
3536
|
bucketPrefix?: string;
|
|
3174
3537
|
/**
|
|
3538
|
+
* @public
|
|
3175
3539
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3176
3540
|
* the Amazon Redshift destination. For example, this setting would determine if the flow
|
|
3177
3541
|
* should fail after one insertion error, or continue and attempt to insert every record
|
|
@@ -3240,16 +3604,19 @@ export type PrefixType = (typeof PrefixType)[keyof typeof PrefixType];
|
|
|
3240
3604
|
*/
|
|
3241
3605
|
export interface PrefixConfig {
|
|
3242
3606
|
/**
|
|
3607
|
+
* @public
|
|
3243
3608
|
* <p>Determines the format of the prefix, and whether it applies to the file name, file path,
|
|
3244
3609
|
* or both. </p>
|
|
3245
3610
|
*/
|
|
3246
3611
|
prefixType?: PrefixType | string;
|
|
3247
3612
|
/**
|
|
3613
|
+
* @public
|
|
3248
3614
|
* <p>Determines the level of granularity for the date and time that's included in the prefix.
|
|
3249
3615
|
* </p>
|
|
3250
3616
|
*/
|
|
3251
3617
|
prefixFormat?: PrefixFormat | string;
|
|
3252
3618
|
/**
|
|
3619
|
+
* @public
|
|
3253
3620
|
* <p>Specifies whether the destination file path includes either or both of the following
|
|
3254
3621
|
* elements:</p>
|
|
3255
3622
|
* <dl>
|
|
@@ -3285,20 +3652,24 @@ export interface PrefixConfig {
|
|
|
3285
3652
|
*/
|
|
3286
3653
|
export interface S3OutputFormatConfig {
|
|
3287
3654
|
/**
|
|
3655
|
+
* @public
|
|
3288
3656
|
* <p> Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket.
|
|
3289
3657
|
* </p>
|
|
3290
3658
|
*/
|
|
3291
3659
|
fileType?: FileType | string;
|
|
3292
3660
|
/**
|
|
3661
|
+
* @public
|
|
3293
3662
|
* <p> Determines the prefix that Amazon AppFlow applies to the folder name in the Amazon S3 bucket. You can name folders according to the flow frequency and date. </p>
|
|
3294
3663
|
*/
|
|
3295
3664
|
prefixConfig?: PrefixConfig;
|
|
3296
3665
|
/**
|
|
3666
|
+
* @public
|
|
3297
3667
|
* <p> The aggregation settings that you can use to customize the output format of your flow
|
|
3298
3668
|
* data. </p>
|
|
3299
3669
|
*/
|
|
3300
3670
|
aggregationConfig?: AggregationConfig;
|
|
3301
3671
|
/**
|
|
3672
|
+
* @public
|
|
3302
3673
|
* <p>If your file output format is Parquet, use this parameter to set whether Amazon AppFlow preserves the data types in your source data when it writes the output to Amazon S3. </p>
|
|
3303
3674
|
* <ul>
|
|
3304
3675
|
* <li>
|
|
@@ -3323,16 +3694,19 @@ export interface S3OutputFormatConfig {
|
|
|
3323
3694
|
*/
|
|
3324
3695
|
export interface S3DestinationProperties {
|
|
3325
3696
|
/**
|
|
3697
|
+
* @public
|
|
3326
3698
|
* <p> The Amazon S3 bucket name in which Amazon AppFlow places the transferred
|
|
3327
3699
|
* data. </p>
|
|
3328
3700
|
*/
|
|
3329
3701
|
bucketName: string | undefined;
|
|
3330
3702
|
/**
|
|
3703
|
+
* @public
|
|
3331
3704
|
* <p> The object key for the destination bucket in which Amazon AppFlow places the files.
|
|
3332
3705
|
* </p>
|
|
3333
3706
|
*/
|
|
3334
3707
|
bucketPrefix?: string;
|
|
3335
3708
|
/**
|
|
3709
|
+
* @public
|
|
3336
3710
|
* <p> The configuration that determines how Amazon AppFlow should format the flow output
|
|
3337
3711
|
* data when Amazon S3 is used as the destination. </p>
|
|
3338
3712
|
*/
|
|
@@ -3344,15 +3718,18 @@ export interface S3DestinationProperties {
|
|
|
3344
3718
|
*/
|
|
3345
3719
|
export interface SalesforceDestinationProperties {
|
|
3346
3720
|
/**
|
|
3721
|
+
* @public
|
|
3347
3722
|
* <p> The object specified in the Salesforce flow destination. </p>
|
|
3348
3723
|
*/
|
|
3349
3724
|
object: string | undefined;
|
|
3350
3725
|
/**
|
|
3726
|
+
* @public
|
|
3351
3727
|
* <p> The name of the field that Amazon AppFlow uses as an ID when performing a write
|
|
3352
3728
|
* operation such as update or delete. </p>
|
|
3353
3729
|
*/
|
|
3354
3730
|
idFieldNames?: string[];
|
|
3355
3731
|
/**
|
|
3732
|
+
* @public
|
|
3356
3733
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3357
3734
|
* the Salesforce destination. For example, this setting would determine if the flow should fail
|
|
3358
3735
|
* after one insertion error, or continue and attempt to insert every record regardless of the
|
|
@@ -3361,11 +3738,13 @@ export interface SalesforceDestinationProperties {
|
|
|
3361
3738
|
*/
|
|
3362
3739
|
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3363
3740
|
/**
|
|
3741
|
+
* @public
|
|
3364
3742
|
* <p> This specifies the type of write operation to be performed in Salesforce. When the value
|
|
3365
3743
|
* is <code>UPSERT</code>, then <code>idFieldNames</code> is required. </p>
|
|
3366
3744
|
*/
|
|
3367
3745
|
writeOperationType?: WriteOperationType | string;
|
|
3368
3746
|
/**
|
|
3747
|
+
* @public
|
|
3369
3748
|
* <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
|
|
3370
3749
|
* data to Salesforce.</p>
|
|
3371
3750
|
* <dl>
|
|
@@ -3415,10 +3794,12 @@ export interface SalesforceDestinationProperties {
|
|
|
3415
3794
|
*/
|
|
3416
3795
|
export interface SuccessResponseHandlingConfig {
|
|
3417
3796
|
/**
|
|
3797
|
+
* @public
|
|
3418
3798
|
* <p>The Amazon S3 bucket prefix.</p>
|
|
3419
3799
|
*/
|
|
3420
3800
|
bucketPrefix?: string;
|
|
3421
3801
|
/**
|
|
3802
|
+
* @public
|
|
3422
3803
|
* <p>The name of the Amazon S3 bucket.</p>
|
|
3423
3804
|
*/
|
|
3424
3805
|
bucketName?: string;
|
|
@@ -3429,10 +3810,12 @@ export interface SuccessResponseHandlingConfig {
|
|
|
3429
3810
|
*/
|
|
3430
3811
|
export interface SAPODataDestinationProperties {
|
|
3431
3812
|
/**
|
|
3813
|
+
* @public
|
|
3432
3814
|
* <p>The object path specified in the SAPOData flow destination.</p>
|
|
3433
3815
|
*/
|
|
3434
3816
|
objectPath: string | undefined;
|
|
3435
3817
|
/**
|
|
3818
|
+
* @public
|
|
3436
3819
|
* <p>Determines how Amazon AppFlow handles the success response that it gets from the
|
|
3437
3820
|
* connector after placing data.</p>
|
|
3438
3821
|
* <p>For example, this setting would determine where to write the response from a destination
|
|
@@ -3440,11 +3823,13 @@ export interface SAPODataDestinationProperties {
|
|
|
3440
3823
|
*/
|
|
3441
3824
|
successResponseHandlingConfig?: SuccessResponseHandlingConfig;
|
|
3442
3825
|
/**
|
|
3826
|
+
* @public
|
|
3443
3827
|
* <p> A list of field names that can be used as an ID field when performing a write operation.
|
|
3444
3828
|
* </p>
|
|
3445
3829
|
*/
|
|
3446
3830
|
idFieldNames?: string[];
|
|
3447
3831
|
/**
|
|
3832
|
+
* @public
|
|
3448
3833
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3449
3834
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
3450
3835
|
* insertion error, or continue and attempt to insert every record regardless of the initial
|
|
@@ -3453,6 +3838,7 @@ export interface SAPODataDestinationProperties {
|
|
|
3453
3838
|
*/
|
|
3454
3839
|
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3455
3840
|
/**
|
|
3841
|
+
* @public
|
|
3456
3842
|
* <p> The possible write operations in the destination connector. When this value is not
|
|
3457
3843
|
* provided, this defaults to the <code>INSERT</code> operation. </p>
|
|
3458
3844
|
*/
|
|
@@ -3464,20 +3850,24 @@ export interface SAPODataDestinationProperties {
|
|
|
3464
3850
|
*/
|
|
3465
3851
|
export interface SnowflakeDestinationProperties {
|
|
3466
3852
|
/**
|
|
3853
|
+
* @public
|
|
3467
3854
|
* <p> The object specified in the Snowflake flow destination. </p>
|
|
3468
3855
|
*/
|
|
3469
3856
|
object: string | undefined;
|
|
3470
3857
|
/**
|
|
3858
|
+
* @public
|
|
3471
3859
|
* <p> The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake.
|
|
3472
3860
|
* </p>
|
|
3473
3861
|
*/
|
|
3474
3862
|
intermediateBucketName: string | undefined;
|
|
3475
3863
|
/**
|
|
3864
|
+
* @public
|
|
3476
3865
|
* <p> The object key for the destination bucket in which Amazon AppFlow places the files.
|
|
3477
3866
|
* </p>
|
|
3478
3867
|
*/
|
|
3479
3868
|
bucketPrefix?: string;
|
|
3480
3869
|
/**
|
|
3870
|
+
* @public
|
|
3481
3871
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3482
3872
|
* the Snowflake destination. For example, this setting would determine if the flow should fail
|
|
3483
3873
|
* after one insertion error, or continue and attempt to insert every record regardless of the
|
|
@@ -3493,16 +3883,19 @@ export interface SnowflakeDestinationProperties {
|
|
|
3493
3883
|
*/
|
|
3494
3884
|
export interface UpsolverS3OutputFormatConfig {
|
|
3495
3885
|
/**
|
|
3886
|
+
* @public
|
|
3496
3887
|
* <p> Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3
|
|
3497
3888
|
* bucket. </p>
|
|
3498
3889
|
*/
|
|
3499
3890
|
fileType?: FileType | string;
|
|
3500
3891
|
/**
|
|
3892
|
+
* @public
|
|
3501
3893
|
* <p>Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
|
|
3502
3894
|
* destination.</p>
|
|
3503
3895
|
*/
|
|
3504
3896
|
prefixConfig: PrefixConfig | undefined;
|
|
3505
3897
|
/**
|
|
3898
|
+
* @public
|
|
3506
3899
|
* <p> The aggregation settings that you can use to customize the output format of your flow
|
|
3507
3900
|
* data. </p>
|
|
3508
3901
|
*/
|
|
@@ -3514,15 +3907,18 @@ export interface UpsolverS3OutputFormatConfig {
|
|
|
3514
3907
|
*/
|
|
3515
3908
|
export interface UpsolverDestinationProperties {
|
|
3516
3909
|
/**
|
|
3910
|
+
* @public
|
|
3517
3911
|
* <p> The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the
|
|
3518
3912
|
* transferred data. </p>
|
|
3519
3913
|
*/
|
|
3520
3914
|
bucketName: string | undefined;
|
|
3521
3915
|
/**
|
|
3916
|
+
* @public
|
|
3522
3917
|
* <p> The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files. </p>
|
|
3523
3918
|
*/
|
|
3524
3919
|
bucketPrefix?: string;
|
|
3525
3920
|
/**
|
|
3921
|
+
* @public
|
|
3526
3922
|
* <p> The configuration that determines how data is formatted when Upsolver is used as the flow
|
|
3527
3923
|
* destination. </p>
|
|
3528
3924
|
*/
|
|
@@ -3534,15 +3930,18 @@ export interface UpsolverDestinationProperties {
|
|
|
3534
3930
|
*/
|
|
3535
3931
|
export interface ZendeskDestinationProperties {
|
|
3536
3932
|
/**
|
|
3933
|
+
* @public
|
|
3537
3934
|
* <p>The object specified in the Zendesk flow destination.</p>
|
|
3538
3935
|
*/
|
|
3539
3936
|
object: string | undefined;
|
|
3540
3937
|
/**
|
|
3938
|
+
* @public
|
|
3541
3939
|
* <p> A list of field names that can be used as an ID field when performing a write operation.
|
|
3542
3940
|
* </p>
|
|
3543
3941
|
*/
|
|
3544
3942
|
idFieldNames?: string[];
|
|
3545
3943
|
/**
|
|
3944
|
+
* @public
|
|
3546
3945
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3547
3946
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
3548
3947
|
* insertion error, or continue and attempt to insert every record regardless of the initial
|
|
@@ -3551,6 +3950,7 @@ export interface ZendeskDestinationProperties {
|
|
|
3551
3950
|
*/
|
|
3552
3951
|
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3553
3952
|
/**
|
|
3953
|
+
* @public
|
|
3554
3954
|
* <p> The possible write operations in the destination connector. When this value is not
|
|
3555
3955
|
* provided, this defaults to the <code>INSERT</code> operation. </p>
|
|
3556
3956
|
*/
|
|
@@ -3562,54 +3962,67 @@ export interface ZendeskDestinationProperties {
|
|
|
3562
3962
|
*/
|
|
3563
3963
|
export interface DestinationConnectorProperties {
|
|
3564
3964
|
/**
|
|
3965
|
+
* @public
|
|
3565
3966
|
* <p> The properties required to query Amazon Redshift. </p>
|
|
3566
3967
|
*/
|
|
3567
3968
|
Redshift?: RedshiftDestinationProperties;
|
|
3568
3969
|
/**
|
|
3970
|
+
* @public
|
|
3569
3971
|
* <p> The properties required to query Amazon S3. </p>
|
|
3570
3972
|
*/
|
|
3571
3973
|
S3?: S3DestinationProperties;
|
|
3572
3974
|
/**
|
|
3975
|
+
* @public
|
|
3573
3976
|
* <p> The properties required to query Salesforce. </p>
|
|
3574
3977
|
*/
|
|
3575
3978
|
Salesforce?: SalesforceDestinationProperties;
|
|
3576
3979
|
/**
|
|
3980
|
+
* @public
|
|
3577
3981
|
* <p> The properties required to query Snowflake. </p>
|
|
3578
3982
|
*/
|
|
3579
3983
|
Snowflake?: SnowflakeDestinationProperties;
|
|
3580
3984
|
/**
|
|
3985
|
+
* @public
|
|
3581
3986
|
* <p> The properties required to query Amazon EventBridge. </p>
|
|
3582
3987
|
*/
|
|
3583
3988
|
EventBridge?: EventBridgeDestinationProperties;
|
|
3584
3989
|
/**
|
|
3990
|
+
* @public
|
|
3585
3991
|
* <p> The properties required to query Amazon Lookout for Metrics. </p>
|
|
3586
3992
|
*/
|
|
3587
3993
|
LookoutMetrics?: LookoutMetricsDestinationProperties;
|
|
3588
3994
|
/**
|
|
3995
|
+
* @public
|
|
3589
3996
|
* <p> The properties required to query Upsolver. </p>
|
|
3590
3997
|
*/
|
|
3591
3998
|
Upsolver?: UpsolverDestinationProperties;
|
|
3592
3999
|
/**
|
|
4000
|
+
* @public
|
|
3593
4001
|
* <p> The properties required to query Amazon Honeycode. </p>
|
|
3594
4002
|
*/
|
|
3595
4003
|
Honeycode?: HoneycodeDestinationProperties;
|
|
3596
4004
|
/**
|
|
4005
|
+
* @public
|
|
3597
4006
|
* <p> The properties required to query Amazon Connect Customer Profiles. </p>
|
|
3598
4007
|
*/
|
|
3599
4008
|
CustomerProfiles?: CustomerProfilesDestinationProperties;
|
|
3600
4009
|
/**
|
|
4010
|
+
* @public
|
|
3601
4011
|
* <p>The properties required to query Zendesk.</p>
|
|
3602
4012
|
*/
|
|
3603
4013
|
Zendesk?: ZendeskDestinationProperties;
|
|
3604
4014
|
/**
|
|
4015
|
+
* @public
|
|
3605
4016
|
* <p>The properties required to query Marketo.</p>
|
|
3606
4017
|
*/
|
|
3607
4018
|
Marketo?: MarketoDestinationProperties;
|
|
3608
4019
|
/**
|
|
4020
|
+
* @public
|
|
3609
4021
|
* <p>The properties that are required to query the custom Connector.</p>
|
|
3610
4022
|
*/
|
|
3611
4023
|
CustomConnector?: CustomConnectorDestinationProperties;
|
|
3612
4024
|
/**
|
|
4025
|
+
* @public
|
|
3613
4026
|
* <p>The properties required to query SAPOData.</p>
|
|
3614
4027
|
*/
|
|
3615
4028
|
SAPOData?: SAPODataDestinationProperties;
|
|
@@ -3621,19 +4034,23 @@ export interface DestinationConnectorProperties {
|
|
|
3621
4034
|
*/
|
|
3622
4035
|
export interface DestinationFlowConfig {
|
|
3623
4036
|
/**
|
|
4037
|
+
* @public
|
|
3624
4038
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
3625
4039
|
*/
|
|
3626
4040
|
connectorType: ConnectorType | string | undefined;
|
|
3627
4041
|
/**
|
|
4042
|
+
* @public
|
|
3628
4043
|
* <p>The API version that the destination connector uses.</p>
|
|
3629
4044
|
*/
|
|
3630
4045
|
apiVersion?: string;
|
|
3631
4046
|
/**
|
|
4047
|
+
* @public
|
|
3632
4048
|
* <p> The name of the connector profile. This name must be unique for each connector profile in
|
|
3633
4049
|
* the Amazon Web Services account. </p>
|
|
3634
4050
|
*/
|
|
3635
4051
|
connectorProfileName?: string;
|
|
3636
4052
|
/**
|
|
4053
|
+
* @public
|
|
3637
4054
|
* <p> This stores the information that is required to query a particular connector. </p>
|
|
3638
4055
|
*/
|
|
3639
4056
|
destinationConnectorProperties: DestinationConnectorProperties | undefined;
|
|
@@ -3650,6 +4067,7 @@ export interface DestinationFlowConfig {
|
|
|
3650
4067
|
*/
|
|
3651
4068
|
export interface GlueDataCatalogConfig {
|
|
3652
4069
|
/**
|
|
4070
|
+
* @public
|
|
3653
4071
|
* <p>The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data Catalog tables, databases, and
|
|
3654
4072
|
* partitions.</p>
|
|
3655
4073
|
* <p>For an example IAM policy that has the required permissions, see <a href="https://docs.aws.amazon.com/appflow/latest/userguide/security_iam_id-based-policy-examples.html">Identity-based
|
|
@@ -3657,6 +4075,7 @@ export interface GlueDataCatalogConfig {
|
|
|
3657
4075
|
*/
|
|
3658
4076
|
roleArn: string | undefined;
|
|
3659
4077
|
/**
|
|
4078
|
+
* @public
|
|
3660
4079
|
* <p>The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon Web Services account. These tables contain metadata for
|
|
3661
4080
|
* the data that's transferred by the flow that you configure with this parameter.</p>
|
|
3662
4081
|
* <note>
|
|
@@ -3666,6 +4085,7 @@ export interface GlueDataCatalogConfig {
|
|
|
3666
4085
|
*/
|
|
3667
4086
|
databaseName: string | undefined;
|
|
3668
4087
|
/**
|
|
4088
|
+
* @public
|
|
3669
4089
|
* <p>A naming prefix for each Data Catalog table that Amazon AppFlow creates for
|
|
3670
4090
|
* the flow that you configure with this setting. Amazon AppFlow adds the prefix to the
|
|
3671
4091
|
* beginning of the each table name.</p>
|
|
@@ -3679,6 +4099,7 @@ export interface GlueDataCatalogConfig {
|
|
|
3679
4099
|
*/
|
|
3680
4100
|
export interface MetadataCatalogConfig {
|
|
3681
4101
|
/**
|
|
4102
|
+
* @public
|
|
3682
4103
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs your data with
|
|
3683
4104
|
* the Glue Data Catalog.</p>
|
|
3684
4105
|
*/
|
|
@@ -3691,6 +4112,7 @@ export interface MetadataCatalogConfig {
|
|
|
3691
4112
|
*/
|
|
3692
4113
|
export interface IncrementalPullConfig {
|
|
3693
4114
|
/**
|
|
4115
|
+
* @public
|
|
3694
4116
|
* <p> A field that specifies the date time or timestamp field as the criteria to use when
|
|
3695
4117
|
* importing incremental records from the source. </p>
|
|
3696
4118
|
*/
|
|
@@ -3703,14 +4125,17 @@ export interface IncrementalPullConfig {
|
|
|
3703
4125
|
*/
|
|
3704
4126
|
export interface CustomConnectorSourceProperties {
|
|
3705
4127
|
/**
|
|
4128
|
+
* @public
|
|
3706
4129
|
* <p>The entity specified in the custom connector as a source in the flow.</p>
|
|
3707
4130
|
*/
|
|
3708
4131
|
entityName: string | undefined;
|
|
3709
4132
|
/**
|
|
4133
|
+
* @public
|
|
3710
4134
|
* <p>Custom properties that are required to use the custom connector as a source.</p>
|
|
3711
4135
|
*/
|
|
3712
4136
|
customProperties?: Record<string, string>;
|
|
3713
4137
|
/**
|
|
4138
|
+
* @public
|
|
3714
4139
|
* <p>The API of the connector application that Amazon AppFlow uses to transfer your
|
|
3715
4140
|
* data.</p>
|
|
3716
4141
|
*/
|
|
@@ -3722,6 +4147,7 @@ export interface CustomConnectorSourceProperties {
|
|
|
3722
4147
|
*/
|
|
3723
4148
|
export interface DatadogSourceProperties {
|
|
3724
4149
|
/**
|
|
4150
|
+
* @public
|
|
3725
4151
|
* <p> The object specified in the Datadog flow source. </p>
|
|
3726
4152
|
*/
|
|
3727
4153
|
object: string | undefined;
|
|
@@ -3732,6 +4158,7 @@ export interface DatadogSourceProperties {
|
|
|
3732
4158
|
*/
|
|
3733
4159
|
export interface DynatraceSourceProperties {
|
|
3734
4160
|
/**
|
|
4161
|
+
* @public
|
|
3735
4162
|
* <p> The object specified in the Dynatrace flow source. </p>
|
|
3736
4163
|
*/
|
|
3737
4164
|
object: string | undefined;
|
|
@@ -3742,6 +4169,7 @@ export interface DynatraceSourceProperties {
|
|
|
3742
4169
|
*/
|
|
3743
4170
|
export interface GoogleAnalyticsSourceProperties {
|
|
3744
4171
|
/**
|
|
4172
|
+
* @public
|
|
3745
4173
|
* <p> The object specified in the Google Analytics flow source. </p>
|
|
3746
4174
|
*/
|
|
3747
4175
|
object: string | undefined;
|
|
@@ -3752,6 +4180,7 @@ export interface GoogleAnalyticsSourceProperties {
|
|
|
3752
4180
|
*/
|
|
3753
4181
|
export interface InforNexusSourceProperties {
|
|
3754
4182
|
/**
|
|
4183
|
+
* @public
|
|
3755
4184
|
* <p> The object specified in the Infor Nexus flow source. </p>
|
|
3756
4185
|
*/
|
|
3757
4186
|
object: string | undefined;
|
|
@@ -3762,6 +4191,7 @@ export interface InforNexusSourceProperties {
|
|
|
3762
4191
|
*/
|
|
3763
4192
|
export interface MarketoSourceProperties {
|
|
3764
4193
|
/**
|
|
4194
|
+
* @public
|
|
3765
4195
|
* <p> The object specified in the Marketo flow source. </p>
|
|
3766
4196
|
*/
|
|
3767
4197
|
object: string | undefined;
|
|
@@ -3772,6 +4202,7 @@ export interface MarketoSourceProperties {
|
|
|
3772
4202
|
*/
|
|
3773
4203
|
export interface PardotSourceProperties {
|
|
3774
4204
|
/**
|
|
4205
|
+
* @public
|
|
3775
4206
|
* <p>The object specified in the Salesforce Pardot flow source.</p>
|
|
3776
4207
|
*/
|
|
3777
4208
|
object: string | undefined;
|
|
@@ -3795,6 +4226,7 @@ export type S3InputFileType = (typeof S3InputFileType)[keyof typeof S3InputFileT
|
|
|
3795
4226
|
*/
|
|
3796
4227
|
export interface S3InputFormatConfig {
|
|
3797
4228
|
/**
|
|
4229
|
+
* @public
|
|
3798
4230
|
* <p> The file type that Amazon AppFlow gets from your Amazon S3 bucket. </p>
|
|
3799
4231
|
*/
|
|
3800
4232
|
s3InputFileType?: S3InputFileType | string;
|
|
@@ -3806,15 +4238,18 @@ export interface S3InputFormatConfig {
|
|
|
3806
4238
|
*/
|
|
3807
4239
|
export interface S3SourceProperties {
|
|
3808
4240
|
/**
|
|
4241
|
+
* @public
|
|
3809
4242
|
* <p> The Amazon S3 bucket name where the source files are stored. </p>
|
|
3810
4243
|
*/
|
|
3811
4244
|
bucketName: string | undefined;
|
|
3812
4245
|
/**
|
|
4246
|
+
* @public
|
|
3813
4247
|
* <p> The object key for the Amazon S3 bucket in which the source files are stored.
|
|
3814
4248
|
* </p>
|
|
3815
4249
|
*/
|
|
3816
4250
|
bucketPrefix?: string;
|
|
3817
4251
|
/**
|
|
4252
|
+
* @public
|
|
3818
4253
|
* <p> When you use Amazon S3 as the source, the configuration format that you provide
|
|
3819
4254
|
* the flow input data. </p>
|
|
3820
4255
|
*/
|
|
@@ -3826,19 +4261,23 @@ export interface S3SourceProperties {
|
|
|
3826
4261
|
*/
|
|
3827
4262
|
export interface SalesforceSourceProperties {
|
|
3828
4263
|
/**
|
|
4264
|
+
* @public
|
|
3829
4265
|
* <p> The object specified in the Salesforce flow source. </p>
|
|
3830
4266
|
*/
|
|
3831
4267
|
object: string | undefined;
|
|
3832
4268
|
/**
|
|
4269
|
+
* @public
|
|
3833
4270
|
* <p> The flag that enables dynamic fetching of new (recently added) fields in the Salesforce
|
|
3834
4271
|
* objects while running a flow. </p>
|
|
3835
4272
|
*/
|
|
3836
4273
|
enableDynamicFieldUpdate?: boolean;
|
|
3837
4274
|
/**
|
|
4275
|
+
* @public
|
|
3838
4276
|
* <p> Indicates whether Amazon AppFlow includes deleted files in the flow run. </p>
|
|
3839
4277
|
*/
|
|
3840
4278
|
includeDeletedRecords?: boolean;
|
|
3841
4279
|
/**
|
|
4280
|
+
* @public
|
|
3842
4281
|
* <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
|
|
3843
4282
|
* data from Salesforce.</p>
|
|
3844
4283
|
* <dl>
|
|
@@ -3885,6 +4324,7 @@ export interface SalesforceSourceProperties {
|
|
|
3885
4324
|
*/
|
|
3886
4325
|
export interface SAPODataSourceProperties {
|
|
3887
4326
|
/**
|
|
4327
|
+
* @public
|
|
3888
4328
|
* <p> The object path specified in the SAPOData flow source. </p>
|
|
3889
4329
|
*/
|
|
3890
4330
|
objectPath?: string;
|
|
@@ -3895,6 +4335,7 @@ export interface SAPODataSourceProperties {
|
|
|
3895
4335
|
*/
|
|
3896
4336
|
export interface ServiceNowSourceProperties {
|
|
3897
4337
|
/**
|
|
4338
|
+
* @public
|
|
3898
4339
|
* <p> The object specified in the ServiceNow flow source. </p>
|
|
3899
4340
|
*/
|
|
3900
4341
|
object: string | undefined;
|
|
@@ -3905,6 +4346,7 @@ export interface ServiceNowSourceProperties {
|
|
|
3905
4346
|
*/
|
|
3906
4347
|
export interface SingularSourceProperties {
|
|
3907
4348
|
/**
|
|
4349
|
+
* @public
|
|
3908
4350
|
* <p> The object specified in the Singular flow source. </p>
|
|
3909
4351
|
*/
|
|
3910
4352
|
object: string | undefined;
|
|
@@ -3915,6 +4357,7 @@ export interface SingularSourceProperties {
|
|
|
3915
4357
|
*/
|
|
3916
4358
|
export interface SlackSourceProperties {
|
|
3917
4359
|
/**
|
|
4360
|
+
* @public
|
|
3918
4361
|
* <p> The object specified in the Slack flow source. </p>
|
|
3919
4362
|
*/
|
|
3920
4363
|
object: string | undefined;
|
|
@@ -3925,6 +4368,7 @@ export interface SlackSourceProperties {
|
|
|
3925
4368
|
*/
|
|
3926
4369
|
export interface TrendmicroSourceProperties {
|
|
3927
4370
|
/**
|
|
4371
|
+
* @public
|
|
3928
4372
|
* <p> The object specified in the Trend Micro flow source. </p>
|
|
3929
4373
|
*/
|
|
3930
4374
|
object: string | undefined;
|
|
@@ -3935,22 +4379,27 @@ export interface TrendmicroSourceProperties {
|
|
|
3935
4379
|
*/
|
|
3936
4380
|
export interface VeevaSourceProperties {
|
|
3937
4381
|
/**
|
|
4382
|
+
* @public
|
|
3938
4383
|
* <p> The object specified in the Veeva flow source. </p>
|
|
3939
4384
|
*/
|
|
3940
4385
|
object: string | undefined;
|
|
3941
4386
|
/**
|
|
4387
|
+
* @public
|
|
3942
4388
|
* <p>The document type specified in the Veeva document extract flow.</p>
|
|
3943
4389
|
*/
|
|
3944
4390
|
documentType?: string;
|
|
3945
4391
|
/**
|
|
4392
|
+
* @public
|
|
3946
4393
|
* <p>Boolean value to include source files in Veeva document extract flow.</p>
|
|
3947
4394
|
*/
|
|
3948
4395
|
includeSourceFiles?: boolean;
|
|
3949
4396
|
/**
|
|
4397
|
+
* @public
|
|
3950
4398
|
* <p>Boolean value to include file renditions in Veeva document extract flow.</p>
|
|
3951
4399
|
*/
|
|
3952
4400
|
includeRenditions?: boolean;
|
|
3953
4401
|
/**
|
|
4402
|
+
* @public
|
|
3954
4403
|
* <p>Boolean value to include All Versions of files in Veeva document extract flow.</p>
|
|
3955
4404
|
*/
|
|
3956
4405
|
includeAllVersions?: boolean;
|
|
@@ -3961,6 +4410,7 @@ export interface VeevaSourceProperties {
|
|
|
3961
4410
|
*/
|
|
3962
4411
|
export interface ZendeskSourceProperties {
|
|
3963
4412
|
/**
|
|
4413
|
+
* @public
|
|
3964
4414
|
* <p> The object specified in the Zendesk flow source. </p>
|
|
3965
4415
|
*/
|
|
3966
4416
|
object: string | undefined;
|
|
@@ -3971,71 +4421,88 @@ export interface ZendeskSourceProperties {
|
|
|
3971
4421
|
*/
|
|
3972
4422
|
export interface SourceConnectorProperties {
|
|
3973
4423
|
/**
|
|
4424
|
+
* @public
|
|
3974
4425
|
* <p> Specifies the information that is required for querying Amplitude. </p>
|
|
3975
4426
|
*/
|
|
3976
4427
|
Amplitude?: AmplitudeSourceProperties;
|
|
3977
4428
|
/**
|
|
4429
|
+
* @public
|
|
3978
4430
|
* <p> Specifies the information that is required for querying Datadog. </p>
|
|
3979
4431
|
*/
|
|
3980
4432
|
Datadog?: DatadogSourceProperties;
|
|
3981
4433
|
/**
|
|
4434
|
+
* @public
|
|
3982
4435
|
* <p> Specifies the information that is required for querying Dynatrace. </p>
|
|
3983
4436
|
*/
|
|
3984
4437
|
Dynatrace?: DynatraceSourceProperties;
|
|
3985
4438
|
/**
|
|
4439
|
+
* @public
|
|
3986
4440
|
* <p> Specifies the information that is required for querying Google Analytics. </p>
|
|
3987
4441
|
*/
|
|
3988
4442
|
GoogleAnalytics?: GoogleAnalyticsSourceProperties;
|
|
3989
4443
|
/**
|
|
4444
|
+
* @public
|
|
3990
4445
|
* <p> Specifies the information that is required for querying Infor Nexus. </p>
|
|
3991
4446
|
*/
|
|
3992
4447
|
InforNexus?: InforNexusSourceProperties;
|
|
3993
4448
|
/**
|
|
4449
|
+
* @public
|
|
3994
4450
|
* <p> Specifies the information that is required for querying Marketo. </p>
|
|
3995
4451
|
*/
|
|
3996
4452
|
Marketo?: MarketoSourceProperties;
|
|
3997
4453
|
/**
|
|
4454
|
+
* @public
|
|
3998
4455
|
* <p> Specifies the information that is required for querying Amazon S3. </p>
|
|
3999
4456
|
*/
|
|
4000
4457
|
S3?: S3SourceProperties;
|
|
4001
4458
|
/**
|
|
4459
|
+
* @public
|
|
4002
4460
|
* <p> Specifies the information that is required for querying Salesforce. </p>
|
|
4003
4461
|
*/
|
|
4004
4462
|
Salesforce?: SalesforceSourceProperties;
|
|
4005
4463
|
/**
|
|
4464
|
+
* @public
|
|
4006
4465
|
* <p> Specifies the information that is required for querying ServiceNow. </p>
|
|
4007
4466
|
*/
|
|
4008
4467
|
ServiceNow?: ServiceNowSourceProperties;
|
|
4009
4468
|
/**
|
|
4469
|
+
* @public
|
|
4010
4470
|
* <p> Specifies the information that is required for querying Singular. </p>
|
|
4011
4471
|
*/
|
|
4012
4472
|
Singular?: SingularSourceProperties;
|
|
4013
4473
|
/**
|
|
4474
|
+
* @public
|
|
4014
4475
|
* <p> Specifies the information that is required for querying Slack. </p>
|
|
4015
4476
|
*/
|
|
4016
4477
|
Slack?: SlackSourceProperties;
|
|
4017
4478
|
/**
|
|
4479
|
+
* @public
|
|
4018
4480
|
* <p> Specifies the information that is required for querying Trend Micro. </p>
|
|
4019
4481
|
*/
|
|
4020
4482
|
Trendmicro?: TrendmicroSourceProperties;
|
|
4021
4483
|
/**
|
|
4484
|
+
* @public
|
|
4022
4485
|
* <p> Specifies the information that is required for querying Veeva. </p>
|
|
4023
4486
|
*/
|
|
4024
4487
|
Veeva?: VeevaSourceProperties;
|
|
4025
4488
|
/**
|
|
4489
|
+
* @public
|
|
4026
4490
|
* <p> Specifies the information that is required for querying Zendesk. </p>
|
|
4027
4491
|
*/
|
|
4028
4492
|
Zendesk?: ZendeskSourceProperties;
|
|
4029
4493
|
/**
|
|
4494
|
+
* @public
|
|
4030
4495
|
* <p> The properties that are applied when using SAPOData as a flow source. </p>
|
|
4031
4496
|
*/
|
|
4032
4497
|
SAPOData?: SAPODataSourceProperties;
|
|
4033
4498
|
/**
|
|
4499
|
+
* @public
|
|
4034
4500
|
* <p>The properties that are applied when the custom connector is being used as a
|
|
4035
4501
|
* source.</p>
|
|
4036
4502
|
*/
|
|
4037
4503
|
CustomConnector?: CustomConnectorSourceProperties;
|
|
4038
4504
|
/**
|
|
4505
|
+
* @public
|
|
4039
4506
|
* <p>Specifies the information that is required for querying Salesforce Pardot.</p>
|
|
4040
4507
|
*/
|
|
4041
4508
|
Pardot?: PardotSourceProperties;
|
|
@@ -4047,24 +4514,29 @@ export interface SourceConnectorProperties {
|
|
|
4047
4514
|
*/
|
|
4048
4515
|
export interface SourceFlowConfig {
|
|
4049
4516
|
/**
|
|
4517
|
+
* @public
|
|
4050
4518
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
4051
4519
|
*/
|
|
4052
4520
|
connectorType: ConnectorType | string | undefined;
|
|
4053
4521
|
/**
|
|
4522
|
+
* @public
|
|
4054
4523
|
* <p>The API version of the connector when it's used as a source in the flow.</p>
|
|
4055
4524
|
*/
|
|
4056
4525
|
apiVersion?: string;
|
|
4057
4526
|
/**
|
|
4527
|
+
* @public
|
|
4058
4528
|
* <p> The name of the connector profile. This name must be unique for each connector profile in
|
|
4059
4529
|
* the Amazon Web Services account. </p>
|
|
4060
4530
|
*/
|
|
4061
4531
|
connectorProfileName?: string;
|
|
4062
4532
|
/**
|
|
4533
|
+
* @public
|
|
4063
4534
|
* <p> Specifies the information that is required to query a particular source connector.
|
|
4064
4535
|
* </p>
|
|
4065
4536
|
*/
|
|
4066
4537
|
sourceConnectorProperties: SourceConnectorProperties | undefined;
|
|
4067
4538
|
/**
|
|
4539
|
+
* @public
|
|
4068
4540
|
* <p> Defines the configuration for a scheduled incremental data pull. If a valid configuration
|
|
4069
4541
|
* is provided, the fields specified in the configuration are used when querying for the
|
|
4070
4542
|
* incremental data pull. </p>
|
|
@@ -4125,23 +4597,28 @@ export type TaskType = (typeof TaskType)[keyof typeof TaskType];
|
|
|
4125
4597
|
*/
|
|
4126
4598
|
export interface Task {
|
|
4127
4599
|
/**
|
|
4600
|
+
* @public
|
|
4128
4601
|
* <p> The source fields to which a particular task is applied. </p>
|
|
4129
4602
|
*/
|
|
4130
4603
|
sourceFields: string[] | undefined;
|
|
4131
4604
|
/**
|
|
4605
|
+
* @public
|
|
4132
4606
|
* <p> The operation to be performed on the provided source fields. </p>
|
|
4133
4607
|
*/
|
|
4134
4608
|
connectorOperator?: ConnectorOperator;
|
|
4135
4609
|
/**
|
|
4610
|
+
* @public
|
|
4136
4611
|
* <p> A field in a destination connector, or a field value against which Amazon AppFlow
|
|
4137
4612
|
* validates a source field. </p>
|
|
4138
4613
|
*/
|
|
4139
4614
|
destinationField?: string;
|
|
4140
4615
|
/**
|
|
4616
|
+
* @public
|
|
4141
4617
|
* <p> Specifies the particular task implementation that Amazon AppFlow performs. </p>
|
|
4142
4618
|
*/
|
|
4143
4619
|
taskType: TaskType | string | undefined;
|
|
4144
4620
|
/**
|
|
4621
|
+
* @public
|
|
4145
4622
|
* <p> A map used to store task-related information. The execution service looks for particular
|
|
4146
4623
|
* information based on the <code>TaskType</code>. </p>
|
|
4147
4624
|
*/
|
|
@@ -4166,26 +4643,31 @@ export type DataPullMode = (typeof DataPullMode)[keyof typeof DataPullMode];
|
|
|
4166
4643
|
*/
|
|
4167
4644
|
export interface ScheduledTriggerProperties {
|
|
4168
4645
|
/**
|
|
4646
|
+
* @public
|
|
4169
4647
|
* <p> The scheduling expression that determines the rate at which the schedule will run, for
|
|
4170
4648
|
* example <code>rate(5minutes)</code>. </p>
|
|
4171
4649
|
*/
|
|
4172
4650
|
scheduleExpression: string | undefined;
|
|
4173
4651
|
/**
|
|
4652
|
+
* @public
|
|
4174
4653
|
* <p> Specifies whether a scheduled flow has an incremental data transfer or a complete data
|
|
4175
4654
|
* transfer for each flow run. </p>
|
|
4176
4655
|
*/
|
|
4177
4656
|
dataPullMode?: DataPullMode | string;
|
|
4178
4657
|
/**
|
|
4658
|
+
* @public
|
|
4179
4659
|
* <p>The time at which the scheduled flow starts. The time is formatted as a timestamp that
|
|
4180
4660
|
* follows the ISO 8601 standard, such as <code>2022-04-26T13:00:00-07:00</code>.</p>
|
|
4181
4661
|
*/
|
|
4182
4662
|
scheduleStartTime?: Date;
|
|
4183
4663
|
/**
|
|
4664
|
+
* @public
|
|
4184
4665
|
* <p>The time at which the scheduled flow ends. The time is formatted as a timestamp that
|
|
4185
4666
|
* follows the ISO 8601 standard, such as <code>2022-04-27T13:00:00-07:00</code>.</p>
|
|
4186
4667
|
*/
|
|
4187
4668
|
scheduleEndTime?: Date;
|
|
4188
4669
|
/**
|
|
4670
|
+
* @public
|
|
4189
4671
|
* <p>Specifies the time zone used when referring to the dates and times of a scheduled flow,
|
|
4190
4672
|
* such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't
|
|
4191
4673
|
* affect how Amazon AppFlow interprets the timestamps that you specify to schedule the
|
|
@@ -4197,16 +4679,19 @@ export interface ScheduledTriggerProperties {
|
|
|
4197
4679
|
*/
|
|
4198
4680
|
timezone?: string;
|
|
4199
4681
|
/**
|
|
4682
|
+
* @public
|
|
4200
4683
|
* <p> Specifies the optional offset that is added to the time interval for a schedule-triggered
|
|
4201
4684
|
* flow. </p>
|
|
4202
4685
|
*/
|
|
4203
4686
|
scheduleOffset?: number;
|
|
4204
4687
|
/**
|
|
4688
|
+
* @public
|
|
4205
4689
|
* <p> Specifies the date range for the records to import from the connector in the first flow
|
|
4206
4690
|
* run. </p>
|
|
4207
4691
|
*/
|
|
4208
4692
|
firstExecutionFrom?: Date;
|
|
4209
4693
|
/**
|
|
4694
|
+
* @public
|
|
4210
4695
|
* <p>Defines how many times a scheduled flow fails consecutively before Amazon AppFlow
|
|
4211
4696
|
* deactivates it.</p>
|
|
4212
4697
|
*/
|
|
@@ -4219,6 +4704,7 @@ export interface ScheduledTriggerProperties {
|
|
|
4219
4704
|
*/
|
|
4220
4705
|
export interface TriggerProperties {
|
|
4221
4706
|
/**
|
|
4707
|
+
* @public
|
|
4222
4708
|
* <p> Specifies the configuration details of a schedule-triggered flow as defined by the user.
|
|
4223
4709
|
* </p>
|
|
4224
4710
|
*/
|
|
@@ -4231,11 +4717,13 @@ export interface TriggerProperties {
|
|
|
4231
4717
|
*/
|
|
4232
4718
|
export interface TriggerConfig {
|
|
4233
4719
|
/**
|
|
4720
|
+
* @public
|
|
4234
4721
|
* <p> Specifies the type of flow trigger. This can be <code>OnDemand</code>,
|
|
4235
4722
|
* <code>Scheduled</code>, or <code>Event</code>. </p>
|
|
4236
4723
|
*/
|
|
4237
4724
|
triggerType: TriggerType | string | undefined;
|
|
4238
4725
|
/**
|
|
4726
|
+
* @public
|
|
4239
4727
|
* <p> Specifies the configuration details of a schedule-triggered flow as defined by the user.
|
|
4240
4728
|
* Currently, these settings only apply to the <code>Scheduled</code> trigger type. </p>
|
|
4241
4729
|
*/
|
|
@@ -4246,50 +4734,60 @@ export interface TriggerConfig {
|
|
|
4246
4734
|
*/
|
|
4247
4735
|
export interface CreateFlowRequest {
|
|
4248
4736
|
/**
|
|
4737
|
+
* @public
|
|
4249
4738
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4250
4739
|
* (-) only. </p>
|
|
4251
4740
|
*/
|
|
4252
4741
|
flowName: string | undefined;
|
|
4253
4742
|
/**
|
|
4743
|
+
* @public
|
|
4254
4744
|
* <p> A description of the flow you want to create. </p>
|
|
4255
4745
|
*/
|
|
4256
4746
|
description?: string;
|
|
4257
4747
|
/**
|
|
4748
|
+
* @public
|
|
4258
4749
|
* <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
|
|
4259
4750
|
* encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS
|
|
4260
4751
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
4261
4752
|
*/
|
|
4262
4753
|
kmsArn?: string;
|
|
4263
4754
|
/**
|
|
4755
|
+
* @public
|
|
4264
4756
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
4265
4757
|
*/
|
|
4266
4758
|
triggerConfig: TriggerConfig | undefined;
|
|
4267
4759
|
/**
|
|
4760
|
+
* @public
|
|
4268
4761
|
* <p> The configuration that controls how Amazon AppFlow retrieves data from the source
|
|
4269
4762
|
* connector. </p>
|
|
4270
4763
|
*/
|
|
4271
4764
|
sourceFlowConfig: SourceFlowConfig | undefined;
|
|
4272
4765
|
/**
|
|
4766
|
+
* @public
|
|
4273
4767
|
* <p> The configuration that controls how Amazon AppFlow places data in the destination
|
|
4274
4768
|
* connector. </p>
|
|
4275
4769
|
*/
|
|
4276
4770
|
destinationFlowConfigList: DestinationFlowConfig[] | undefined;
|
|
4277
4771
|
/**
|
|
4772
|
+
* @public
|
|
4278
4773
|
* <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow
|
|
4279
4774
|
* run. </p>
|
|
4280
4775
|
*/
|
|
4281
4776
|
tasks: Task[] | undefined;
|
|
4282
4777
|
/**
|
|
4778
|
+
* @public
|
|
4283
4779
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
4284
4780
|
*/
|
|
4285
4781
|
tags?: Record<string, string>;
|
|
4286
4782
|
/**
|
|
4783
|
+
* @public
|
|
4287
4784
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
|
|
4288
4785
|
* transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
|
|
4289
4786
|
* stores metadata in a data catalog.</p>
|
|
4290
4787
|
*/
|
|
4291
4788
|
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
4292
4789
|
/**
|
|
4790
|
+
* @public
|
|
4293
4791
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
4294
4792
|
* <code>CreateFlow</code> request completes only once. You choose the value to pass. For
|
|
4295
4793
|
* example, if you don't receive a response from your request, you can safely retry the request
|
|
@@ -4324,10 +4822,12 @@ export type FlowStatus = (typeof FlowStatus)[keyof typeof FlowStatus];
|
|
|
4324
4822
|
*/
|
|
4325
4823
|
export interface CreateFlowResponse {
|
|
4326
4824
|
/**
|
|
4825
|
+
* @public
|
|
4327
4826
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
4328
4827
|
*/
|
|
4329
4828
|
flowArn?: string;
|
|
4330
4829
|
/**
|
|
4830
|
+
* @public
|
|
4331
4831
|
* <p> Indicates the current status of the flow. </p>
|
|
4332
4832
|
*/
|
|
4333
4833
|
flowStatus?: FlowStatus | string;
|
|
@@ -4337,11 +4837,13 @@ export interface CreateFlowResponse {
|
|
|
4337
4837
|
*/
|
|
4338
4838
|
export interface DeleteConnectorProfileRequest {
|
|
4339
4839
|
/**
|
|
4840
|
+
* @public
|
|
4340
4841
|
* <p> The name of the connector profile. The name is unique for each
|
|
4341
4842
|
* <code>ConnectorProfile</code> in your account. </p>
|
|
4342
4843
|
*/
|
|
4343
4844
|
connectorProfileName: string | undefined;
|
|
4344
4845
|
/**
|
|
4846
|
+
* @public
|
|
4345
4847
|
* <p> Indicates whether Amazon AppFlow should delete the profile, even if it is currently
|
|
4346
4848
|
* in use in one or more flows. </p>
|
|
4347
4849
|
*/
|
|
@@ -4357,11 +4859,13 @@ export interface DeleteConnectorProfileResponse {
|
|
|
4357
4859
|
*/
|
|
4358
4860
|
export interface DeleteFlowRequest {
|
|
4359
4861
|
/**
|
|
4862
|
+
* @public
|
|
4360
4863
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4361
4864
|
* (-) only. </p>
|
|
4362
4865
|
*/
|
|
4363
4866
|
flowName: string | undefined;
|
|
4364
4867
|
/**
|
|
4868
|
+
* @public
|
|
4365
4869
|
* <p> Indicates whether Amazon AppFlow should delete the flow, even if it is currently in
|
|
4366
4870
|
* use. </p>
|
|
4367
4871
|
*/
|
|
@@ -4377,11 +4881,13 @@ export interface DeleteFlowResponse {
|
|
|
4377
4881
|
*/
|
|
4378
4882
|
export interface DescribeConnectorRequest {
|
|
4379
4883
|
/**
|
|
4884
|
+
* @public
|
|
4380
4885
|
* <p>The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose
|
|
4381
4886
|
* CUSTOMCONNECTOR for Lambda based custom connectors.</p>
|
|
4382
4887
|
*/
|
|
4383
4888
|
connectorType: ConnectorType | string | undefined;
|
|
4384
4889
|
/**
|
|
4890
|
+
* @public
|
|
4385
4891
|
* <p>The label of the connector. The label is unique for each
|
|
4386
4892
|
* <code>ConnectorRegistration</code> in your Amazon Web Services account. Only needed if
|
|
4387
4893
|
* calling for CUSTOMCONNECTOR connector type/.</p>
|
|
@@ -4393,6 +4899,7 @@ export interface DescribeConnectorRequest {
|
|
|
4393
4899
|
*/
|
|
4394
4900
|
export interface DescribeConnectorResponse {
|
|
4395
4901
|
/**
|
|
4902
|
+
* @public
|
|
4396
4903
|
* <p>Configuration info of all the connectors that the user requested.</p>
|
|
4397
4904
|
*/
|
|
4398
4905
|
connectorConfiguration?: ConnectorConfiguration;
|
|
@@ -4402,19 +4909,23 @@ export interface DescribeConnectorResponse {
|
|
|
4402
4909
|
*/
|
|
4403
4910
|
export interface DescribeConnectorEntityRequest {
|
|
4404
4911
|
/**
|
|
4912
|
+
* @public
|
|
4405
4913
|
* <p> The entity name for that connector. </p>
|
|
4406
4914
|
*/
|
|
4407
4915
|
connectorEntityName: string | undefined;
|
|
4408
4916
|
/**
|
|
4917
|
+
* @public
|
|
4409
4918
|
* <p> The type of connector application, such as Salesforce, Amplitude, and so on. </p>
|
|
4410
4919
|
*/
|
|
4411
4920
|
connectorType?: ConnectorType | string;
|
|
4412
4921
|
/**
|
|
4922
|
+
* @public
|
|
4413
4923
|
* <p> The name of the connector profile. The name is unique for each
|
|
4414
4924
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
4415
4925
|
*/
|
|
4416
4926
|
connectorProfileName?: string;
|
|
4417
4927
|
/**
|
|
4928
|
+
* @public
|
|
4418
4929
|
* <p>The version of the API that's used by the connector.</p>
|
|
4419
4930
|
*/
|
|
4420
4931
|
apiVersion?: string;
|
|
@@ -4424,6 +4935,7 @@ export interface DescribeConnectorEntityRequest {
|
|
|
4424
4935
|
*/
|
|
4425
4936
|
export interface DescribeConnectorEntityResponse {
|
|
4426
4937
|
/**
|
|
4938
|
+
* @public
|
|
4427
4939
|
* <p> Describes the fields for that connector entity. For example, for an
|
|
4428
4940
|
* <i>account</i> entity, the fields would be <i>account name</i>,
|
|
4429
4941
|
* <i>account ID</i>, and so on. </p>
|
|
@@ -4435,26 +4947,31 @@ export interface DescribeConnectorEntityResponse {
|
|
|
4435
4947
|
*/
|
|
4436
4948
|
export interface DescribeConnectorProfilesRequest {
|
|
4437
4949
|
/**
|
|
4950
|
+
* @public
|
|
4438
4951
|
* <p> The name of the connector profile. The name is unique for each
|
|
4439
4952
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
4440
4953
|
*/
|
|
4441
4954
|
connectorProfileNames?: string[];
|
|
4442
4955
|
/**
|
|
4956
|
+
* @public
|
|
4443
4957
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
4444
4958
|
*/
|
|
4445
4959
|
connectorType?: ConnectorType | string;
|
|
4446
4960
|
/**
|
|
4961
|
+
* @public
|
|
4447
4962
|
* <p>The name of the connector. The name is unique for each <code>ConnectorRegistration</code>
|
|
4448
4963
|
* in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector
|
|
4449
4964
|
* type/.</p>
|
|
4450
4965
|
*/
|
|
4451
4966
|
connectorLabel?: string;
|
|
4452
4967
|
/**
|
|
4968
|
+
* @public
|
|
4453
4969
|
* <p> Specifies the maximum number of items that should be returned in the result set. The
|
|
4454
4970
|
* default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
|
|
4455
4971
|
*/
|
|
4456
4972
|
maxResults?: number;
|
|
4457
4973
|
/**
|
|
4974
|
+
* @public
|
|
4458
4975
|
* <p> The pagination token for the next page of data. </p>
|
|
4459
4976
|
*/
|
|
4460
4977
|
nextToken?: string;
|
|
@@ -4464,10 +4981,12 @@ export interface DescribeConnectorProfilesRequest {
|
|
|
4464
4981
|
*/
|
|
4465
4982
|
export interface DescribeConnectorProfilesResponse {
|
|
4466
4983
|
/**
|
|
4984
|
+
* @public
|
|
4467
4985
|
* <p> Returns information about the connector profiles associated with the flow. </p>
|
|
4468
4986
|
*/
|
|
4469
4987
|
connectorProfileDetails?: ConnectorProfile[];
|
|
4470
4988
|
/**
|
|
4989
|
+
* @public
|
|
4471
4990
|
* <p> The pagination token for the next page of data. If <code>nextToken=null</code>, this
|
|
4472
4991
|
* means that all records have been fetched. </p>
|
|
4473
4992
|
*/
|
|
@@ -4478,15 +4997,18 @@ export interface DescribeConnectorProfilesResponse {
|
|
|
4478
4997
|
*/
|
|
4479
4998
|
export interface DescribeConnectorsRequest {
|
|
4480
4999
|
/**
|
|
5000
|
+
* @public
|
|
4481
5001
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
4482
5002
|
*/
|
|
4483
5003
|
connectorTypes?: (ConnectorType | string)[];
|
|
4484
5004
|
/**
|
|
5005
|
+
* @public
|
|
4485
5006
|
* <p>The maximum number of items that should be returned in the result set. The default is
|
|
4486
5007
|
* 20.</p>
|
|
4487
5008
|
*/
|
|
4488
5009
|
maxResults?: number;
|
|
4489
5010
|
/**
|
|
5011
|
+
* @public
|
|
4490
5012
|
* <p> The pagination token for the next page of data. </p>
|
|
4491
5013
|
*/
|
|
4492
5014
|
nextToken?: string;
|
|
@@ -4496,14 +5018,17 @@ export interface DescribeConnectorsRequest {
|
|
|
4496
5018
|
*/
|
|
4497
5019
|
export interface DescribeConnectorsResponse {
|
|
4498
5020
|
/**
|
|
5021
|
+
* @public
|
|
4499
5022
|
* <p> The configuration that is applied to the connectors used in the flow. </p>
|
|
4500
5023
|
*/
|
|
4501
5024
|
connectorConfigurations?: Record<string, ConnectorConfiguration>;
|
|
4502
5025
|
/**
|
|
5026
|
+
* @public
|
|
4503
5027
|
* <p>Information about the connectors supported in Amazon AppFlow.</p>
|
|
4504
5028
|
*/
|
|
4505
5029
|
connectors?: ConnectorDetail[];
|
|
4506
5030
|
/**
|
|
5031
|
+
* @public
|
|
4507
5032
|
* <p> The pagination token for the next page of data. </p>
|
|
4508
5033
|
*/
|
|
4509
5034
|
nextToken?: string;
|
|
@@ -4513,6 +5038,7 @@ export interface DescribeConnectorsResponse {
|
|
|
4513
5038
|
*/
|
|
4514
5039
|
export interface DescribeFlowRequest {
|
|
4515
5040
|
/**
|
|
5041
|
+
* @public
|
|
4516
5042
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4517
5043
|
* (-) only. </p>
|
|
4518
5044
|
*/
|
|
@@ -4540,14 +5066,17 @@ export type ExecutionStatus = (typeof ExecutionStatus)[keyof typeof ExecutionSta
|
|
|
4540
5066
|
*/
|
|
4541
5067
|
export interface ExecutionDetails {
|
|
4542
5068
|
/**
|
|
5069
|
+
* @public
|
|
4543
5070
|
* <p> Describes the details of the most recent flow run. </p>
|
|
4544
5071
|
*/
|
|
4545
5072
|
mostRecentExecutionMessage?: string;
|
|
4546
5073
|
/**
|
|
5074
|
+
* @public
|
|
4547
5075
|
* <p> Specifies the time of the most recent flow run. </p>
|
|
4548
5076
|
*/
|
|
4549
5077
|
mostRecentExecutionTime?: Date;
|
|
4550
5078
|
/**
|
|
5079
|
+
* @public
|
|
4551
5080
|
* <p> Specifies the status of the most recent flow run. </p>
|
|
4552
5081
|
*/
|
|
4553
5082
|
mostRecentExecutionStatus?: ExecutionStatus | string;
|
|
@@ -4562,16 +5091,19 @@ export interface ExecutionDetails {
|
|
|
4562
5091
|
*/
|
|
4563
5092
|
export interface RegistrationOutput {
|
|
4564
5093
|
/**
|
|
5094
|
+
* @public
|
|
4565
5095
|
* <p>Explains the status of the registration attempt from Amazon AppFlow. If the attempt
|
|
4566
5096
|
* fails, the message explains why.</p>
|
|
4567
5097
|
*/
|
|
4568
5098
|
message?: string;
|
|
4569
5099
|
/**
|
|
5100
|
+
* @public
|
|
4570
5101
|
* <p>Indicates the number of resources that Amazon AppFlow created or updated. Possible
|
|
4571
5102
|
* resources include metadata tables and data partitions.</p>
|
|
4572
5103
|
*/
|
|
4573
5104
|
result?: string;
|
|
4574
5105
|
/**
|
|
5106
|
+
* @public
|
|
4575
5107
|
* <p>Indicates the status of the registration attempt from Amazon AppFlow.</p>
|
|
4576
5108
|
*/
|
|
4577
5109
|
status?: ExecutionStatus | string;
|
|
@@ -4582,6 +5114,7 @@ export interface RegistrationOutput {
|
|
|
4582
5114
|
*/
|
|
4583
5115
|
export interface MetadataCatalogDetail {
|
|
4584
5116
|
/**
|
|
5117
|
+
* @public
|
|
4585
5118
|
* <p>The type of metadata catalog that Amazon AppFlow used for the associated flow run.
|
|
4586
5119
|
* This parameter returns the following value:</p>
|
|
4587
5120
|
* <dl>
|
|
@@ -4594,18 +5127,21 @@ export interface MetadataCatalogDetail {
|
|
|
4594
5127
|
*/
|
|
4595
5128
|
catalogType?: CatalogType | string;
|
|
4596
5129
|
/**
|
|
5130
|
+
* @public
|
|
4597
5131
|
* <p>The name of the table that stores the metadata for the associated flow run. The table
|
|
4598
5132
|
* stores metadata that represents the data that the flow transferred. Amazon AppFlow stores
|
|
4599
5133
|
* the table in the metadata catalog.</p>
|
|
4600
5134
|
*/
|
|
4601
5135
|
tableName?: string;
|
|
4602
5136
|
/**
|
|
5137
|
+
* @public
|
|
4603
5138
|
* <p>Describes the status of the attempt from Amazon AppFlow to register the metadata
|
|
4604
5139
|
* table with the metadata catalog. Amazon AppFlow creates or updates this table for the
|
|
4605
5140
|
* associated flow run.</p>
|
|
4606
5141
|
*/
|
|
4607
5142
|
tableRegistrationOutput?: RegistrationOutput;
|
|
4608
5143
|
/**
|
|
5144
|
+
* @public
|
|
4609
5145
|
* <p>Describes the status of the attempt from Amazon AppFlow to register the data
|
|
4610
5146
|
* partitions with the metadata catalog. The data partitions organize the flow output into a
|
|
4611
5147
|
* hierarchical path, such as a folder path in an S3 bucket. Amazon AppFlow creates the
|
|
@@ -4618,87 +5154,106 @@ export interface MetadataCatalogDetail {
|
|
|
4618
5154
|
*/
|
|
4619
5155
|
export interface DescribeFlowResponse {
|
|
4620
5156
|
/**
|
|
5157
|
+
* @public
|
|
4621
5158
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
4622
5159
|
*/
|
|
4623
5160
|
flowArn?: string;
|
|
4624
5161
|
/**
|
|
5162
|
+
* @public
|
|
4625
5163
|
* <p> A description of the flow. </p>
|
|
4626
5164
|
*/
|
|
4627
5165
|
description?: string;
|
|
4628
5166
|
/**
|
|
5167
|
+
* @public
|
|
4629
5168
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4630
5169
|
* (-) only. </p>
|
|
4631
5170
|
*/
|
|
4632
5171
|
flowName?: string;
|
|
4633
5172
|
/**
|
|
5173
|
+
* @public
|
|
4634
5174
|
* <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
|
|
4635
5175
|
* encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS
|
|
4636
5176
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
4637
5177
|
*/
|
|
4638
5178
|
kmsArn?: string;
|
|
4639
5179
|
/**
|
|
5180
|
+
* @public
|
|
4640
5181
|
* <p> Indicates the current status of the flow. </p>
|
|
4641
5182
|
*/
|
|
4642
5183
|
flowStatus?: FlowStatus | string;
|
|
4643
5184
|
/**
|
|
5185
|
+
* @public
|
|
4644
5186
|
* <p> Contains an error message if the flow status is in a suspended or error state. This
|
|
4645
5187
|
* applies only to scheduled or event-triggered flows. </p>
|
|
4646
5188
|
*/
|
|
4647
5189
|
flowStatusMessage?: string;
|
|
4648
5190
|
/**
|
|
5191
|
+
* @public
|
|
4649
5192
|
* <p> The configuration that controls how Amazon AppFlow retrieves data from the source
|
|
4650
5193
|
* connector. </p>
|
|
4651
5194
|
*/
|
|
4652
5195
|
sourceFlowConfig?: SourceFlowConfig;
|
|
4653
5196
|
/**
|
|
5197
|
+
* @public
|
|
4654
5198
|
* <p> The configuration that controls how Amazon AppFlow transfers data to the destination
|
|
4655
5199
|
* connector. </p>
|
|
4656
5200
|
*/
|
|
4657
5201
|
destinationFlowConfigList?: DestinationFlowConfig[];
|
|
4658
5202
|
/**
|
|
5203
|
+
* @public
|
|
4659
5204
|
* <p> Describes the details of the most recent flow run. </p>
|
|
4660
5205
|
*/
|
|
4661
5206
|
lastRunExecutionDetails?: ExecutionDetails;
|
|
4662
5207
|
/**
|
|
5208
|
+
* @public
|
|
4663
5209
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
4664
5210
|
*/
|
|
4665
5211
|
triggerConfig?: TriggerConfig;
|
|
4666
5212
|
/**
|
|
5213
|
+
* @public
|
|
4667
5214
|
* <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow
|
|
4668
5215
|
* run. </p>
|
|
4669
5216
|
*/
|
|
4670
5217
|
tasks?: Task[];
|
|
4671
5218
|
/**
|
|
5219
|
+
* @public
|
|
4672
5220
|
* <p> Specifies when the flow was created. </p>
|
|
4673
5221
|
*/
|
|
4674
5222
|
createdAt?: Date;
|
|
4675
5223
|
/**
|
|
5224
|
+
* @public
|
|
4676
5225
|
* <p> Specifies when the flow was last updated. </p>
|
|
4677
5226
|
*/
|
|
4678
5227
|
lastUpdatedAt?: Date;
|
|
4679
5228
|
/**
|
|
5229
|
+
* @public
|
|
4680
5230
|
* <p> The ARN of the user who created the flow. </p>
|
|
4681
5231
|
*/
|
|
4682
5232
|
createdBy?: string;
|
|
4683
5233
|
/**
|
|
5234
|
+
* @public
|
|
4684
5235
|
* <p> Specifies the user name of the account that performed the most recent update. </p>
|
|
4685
5236
|
*/
|
|
4686
5237
|
lastUpdatedBy?: string;
|
|
4687
5238
|
/**
|
|
5239
|
+
* @public
|
|
4688
5240
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
4689
5241
|
*/
|
|
4690
5242
|
tags?: Record<string, string>;
|
|
4691
5243
|
/**
|
|
5244
|
+
* @public
|
|
4692
5245
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
|
|
4693
5246
|
* transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
|
|
4694
5247
|
* stores metadata in a data catalog.</p>
|
|
4695
5248
|
*/
|
|
4696
5249
|
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
4697
5250
|
/**
|
|
5251
|
+
* @public
|
|
4698
5252
|
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
4699
5253
|
*/
|
|
4700
5254
|
lastRunMetadataCatalogDetails?: MetadataCatalogDetail[];
|
|
4701
5255
|
/**
|
|
5256
|
+
* @public
|
|
4702
5257
|
* <p>The version number of your data schema. Amazon AppFlow assigns this version number.
|
|
4703
5258
|
* The version number increases by one when you change any of the following settings in your flow
|
|
4704
5259
|
* configuration:</p>
|
|
@@ -4721,16 +5276,19 @@ export interface DescribeFlowResponse {
|
|
|
4721
5276
|
*/
|
|
4722
5277
|
export interface DescribeFlowExecutionRecordsRequest {
|
|
4723
5278
|
/**
|
|
5279
|
+
* @public
|
|
4724
5280
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4725
5281
|
* (-) only. </p>
|
|
4726
5282
|
*/
|
|
4727
5283
|
flowName: string | undefined;
|
|
4728
5284
|
/**
|
|
5285
|
+
* @public
|
|
4729
5286
|
* <p> Specifies the maximum number of items that should be returned in the result set. The
|
|
4730
5287
|
* default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
|
|
4731
5288
|
*/
|
|
4732
5289
|
maxResults?: number;
|
|
4733
5290
|
/**
|
|
5291
|
+
* @public
|
|
4734
5292
|
* <p> The pagination token for the next page of data. </p>
|
|
4735
5293
|
*/
|
|
4736
5294
|
nextToken?: string;
|
|
@@ -4742,10 +5300,12 @@ export interface DescribeFlowExecutionRecordsRequest {
|
|
|
4742
5300
|
*/
|
|
4743
5301
|
export interface ErrorInfo {
|
|
4744
5302
|
/**
|
|
5303
|
+
* @public
|
|
4745
5304
|
* <p> Specifies the failure count for the attempted flow. </p>
|
|
4746
5305
|
*/
|
|
4747
5306
|
putFailuresCount?: number;
|
|
4748
5307
|
/**
|
|
5308
|
+
* @public
|
|
4749
5309
|
* <p> Specifies the error message that appears if a flow fails. </p>
|
|
4750
5310
|
*/
|
|
4751
5311
|
executionMessage?: string;
|
|
@@ -4756,18 +5316,22 @@ export interface ErrorInfo {
|
|
|
4756
5316
|
*/
|
|
4757
5317
|
export interface ExecutionResult {
|
|
4758
5318
|
/**
|
|
5319
|
+
* @public
|
|
4759
5320
|
* <p> Provides any error message information related to the flow run. </p>
|
|
4760
5321
|
*/
|
|
4761
5322
|
errorInfo?: ErrorInfo;
|
|
4762
5323
|
/**
|
|
5324
|
+
* @public
|
|
4763
5325
|
* <p> The total number of bytes processed by the flow run. </p>
|
|
4764
5326
|
*/
|
|
4765
5327
|
bytesProcessed?: number;
|
|
4766
5328
|
/**
|
|
5329
|
+
* @public
|
|
4767
5330
|
* <p> The total number of bytes written as a result of the flow run. </p>
|
|
4768
5331
|
*/
|
|
4769
5332
|
bytesWritten?: number;
|
|
4770
5333
|
/**
|
|
5334
|
+
* @public
|
|
4771
5335
|
* <p> The number of records processed in the flow run. </p>
|
|
4772
5336
|
*/
|
|
4773
5337
|
recordsProcessed?: number;
|
|
@@ -4778,37 +5342,45 @@ export interface ExecutionResult {
|
|
|
4778
5342
|
*/
|
|
4779
5343
|
export interface ExecutionRecord {
|
|
4780
5344
|
/**
|
|
5345
|
+
* @public
|
|
4781
5346
|
* <p> Specifies the identifier of the given flow run. </p>
|
|
4782
5347
|
*/
|
|
4783
5348
|
executionId?: string;
|
|
4784
5349
|
/**
|
|
5350
|
+
* @public
|
|
4785
5351
|
* <p> Specifies the flow run status and whether it is in progress, has completed successfully,
|
|
4786
5352
|
* or has failed. </p>
|
|
4787
5353
|
*/
|
|
4788
5354
|
executionStatus?: ExecutionStatus | string;
|
|
4789
5355
|
/**
|
|
5356
|
+
* @public
|
|
4790
5357
|
* <p> Describes the result of the given flow run. </p>
|
|
4791
5358
|
*/
|
|
4792
5359
|
executionResult?: ExecutionResult;
|
|
4793
5360
|
/**
|
|
5361
|
+
* @public
|
|
4794
5362
|
* <p> Specifies the start time of the flow run. </p>
|
|
4795
5363
|
*/
|
|
4796
5364
|
startedAt?: Date;
|
|
4797
5365
|
/**
|
|
5366
|
+
* @public
|
|
4798
5367
|
* <p> Specifies the time of the most recent update. </p>
|
|
4799
5368
|
*/
|
|
4800
5369
|
lastUpdatedAt?: Date;
|
|
4801
5370
|
/**
|
|
5371
|
+
* @public
|
|
4802
5372
|
* <p> The timestamp that determines the first new or updated record to be transferred in the
|
|
4803
5373
|
* flow run. </p>
|
|
4804
5374
|
*/
|
|
4805
5375
|
dataPullStartTime?: Date;
|
|
4806
5376
|
/**
|
|
5377
|
+
* @public
|
|
4807
5378
|
* <p> The timestamp that indicates the last new or updated record to be transferred in the flow
|
|
4808
5379
|
* run. </p>
|
|
4809
5380
|
*/
|
|
4810
5381
|
dataPullEndTime?: Date;
|
|
4811
5382
|
/**
|
|
5383
|
+
* @public
|
|
4812
5384
|
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
4813
5385
|
*/
|
|
4814
5386
|
metadataCatalogDetails?: MetadataCatalogDetail[];
|
|
@@ -4818,10 +5390,12 @@ export interface ExecutionRecord {
|
|
|
4818
5390
|
*/
|
|
4819
5391
|
export interface DescribeFlowExecutionRecordsResponse {
|
|
4820
5392
|
/**
|
|
5393
|
+
* @public
|
|
4821
5394
|
* <p> Returns a list of all instances when this flow was run. </p>
|
|
4822
5395
|
*/
|
|
4823
5396
|
flowExecutions?: ExecutionRecord[];
|
|
4824
5397
|
/**
|
|
5398
|
+
* @public
|
|
4825
5399
|
* <p> The pagination token for the next page of data. </p>
|
|
4826
5400
|
*/
|
|
4827
5401
|
nextToken?: string;
|
|
@@ -4833,66 +5407,81 @@ export interface DescribeFlowExecutionRecordsResponse {
|
|
|
4833
5407
|
*/
|
|
4834
5408
|
export interface FlowDefinition {
|
|
4835
5409
|
/**
|
|
5410
|
+
* @public
|
|
4836
5411
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
4837
5412
|
*/
|
|
4838
5413
|
flowArn?: string;
|
|
4839
5414
|
/**
|
|
5415
|
+
* @public
|
|
4840
5416
|
* <p> A user-entered description of the flow. </p>
|
|
4841
5417
|
*/
|
|
4842
5418
|
description?: string;
|
|
4843
5419
|
/**
|
|
5420
|
+
* @public
|
|
4844
5421
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
4845
5422
|
* (-) only. </p>
|
|
4846
5423
|
*/
|
|
4847
5424
|
flowName?: string;
|
|
4848
5425
|
/**
|
|
5426
|
+
* @public
|
|
4849
5427
|
* <p> Indicates the current status of the flow. </p>
|
|
4850
5428
|
*/
|
|
4851
5429
|
flowStatus?: FlowStatus | string;
|
|
4852
5430
|
/**
|
|
5431
|
+
* @public
|
|
4853
5432
|
* <p> Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude,
|
|
4854
5433
|
* and so on. </p>
|
|
4855
5434
|
*/
|
|
4856
5435
|
sourceConnectorType?: ConnectorType | string;
|
|
4857
5436
|
/**
|
|
5437
|
+
* @public
|
|
4858
5438
|
* <p>The label of the source connector in the flow.</p>
|
|
4859
5439
|
*/
|
|
4860
5440
|
sourceConnectorLabel?: string;
|
|
4861
5441
|
/**
|
|
5442
|
+
* @public
|
|
4862
5443
|
* <p> Specifies the destination connector type, such as Salesforce, Amazon S3,
|
|
4863
5444
|
* Amplitude, and so on. </p>
|
|
4864
5445
|
*/
|
|
4865
5446
|
destinationConnectorType?: ConnectorType | string;
|
|
4866
5447
|
/**
|
|
5448
|
+
* @public
|
|
4867
5449
|
* <p>The label of the destination connector in the flow.</p>
|
|
4868
5450
|
*/
|
|
4869
5451
|
destinationConnectorLabel?: string;
|
|
4870
5452
|
/**
|
|
5453
|
+
* @public
|
|
4871
5454
|
* <p> Specifies the type of flow trigger. This can be <code>OnDemand</code>,
|
|
4872
5455
|
* <code>Scheduled</code>, or <code>Event</code>. </p>
|
|
4873
5456
|
*/
|
|
4874
5457
|
triggerType?: TriggerType | string;
|
|
4875
5458
|
/**
|
|
5459
|
+
* @public
|
|
4876
5460
|
* <p> Specifies when the flow was created. </p>
|
|
4877
5461
|
*/
|
|
4878
5462
|
createdAt?: Date;
|
|
4879
5463
|
/**
|
|
5464
|
+
* @public
|
|
4880
5465
|
* <p> Specifies when the flow was last updated. </p>
|
|
4881
5466
|
*/
|
|
4882
5467
|
lastUpdatedAt?: Date;
|
|
4883
5468
|
/**
|
|
5469
|
+
* @public
|
|
4884
5470
|
* <p> The ARN of the user who created the flow. </p>
|
|
4885
5471
|
*/
|
|
4886
5472
|
createdBy?: string;
|
|
4887
5473
|
/**
|
|
5474
|
+
* @public
|
|
4888
5475
|
* <p> Specifies the account user name that most recently updated the flow. </p>
|
|
4889
5476
|
*/
|
|
4890
5477
|
lastUpdatedBy?: string;
|
|
4891
5478
|
/**
|
|
5479
|
+
* @public
|
|
4892
5480
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
4893
5481
|
*/
|
|
4894
5482
|
tags?: Record<string, string>;
|
|
4895
5483
|
/**
|
|
5484
|
+
* @public
|
|
4896
5485
|
* <p> Describes the details of the most recent flow run. </p>
|
|
4897
5486
|
*/
|
|
4898
5487
|
lastRunExecutionDetails?: ExecutionDetails;
|
|
@@ -4902,16 +5491,19 @@ export interface FlowDefinition {
|
|
|
4902
5491
|
*/
|
|
4903
5492
|
export interface ListConnectorEntitiesRequest {
|
|
4904
5493
|
/**
|
|
5494
|
+
* @public
|
|
4905
5495
|
* <p> The name of the connector profile. The name is unique for each
|
|
4906
5496
|
* <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the
|
|
4907
5497
|
* downstream connector. </p>
|
|
4908
5498
|
*/
|
|
4909
5499
|
connectorProfileName?: string;
|
|
4910
5500
|
/**
|
|
5501
|
+
* @public
|
|
4911
5502
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
4912
5503
|
*/
|
|
4913
5504
|
connectorType?: ConnectorType | string;
|
|
4914
5505
|
/**
|
|
5506
|
+
* @public
|
|
4915
5507
|
* <p> This optional parameter is specific to connector implementation. Some connectors support
|
|
4916
5508
|
* multiple levels or categories of entities. You can find out the list of roots for such
|
|
4917
5509
|
* providers by sending a request without the <code>entitiesPath</code> parameter. If the
|
|
@@ -4920,14 +5512,17 @@ export interface ListConnectorEntitiesRequest {
|
|
|
4920
5512
|
*/
|
|
4921
5513
|
entitiesPath?: string;
|
|
4922
5514
|
/**
|
|
5515
|
+
* @public
|
|
4923
5516
|
* <p>The version of the API that's used by the connector.</p>
|
|
4924
5517
|
*/
|
|
4925
5518
|
apiVersion?: string;
|
|
4926
5519
|
/**
|
|
5520
|
+
* @public
|
|
4927
5521
|
* <p>The maximum number of items that the operation returns in the response.</p>
|
|
4928
5522
|
*/
|
|
4929
5523
|
maxResults?: number;
|
|
4930
5524
|
/**
|
|
5525
|
+
* @public
|
|
4931
5526
|
* <p>A token that was provided by your prior <code>ListConnectorEntities</code> operation if
|
|
4932
5527
|
* the response was too big for the page size. You specify this token to get the next page of
|
|
4933
5528
|
* results in paginated response.</p>
|
|
@@ -4939,12 +5534,14 @@ export interface ListConnectorEntitiesRequest {
|
|
|
4939
5534
|
*/
|
|
4940
5535
|
export interface ListConnectorEntitiesResponse {
|
|
4941
5536
|
/**
|
|
5537
|
+
* @public
|
|
4942
5538
|
* <p> The response of <code>ListConnectorEntities</code> lists entities grouped by category.
|
|
4943
5539
|
* This map's key represents the group name, and its value contains the list of entities
|
|
4944
5540
|
* belonging to that group. </p>
|
|
4945
5541
|
*/
|
|
4946
5542
|
connectorEntityMap: Record<string, ConnectorEntity[]> | undefined;
|
|
4947
5543
|
/**
|
|
5544
|
+
* @public
|
|
4948
5545
|
* <p>A token that you specify in your next <code>ListConnectorEntities</code> operation to get
|
|
4949
5546
|
* the next page of results in paginated response. The <code>ListConnectorEntities</code>
|
|
4950
5547
|
* operation provides this token if the response is too big for the page size.</p>
|
|
@@ -4956,11 +5553,13 @@ export interface ListConnectorEntitiesResponse {
|
|
|
4956
5553
|
*/
|
|
4957
5554
|
export interface ListConnectorsRequest {
|
|
4958
5555
|
/**
|
|
5556
|
+
* @public
|
|
4959
5557
|
* <p>Specifies the maximum number of items that should be returned in the result set. The
|
|
4960
5558
|
* default for <code>maxResults</code> is 20 (for all paginated API operations).</p>
|
|
4961
5559
|
*/
|
|
4962
5560
|
maxResults?: number;
|
|
4963
5561
|
/**
|
|
5562
|
+
* @public
|
|
4964
5563
|
* <p>The pagination token for the next page of data.</p>
|
|
4965
5564
|
*/
|
|
4966
5565
|
nextToken?: string;
|
|
@@ -4970,10 +5569,12 @@ export interface ListConnectorsRequest {
|
|
|
4970
5569
|
*/
|
|
4971
5570
|
export interface ListConnectorsResponse {
|
|
4972
5571
|
/**
|
|
5572
|
+
* @public
|
|
4973
5573
|
* <p>Contains information about the connectors supported by Amazon AppFlow.</p>
|
|
4974
5574
|
*/
|
|
4975
5575
|
connectors?: ConnectorDetail[];
|
|
4976
5576
|
/**
|
|
5577
|
+
* @public
|
|
4977
5578
|
* <p>The pagination token for the next page of data. If nextToken=null, this means that all
|
|
4978
5579
|
* records have been fetched.</p>
|
|
4979
5580
|
*/
|
|
@@ -4984,10 +5585,12 @@ export interface ListConnectorsResponse {
|
|
|
4984
5585
|
*/
|
|
4985
5586
|
export interface ListFlowsRequest {
|
|
4986
5587
|
/**
|
|
5588
|
+
* @public
|
|
4987
5589
|
* <p> Specifies the maximum number of items that should be returned in the result set. </p>
|
|
4988
5590
|
*/
|
|
4989
5591
|
maxResults?: number;
|
|
4990
5592
|
/**
|
|
5593
|
+
* @public
|
|
4991
5594
|
* <p> The pagination token for next page of data. </p>
|
|
4992
5595
|
*/
|
|
4993
5596
|
nextToken?: string;
|
|
@@ -4997,10 +5600,12 @@ export interface ListFlowsRequest {
|
|
|
4997
5600
|
*/
|
|
4998
5601
|
export interface ListFlowsResponse {
|
|
4999
5602
|
/**
|
|
5603
|
+
* @public
|
|
5000
5604
|
* <p> The list of flows associated with your account. </p>
|
|
5001
5605
|
*/
|
|
5002
5606
|
flows?: FlowDefinition[];
|
|
5003
5607
|
/**
|
|
5608
|
+
* @public
|
|
5004
5609
|
* <p> The pagination token for next page of data. </p>
|
|
5005
5610
|
*/
|
|
5006
5611
|
nextToken?: string;
|
|
@@ -5010,6 +5615,7 @@ export interface ListFlowsResponse {
|
|
|
5010
5615
|
*/
|
|
5011
5616
|
export interface ListTagsForResourceRequest {
|
|
5012
5617
|
/**
|
|
5618
|
+
* @public
|
|
5013
5619
|
* <p> The Amazon Resource Name (ARN) of the specified flow. </p>
|
|
5014
5620
|
*/
|
|
5015
5621
|
resourceArn: string | undefined;
|
|
@@ -5019,6 +5625,7 @@ export interface ListTagsForResourceRequest {
|
|
|
5019
5625
|
*/
|
|
5020
5626
|
export interface ListTagsForResourceResponse {
|
|
5021
5627
|
/**
|
|
5628
|
+
* @public
|
|
5022
5629
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
5023
5630
|
*/
|
|
5024
5631
|
tags?: Record<string, string>;
|
|
@@ -5028,25 +5635,30 @@ export interface ListTagsForResourceResponse {
|
|
|
5028
5635
|
*/
|
|
5029
5636
|
export interface RegisterConnectorRequest {
|
|
5030
5637
|
/**
|
|
5638
|
+
* @public
|
|
5031
5639
|
* <p> The name of the connector. The name is unique for each <code>ConnectorRegistration</code>
|
|
5032
5640
|
* in your Amazon Web Services account.</p>
|
|
5033
5641
|
*/
|
|
5034
5642
|
connectorLabel?: string;
|
|
5035
5643
|
/**
|
|
5644
|
+
* @public
|
|
5036
5645
|
* <p>A description about the connector that's being registered.</p>
|
|
5037
5646
|
*/
|
|
5038
5647
|
description?: string;
|
|
5039
5648
|
/**
|
|
5649
|
+
* @public
|
|
5040
5650
|
* <p>The provisioning type of the connector. Currently the only supported value is LAMBDA.
|
|
5041
5651
|
* </p>
|
|
5042
5652
|
*/
|
|
5043
5653
|
connectorProvisioningType?: ConnectorProvisioningType | string;
|
|
5044
5654
|
/**
|
|
5655
|
+
* @public
|
|
5045
5656
|
* <p>The provisioning type of the connector. Currently the only supported value is
|
|
5046
5657
|
* LAMBDA.</p>
|
|
5047
5658
|
*/
|
|
5048
5659
|
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
5049
5660
|
/**
|
|
5661
|
+
* @public
|
|
5050
5662
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5051
5663
|
* <code>RegisterConnector</code> request completes only once. You choose the value to pass.
|
|
5052
5664
|
* For example, if you don't receive a response from your request, you can safely retry the
|
|
@@ -5065,6 +5677,7 @@ export interface RegisterConnectorRequest {
|
|
|
5065
5677
|
*/
|
|
5066
5678
|
export interface RegisterConnectorResponse {
|
|
5067
5679
|
/**
|
|
5680
|
+
* @public
|
|
5068
5681
|
* <p>The ARN of the connector being registered.</p>
|
|
5069
5682
|
*/
|
|
5070
5683
|
connectorArn?: string;
|
|
@@ -5074,6 +5687,7 @@ export interface RegisterConnectorResponse {
|
|
|
5074
5687
|
*/
|
|
5075
5688
|
export interface ResetConnectorMetadataCacheRequest {
|
|
5076
5689
|
/**
|
|
5690
|
+
* @public
|
|
5077
5691
|
* <p>The name of the connector profile that you want to reset cached metadata for.</p>
|
|
5078
5692
|
* <p>You can omit this parameter if you're resetting the cache for any of the following
|
|
5079
5693
|
* connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you must include this
|
|
@@ -5081,6 +5695,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5081
5695
|
*/
|
|
5082
5696
|
connectorProfileName?: string;
|
|
5083
5697
|
/**
|
|
5698
|
+
* @public
|
|
5084
5699
|
* <p>The type of connector to reset cached metadata for.</p>
|
|
5085
5700
|
* <p>You must include this parameter in your request if you're resetting the cache for any of
|
|
5086
5701
|
* the following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics,
|
|
@@ -5089,6 +5704,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5089
5704
|
*/
|
|
5090
5705
|
connectorType?: ConnectorType | string;
|
|
5091
5706
|
/**
|
|
5707
|
+
* @public
|
|
5092
5708
|
* <p>Use this parameter if you want to reset cached metadata about the details for an
|
|
5093
5709
|
* individual entity.</p>
|
|
5094
5710
|
* <p>If you don't include this parameter in your request, Amazon AppFlow only resets
|
|
@@ -5096,6 +5712,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5096
5712
|
*/
|
|
5097
5713
|
connectorEntityName?: string;
|
|
5098
5714
|
/**
|
|
5715
|
+
* @public
|
|
5099
5716
|
* <p>Use this parameter only if you’re resetting the cached metadata about a nested entity.
|
|
5100
5717
|
* Only some connectors support nested entities. A nested entity is one that has another entity
|
|
5101
5718
|
* as a parent. To use this parameter, specify the name of the parent entity.</p>
|
|
@@ -5108,6 +5725,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5108
5725
|
*/
|
|
5109
5726
|
entitiesPath?: string;
|
|
5110
5727
|
/**
|
|
5728
|
+
* @public
|
|
5111
5729
|
* <p>The API version that you specified in the connector profile that you’re resetting cached
|
|
5112
5730
|
* metadata for. You must use this parameter only if the connector supports multiple API versions
|
|
5113
5731
|
* or if the connector type is CustomConnector.</p>
|
|
@@ -5131,11 +5749,13 @@ export interface ResetConnectorMetadataCacheResponse {
|
|
|
5131
5749
|
*/
|
|
5132
5750
|
export interface StartFlowRequest {
|
|
5133
5751
|
/**
|
|
5752
|
+
* @public
|
|
5134
5753
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
5135
5754
|
* (-) only. </p>
|
|
5136
5755
|
*/
|
|
5137
5756
|
flowName: string | undefined;
|
|
5138
5757
|
/**
|
|
5758
|
+
* @public
|
|
5139
5759
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5140
5760
|
* <code>StartFlow</code> request completes only once. You choose the value to pass. For
|
|
5141
5761
|
* example, if you don't receive a response from your request, you can safely retry the request
|
|
@@ -5157,14 +5777,17 @@ export interface StartFlowRequest {
|
|
|
5157
5777
|
*/
|
|
5158
5778
|
export interface StartFlowResponse {
|
|
5159
5779
|
/**
|
|
5780
|
+
* @public
|
|
5160
5781
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5161
5782
|
*/
|
|
5162
5783
|
flowArn?: string;
|
|
5163
5784
|
/**
|
|
5785
|
+
* @public
|
|
5164
5786
|
* <p> Indicates the current status of the flow. </p>
|
|
5165
5787
|
*/
|
|
5166
5788
|
flowStatus?: FlowStatus | string;
|
|
5167
5789
|
/**
|
|
5790
|
+
* @public
|
|
5168
5791
|
* <p> Returns the internal execution ID of an on-demand flow when the flow is started. For
|
|
5169
5792
|
* scheduled or event-triggered flows, this value is null. </p>
|
|
5170
5793
|
*/
|
|
@@ -5175,6 +5798,7 @@ export interface StartFlowResponse {
|
|
|
5175
5798
|
*/
|
|
5176
5799
|
export interface StopFlowRequest {
|
|
5177
5800
|
/**
|
|
5801
|
+
* @public
|
|
5178
5802
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
5179
5803
|
* (-) only. </p>
|
|
5180
5804
|
*/
|
|
@@ -5185,10 +5809,12 @@ export interface StopFlowRequest {
|
|
|
5185
5809
|
*/
|
|
5186
5810
|
export interface StopFlowResponse {
|
|
5187
5811
|
/**
|
|
5812
|
+
* @public
|
|
5188
5813
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5189
5814
|
*/
|
|
5190
5815
|
flowArn?: string;
|
|
5191
5816
|
/**
|
|
5817
|
+
* @public
|
|
5192
5818
|
* <p> Indicates the current status of the flow. </p>
|
|
5193
5819
|
*/
|
|
5194
5820
|
flowStatus?: FlowStatus | string;
|
|
@@ -5210,10 +5836,12 @@ export declare class UnsupportedOperationException extends __BaseException {
|
|
|
5210
5836
|
*/
|
|
5211
5837
|
export interface TagResourceRequest {
|
|
5212
5838
|
/**
|
|
5839
|
+
* @public
|
|
5213
5840
|
* <p> The Amazon Resource Name (ARN) of the flow that you want to tag. </p>
|
|
5214
5841
|
*/
|
|
5215
5842
|
resourceArn: string | undefined;
|
|
5216
5843
|
/**
|
|
5844
|
+
* @public
|
|
5217
5845
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
5218
5846
|
*/
|
|
5219
5847
|
tags: Record<string, string> | undefined;
|
|
@@ -5228,11 +5856,13 @@ export interface TagResourceResponse {
|
|
|
5228
5856
|
*/
|
|
5229
5857
|
export interface UnregisterConnectorRequest {
|
|
5230
5858
|
/**
|
|
5859
|
+
* @public
|
|
5231
5860
|
* <p>The label of the connector. The label is unique for each
|
|
5232
5861
|
* <code>ConnectorRegistration</code> in your Amazon Web Services account.</p>
|
|
5233
5862
|
*/
|
|
5234
5863
|
connectorLabel: string | undefined;
|
|
5235
5864
|
/**
|
|
5865
|
+
* @public
|
|
5236
5866
|
* <p>Indicates whether Amazon AppFlow should unregister the connector, even if it is
|
|
5237
5867
|
* currently in use in one or more connector profiles. The default value is false.</p>
|
|
5238
5868
|
*/
|
|
@@ -5248,10 +5878,12 @@ export interface UnregisterConnectorResponse {
|
|
|
5248
5878
|
*/
|
|
5249
5879
|
export interface UntagResourceRequest {
|
|
5250
5880
|
/**
|
|
5881
|
+
* @public
|
|
5251
5882
|
* <p> The Amazon Resource Name (ARN) of the flow that you want to untag. </p>
|
|
5252
5883
|
*/
|
|
5253
5884
|
resourceArn: string | undefined;
|
|
5254
5885
|
/**
|
|
5886
|
+
* @public
|
|
5255
5887
|
* <p> The tag keys associated with the tag that you want to remove from your flow. </p>
|
|
5256
5888
|
*/
|
|
5257
5889
|
tagKeys: string[] | undefined;
|
|
@@ -5266,19 +5898,23 @@ export interface UntagResourceResponse {
|
|
|
5266
5898
|
*/
|
|
5267
5899
|
export interface UpdateConnectorProfileRequest {
|
|
5268
5900
|
/**
|
|
5901
|
+
* @public
|
|
5269
5902
|
* <p> The name of the connector profile and is unique for each <code>ConnectorProfile</code> in
|
|
5270
5903
|
* the Amazon Web Services account. </p>
|
|
5271
5904
|
*/
|
|
5272
5905
|
connectorProfileName: string | undefined;
|
|
5273
5906
|
/**
|
|
5907
|
+
* @public
|
|
5274
5908
|
* <p> Indicates the connection mode and if it is public or private. </p>
|
|
5275
5909
|
*/
|
|
5276
5910
|
connectionMode: ConnectionMode | string | undefined;
|
|
5277
5911
|
/**
|
|
5912
|
+
* @public
|
|
5278
5913
|
* <p> Defines the connector-specific profile configuration and credentials. </p>
|
|
5279
5914
|
*/
|
|
5280
5915
|
connectorProfileConfig: ConnectorProfileConfig | undefined;
|
|
5281
5916
|
/**
|
|
5917
|
+
* @public
|
|
5282
5918
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5283
5919
|
* <code>UpdateConnectorProfile</code> request completes only once. You choose the value to
|
|
5284
5920
|
* pass. For example, if you don't receive a response from your request, you can safely retry the
|
|
@@ -5297,6 +5933,7 @@ export interface UpdateConnectorProfileRequest {
|
|
|
5297
5933
|
*/
|
|
5298
5934
|
export interface UpdateConnectorProfileResponse {
|
|
5299
5935
|
/**
|
|
5936
|
+
* @public
|
|
5300
5937
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
5301
5938
|
*/
|
|
5302
5939
|
connectorProfileArn?: string;
|
|
@@ -5306,19 +5943,23 @@ export interface UpdateConnectorProfileResponse {
|
|
|
5306
5943
|
*/
|
|
5307
5944
|
export interface UpdateConnectorRegistrationRequest {
|
|
5308
5945
|
/**
|
|
5946
|
+
* @public
|
|
5309
5947
|
* <p>The name of the connector. The name is unique for each connector registration in your AWS
|
|
5310
5948
|
* account.</p>
|
|
5311
5949
|
*/
|
|
5312
5950
|
connectorLabel: string | undefined;
|
|
5313
5951
|
/**
|
|
5952
|
+
* @public
|
|
5314
5953
|
* <p>A description about the update that you're applying to the connector.</p>
|
|
5315
5954
|
*/
|
|
5316
5955
|
description?: string;
|
|
5317
5956
|
/**
|
|
5957
|
+
* @public
|
|
5318
5958
|
* <p>Contains information about the configuration of the connector being registered.</p>
|
|
5319
5959
|
*/
|
|
5320
5960
|
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
5321
5961
|
/**
|
|
5962
|
+
* @public
|
|
5322
5963
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5323
5964
|
* <code>UpdateConnectorRegistration</code> request completes only once. You choose the value
|
|
5324
5965
|
* to pass. For example, if you don't receive a response from your request, you can safely retry
|
|
@@ -5337,6 +5978,7 @@ export interface UpdateConnectorRegistrationRequest {
|
|
|
5337
5978
|
*/
|
|
5338
5979
|
export interface UpdateConnectorRegistrationResponse {
|
|
5339
5980
|
/**
|
|
5981
|
+
* @public
|
|
5340
5982
|
* <p>The ARN of the connector being updated.</p>
|
|
5341
5983
|
*/
|
|
5342
5984
|
connectorArn?: string;
|
|
@@ -5346,40 +5988,48 @@ export interface UpdateConnectorRegistrationResponse {
|
|
|
5346
5988
|
*/
|
|
5347
5989
|
export interface UpdateFlowRequest {
|
|
5348
5990
|
/**
|
|
5991
|
+
* @public
|
|
5349
5992
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
5350
5993
|
* (-) only. </p>
|
|
5351
5994
|
*/
|
|
5352
5995
|
flowName: string | undefined;
|
|
5353
5996
|
/**
|
|
5997
|
+
* @public
|
|
5354
5998
|
* <p> A description of the flow. </p>
|
|
5355
5999
|
*/
|
|
5356
6000
|
description?: string;
|
|
5357
6001
|
/**
|
|
6002
|
+
* @public
|
|
5358
6003
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
5359
6004
|
*/
|
|
5360
6005
|
triggerConfig: TriggerConfig | undefined;
|
|
5361
6006
|
/**
|
|
6007
|
+
* @public
|
|
5362
6008
|
* <p> Contains information about the configuration of the source connector used in the flow.
|
|
5363
6009
|
* </p>
|
|
5364
6010
|
*/
|
|
5365
6011
|
sourceFlowConfig: SourceFlowConfig | undefined;
|
|
5366
6012
|
/**
|
|
6013
|
+
* @public
|
|
5367
6014
|
* <p> The configuration that controls how Amazon AppFlow transfers data to the destination
|
|
5368
6015
|
* connector. </p>
|
|
5369
6016
|
*/
|
|
5370
6017
|
destinationFlowConfigList: DestinationFlowConfig[] | undefined;
|
|
5371
6018
|
/**
|
|
6019
|
+
* @public
|
|
5372
6020
|
* <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow
|
|
5373
6021
|
* run. </p>
|
|
5374
6022
|
*/
|
|
5375
6023
|
tasks: Task[] | undefined;
|
|
5376
6024
|
/**
|
|
6025
|
+
* @public
|
|
5377
6026
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
|
|
5378
6027
|
* transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
|
|
5379
6028
|
* stores metadata in a data catalog.</p>
|
|
5380
6029
|
*/
|
|
5381
6030
|
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
5382
6031
|
/**
|
|
6032
|
+
* @public
|
|
5383
6033
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5384
6034
|
* <code>UpdateFlow</code> request completes only once. You choose the value to pass. For
|
|
5385
6035
|
* example, if you don't receive a response from your request, you can safely retry the request
|
|
@@ -5398,6 +6048,7 @@ export interface UpdateFlowRequest {
|
|
|
5398
6048
|
*/
|
|
5399
6049
|
export interface UpdateFlowResponse {
|
|
5400
6050
|
/**
|
|
6051
|
+
* @public
|
|
5401
6052
|
* <p>Indicates the current status of the flow. </p>
|
|
5402
6053
|
*/
|
|
5403
6054
|
flowStatus?: FlowStatus | string;
|