@aws-sdk/client-appflow 3.686.0 → 3.691.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 +519 -519
- package/dist-types/ts3.4/models/models_0.d.ts +523 -521
- package/package.json +7 -7
|
@@ -35,7 +35,7 @@ export interface AggregationConfig {
|
|
|
35
35
|
* leave them unaggregated. </p>
|
|
36
36
|
* @public
|
|
37
37
|
*/
|
|
38
|
-
aggregationType?: AggregationType;
|
|
38
|
+
aggregationType?: AggregationType | undefined;
|
|
39
39
|
/**
|
|
40
40
|
* <p>The desired file size, in MB, for each output file that Amazon AppFlow writes to the
|
|
41
41
|
* flow destination. For each file, Amazon AppFlow attempts to achieve the size that you
|
|
@@ -43,7 +43,7 @@ export interface AggregationConfig {
|
|
|
43
43
|
* the records that each file contains.</p>
|
|
44
44
|
* @public
|
|
45
45
|
*/
|
|
46
|
-
targetFileSize?: number;
|
|
46
|
+
targetFileSize?: number | undefined;
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
49
|
* @public
|
|
@@ -110,7 +110,7 @@ export interface ApiKeyCredentials {
|
|
|
110
110
|
* <p>The API secret key required for API key authentication.</p>
|
|
111
111
|
* @public
|
|
112
112
|
*/
|
|
113
|
-
apiSecretKey?: string;
|
|
113
|
+
apiSecretKey?: string | undefined;
|
|
114
114
|
}
|
|
115
115
|
/**
|
|
116
116
|
* <p>Information about required authentication parameters.</p>
|
|
@@ -121,33 +121,33 @@ export interface AuthParameter {
|
|
|
121
121
|
* <p>The authentication key required to authenticate with the connector.</p>
|
|
122
122
|
* @public
|
|
123
123
|
*/
|
|
124
|
-
key?: string;
|
|
124
|
+
key?: string | undefined;
|
|
125
125
|
/**
|
|
126
126
|
* <p>Indicates whether this authentication parameter is required.</p>
|
|
127
127
|
* @public
|
|
128
128
|
*/
|
|
129
|
-
isRequired?: boolean;
|
|
129
|
+
isRequired?: boolean | undefined;
|
|
130
130
|
/**
|
|
131
131
|
* <p>Label used for authentication parameter.</p>
|
|
132
132
|
* @public
|
|
133
133
|
*/
|
|
134
|
-
label?: string;
|
|
134
|
+
label?: string | undefined;
|
|
135
135
|
/**
|
|
136
136
|
* <p>A description about the authentication parameter.</p>
|
|
137
137
|
* @public
|
|
138
138
|
*/
|
|
139
|
-
description?: string;
|
|
139
|
+
description?: string | undefined;
|
|
140
140
|
/**
|
|
141
141
|
* <p>Indicates whether this authentication parameter is a sensitive field.</p>
|
|
142
142
|
* @public
|
|
143
143
|
*/
|
|
144
|
-
isSensitiveField?: boolean;
|
|
144
|
+
isSensitiveField?: boolean | undefined;
|
|
145
145
|
/**
|
|
146
146
|
* <p>Contains default values for this authentication parameter that are supplied by the
|
|
147
147
|
* connector.</p>
|
|
148
148
|
* @public
|
|
149
149
|
*/
|
|
150
|
-
connectorSuppliedValues?: string[];
|
|
150
|
+
connectorSuppliedValues?: string[] | undefined;
|
|
151
151
|
}
|
|
152
152
|
/**
|
|
153
153
|
* <p>Configuration information required for custom authentication.</p>
|
|
@@ -158,12 +158,12 @@ export interface CustomAuthConfig {
|
|
|
158
158
|
* <p>The authentication type that the custom connector uses.</p>
|
|
159
159
|
* @public
|
|
160
160
|
*/
|
|
161
|
-
customAuthenticationType?: string;
|
|
161
|
+
customAuthenticationType?: string | undefined;
|
|
162
162
|
/**
|
|
163
163
|
* <p>Information about authentication parameters required for authentication.</p>
|
|
164
164
|
* @public
|
|
165
165
|
*/
|
|
166
|
-
authParameters?: AuthParameter[];
|
|
166
|
+
authParameters?: AuthParameter[] | undefined;
|
|
167
167
|
}
|
|
168
168
|
/**
|
|
169
169
|
* @public
|
|
@@ -186,38 +186,38 @@ export interface OAuth2CustomParameter {
|
|
|
186
186
|
* <p>The key of the custom parameter required for OAuth 2.0 authentication.</p>
|
|
187
187
|
* @public
|
|
188
188
|
*/
|
|
189
|
-
key?: string;
|
|
189
|
+
key?: string | undefined;
|
|
190
190
|
/**
|
|
191
191
|
* <p>Indicates whether the custom parameter for OAuth 2.0 authentication is required.</p>
|
|
192
192
|
* @public
|
|
193
193
|
*/
|
|
194
|
-
isRequired?: boolean;
|
|
194
|
+
isRequired?: boolean | undefined;
|
|
195
195
|
/**
|
|
196
196
|
* <p>The label of the custom parameter used for OAuth 2.0 authentication.</p>
|
|
197
197
|
* @public
|
|
198
198
|
*/
|
|
199
|
-
label?: string;
|
|
199
|
+
label?: string | undefined;
|
|
200
200
|
/**
|
|
201
201
|
* <p>A description about the custom parameter used for OAuth 2.0 authentication.</p>
|
|
202
202
|
* @public
|
|
203
203
|
*/
|
|
204
|
-
description?: string;
|
|
204
|
+
description?: string | undefined;
|
|
205
205
|
/**
|
|
206
206
|
* <p>Indicates whether this authentication custom parameter is a sensitive field.</p>
|
|
207
207
|
* @public
|
|
208
208
|
*/
|
|
209
|
-
isSensitiveField?: boolean;
|
|
209
|
+
isSensitiveField?: boolean | undefined;
|
|
210
210
|
/**
|
|
211
211
|
* <p>Contains default values for this authentication parameter that are supplied by the
|
|
212
212
|
* connector.</p>
|
|
213
213
|
* @public
|
|
214
214
|
*/
|
|
215
|
-
connectorSuppliedValues?: string[];
|
|
215
|
+
connectorSuppliedValues?: string[] | undefined;
|
|
216
216
|
/**
|
|
217
217
|
* <p>Indicates whether custom parameter is used with TokenUrl or AuthUrl.</p>
|
|
218
218
|
* @public
|
|
219
219
|
*/
|
|
220
|
-
type?: OAuth2CustomPropType;
|
|
220
|
+
type?: OAuth2CustomPropType | undefined;
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
223
|
* @public
|
|
@@ -241,27 +241,27 @@ export interface OAuth2Defaults {
|
|
|
241
241
|
* <p>OAuth 2.0 scopes that the connector supports.</p>
|
|
242
242
|
* @public
|
|
243
243
|
*/
|
|
244
|
-
oauthScopes?: string[];
|
|
244
|
+
oauthScopes?: string[] | undefined;
|
|
245
245
|
/**
|
|
246
246
|
* <p>Token URLs that can be used for OAuth 2.0 authentication.</p>
|
|
247
247
|
* @public
|
|
248
248
|
*/
|
|
249
|
-
tokenUrls?: string[];
|
|
249
|
+
tokenUrls?: string[] | undefined;
|
|
250
250
|
/**
|
|
251
251
|
* <p>Auth code URLs that can be used for OAuth 2.0 authentication.</p>
|
|
252
252
|
* @public
|
|
253
253
|
*/
|
|
254
|
-
authCodeUrls?: string[];
|
|
254
|
+
authCodeUrls?: string[] | undefined;
|
|
255
255
|
/**
|
|
256
256
|
* <p>OAuth 2.0 grant types supported by the connector.</p>
|
|
257
257
|
* @public
|
|
258
258
|
*/
|
|
259
|
-
oauth2GrantTypesSupported?: OAuth2GrantType[];
|
|
259
|
+
oauth2GrantTypesSupported?: OAuth2GrantType[] | undefined;
|
|
260
260
|
/**
|
|
261
261
|
* <p>List of custom parameters required for OAuth 2.0 authentication.</p>
|
|
262
262
|
* @public
|
|
263
263
|
*/
|
|
264
|
-
oauth2CustomProperties?: OAuth2CustomParameter[];
|
|
264
|
+
oauth2CustomProperties?: OAuth2CustomParameter[] | undefined;
|
|
265
265
|
}
|
|
266
266
|
/**
|
|
267
267
|
* <p>Contains information about the authentication config that the connector supports.</p>
|
|
@@ -272,32 +272,32 @@ export interface AuthenticationConfig {
|
|
|
272
272
|
* <p>Indicates whether basic authentication is supported by the connector.</p>
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
|
-
isBasicAuthSupported?: boolean;
|
|
275
|
+
isBasicAuthSupported?: boolean | undefined;
|
|
276
276
|
/**
|
|
277
277
|
* <p>Indicates whether API key authentication is supported by the connector</p>
|
|
278
278
|
* @public
|
|
279
279
|
*/
|
|
280
|
-
isApiKeyAuthSupported?: boolean;
|
|
280
|
+
isApiKeyAuthSupported?: boolean | undefined;
|
|
281
281
|
/**
|
|
282
282
|
* <p>Indicates whether OAuth 2.0 authentication is supported by the connector.</p>
|
|
283
283
|
* @public
|
|
284
284
|
*/
|
|
285
|
-
isOAuth2Supported?: boolean;
|
|
285
|
+
isOAuth2Supported?: boolean | undefined;
|
|
286
286
|
/**
|
|
287
287
|
* <p>Indicates whether custom authentication is supported by the connector</p>
|
|
288
288
|
* @public
|
|
289
289
|
*/
|
|
290
|
-
isCustomAuthSupported?: boolean;
|
|
290
|
+
isCustomAuthSupported?: boolean | undefined;
|
|
291
291
|
/**
|
|
292
292
|
* <p>Contains the default values required for OAuth 2.0 authentication.</p>
|
|
293
293
|
* @public
|
|
294
294
|
*/
|
|
295
|
-
oAuth2Defaults?: OAuth2Defaults;
|
|
295
|
+
oAuth2Defaults?: OAuth2Defaults | undefined;
|
|
296
296
|
/**
|
|
297
297
|
* <p>Contains information required for custom authentication.</p>
|
|
298
298
|
* @public
|
|
299
299
|
*/
|
|
300
|
-
customAuthConfigs?: CustomAuthConfig[];
|
|
300
|
+
customAuthConfigs?: CustomAuthConfig[] | undefined;
|
|
301
301
|
}
|
|
302
302
|
/**
|
|
303
303
|
* @public
|
|
@@ -345,7 +345,7 @@ export interface CancelFlowExecutionsRequest {
|
|
|
345
345
|
* flow.</p>
|
|
346
346
|
* @public
|
|
347
347
|
*/
|
|
348
|
-
executionIds?: string[];
|
|
348
|
+
executionIds?: string[] | undefined;
|
|
349
349
|
}
|
|
350
350
|
/**
|
|
351
351
|
* @public
|
|
@@ -356,7 +356,7 @@ export interface CancelFlowExecutionsResponse {
|
|
|
356
356
|
* for canceling because they haven't started yet or have already completed.</p>
|
|
357
357
|
* @public
|
|
358
358
|
*/
|
|
359
|
-
invalidExecutions?: string[];
|
|
359
|
+
invalidExecutions?: string[] | undefined;
|
|
360
360
|
}
|
|
361
361
|
/**
|
|
362
362
|
* <p> An internal service error occurred during the processing of your request. Try again
|
|
@@ -490,7 +490,7 @@ export interface GoogleAnalyticsMetadata {
|
|
|
490
490
|
* <p> The desired authorization scope for the Google Analytics account. </p>
|
|
491
491
|
* @public
|
|
492
492
|
*/
|
|
493
|
-
oAuthScopes?: string[];
|
|
493
|
+
oAuthScopes?: string[] | undefined;
|
|
494
494
|
}
|
|
495
495
|
/**
|
|
496
496
|
* <p> The connector metadata specific to Amazon Honeycode. </p>
|
|
@@ -501,7 +501,7 @@ export interface HoneycodeMetadata {
|
|
|
501
501
|
* <p> The desired authorization scope for the Amazon Honeycode account. </p>
|
|
502
502
|
* @public
|
|
503
503
|
*/
|
|
504
|
-
oAuthScopes?: string[];
|
|
504
|
+
oAuthScopes?: string[] | undefined;
|
|
505
505
|
}
|
|
506
506
|
/**
|
|
507
507
|
* <p> The connector metadata specific to Infor Nexus. </p>
|
|
@@ -555,13 +555,13 @@ export interface SalesforceMetadata {
|
|
|
555
555
|
* <p> The desired authorization scope for the Salesforce account. </p>
|
|
556
556
|
* @public
|
|
557
557
|
*/
|
|
558
|
-
oAuthScopes?: string[];
|
|
558
|
+
oAuthScopes?: string[] | undefined;
|
|
559
559
|
/**
|
|
560
560
|
* <p>The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers
|
|
561
561
|
* data to or from Salesforce.</p>
|
|
562
562
|
* @public
|
|
563
563
|
*/
|
|
564
|
-
dataTransferApis?: SalesforceDataTransferApi[];
|
|
564
|
+
dataTransferApis?: SalesforceDataTransferApi[] | undefined;
|
|
565
565
|
/**
|
|
566
566
|
* <p>The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access
|
|
567
567
|
* token from Salesforce. Amazon AppFlow requires an access token each time it attempts to
|
|
@@ -588,7 +588,7 @@ export interface SalesforceMetadata {
|
|
|
588
588
|
* </note>
|
|
589
589
|
* @public
|
|
590
590
|
*/
|
|
591
|
-
oauth2GrantTypesSupported?: OAuth2GrantType[];
|
|
591
|
+
oauth2GrantTypesSupported?: OAuth2GrantType[] | undefined;
|
|
592
592
|
}
|
|
593
593
|
/**
|
|
594
594
|
* <p> The connector metadata specific to SAPOData. </p>
|
|
@@ -617,7 +617,7 @@ export interface SlackMetadata {
|
|
|
617
617
|
* <p> The desired authorization scope for the Slack account. </p>
|
|
618
618
|
* @public
|
|
619
619
|
*/
|
|
620
|
-
oAuthScopes?: string[];
|
|
620
|
+
oAuthScopes?: string[] | undefined;
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
623
|
* <p> The connector metadata specific to Snowflake. </p>
|
|
@@ -628,7 +628,7 @@ export interface SnowflakeMetadata {
|
|
|
628
628
|
* <p> Specifies the supported Amazon Web Services Regions when using Snowflake. </p>
|
|
629
629
|
* @public
|
|
630
630
|
*/
|
|
631
|
-
supportedRegions?: string[];
|
|
631
|
+
supportedRegions?: string[] | undefined;
|
|
632
632
|
}
|
|
633
633
|
/**
|
|
634
634
|
* <p> The connector metadata specific to Trend Micro. </p>
|
|
@@ -657,7 +657,7 @@ export interface ZendeskMetadata {
|
|
|
657
657
|
* <p> The desired authorization scope for the Zendesk account. </p>
|
|
658
658
|
* @public
|
|
659
659
|
*/
|
|
660
|
-
oAuthScopes?: string[];
|
|
660
|
+
oAuthScopes?: string[] | undefined;
|
|
661
661
|
}
|
|
662
662
|
/**
|
|
663
663
|
* <p> A structure to specify connector-specific metadata such as <code>oAuthScopes</code>,
|
|
@@ -669,112 +669,112 @@ export interface ConnectorMetadata {
|
|
|
669
669
|
* <p> The connector metadata specific to Amplitude. </p>
|
|
670
670
|
* @public
|
|
671
671
|
*/
|
|
672
|
-
Amplitude?: AmplitudeMetadata;
|
|
672
|
+
Amplitude?: AmplitudeMetadata | undefined;
|
|
673
673
|
/**
|
|
674
674
|
* <p> The connector metadata specific to Datadog. </p>
|
|
675
675
|
* @public
|
|
676
676
|
*/
|
|
677
|
-
Datadog?: DatadogMetadata;
|
|
677
|
+
Datadog?: DatadogMetadata | undefined;
|
|
678
678
|
/**
|
|
679
679
|
* <p> The connector metadata specific to Dynatrace. </p>
|
|
680
680
|
* @public
|
|
681
681
|
*/
|
|
682
|
-
Dynatrace?: DynatraceMetadata;
|
|
682
|
+
Dynatrace?: DynatraceMetadata | undefined;
|
|
683
683
|
/**
|
|
684
684
|
* <p> The connector metadata specific to Google Analytics. </p>
|
|
685
685
|
* @public
|
|
686
686
|
*/
|
|
687
|
-
GoogleAnalytics?: GoogleAnalyticsMetadata;
|
|
687
|
+
GoogleAnalytics?: GoogleAnalyticsMetadata | undefined;
|
|
688
688
|
/**
|
|
689
689
|
* <p> The connector metadata specific to Infor Nexus. </p>
|
|
690
690
|
* @public
|
|
691
691
|
*/
|
|
692
|
-
InforNexus?: InforNexusMetadata;
|
|
692
|
+
InforNexus?: InforNexusMetadata | undefined;
|
|
693
693
|
/**
|
|
694
694
|
* <p> The connector metadata specific to Marketo. </p>
|
|
695
695
|
* @public
|
|
696
696
|
*/
|
|
697
|
-
Marketo?: MarketoMetadata;
|
|
697
|
+
Marketo?: MarketoMetadata | undefined;
|
|
698
698
|
/**
|
|
699
699
|
* <p> The connector metadata specific to Amazon Redshift. </p>
|
|
700
700
|
* @public
|
|
701
701
|
*/
|
|
702
|
-
Redshift?: RedshiftMetadata;
|
|
702
|
+
Redshift?: RedshiftMetadata | undefined;
|
|
703
703
|
/**
|
|
704
704
|
* <p> The connector metadata specific to Amazon S3. </p>
|
|
705
705
|
* @public
|
|
706
706
|
*/
|
|
707
|
-
S3?: S3Metadata;
|
|
707
|
+
S3?: S3Metadata | undefined;
|
|
708
708
|
/**
|
|
709
709
|
* <p> The connector metadata specific to Salesforce. </p>
|
|
710
710
|
* @public
|
|
711
711
|
*/
|
|
712
|
-
Salesforce?: SalesforceMetadata;
|
|
712
|
+
Salesforce?: SalesforceMetadata | undefined;
|
|
713
713
|
/**
|
|
714
714
|
* <p> The connector metadata specific to ServiceNow. </p>
|
|
715
715
|
* @public
|
|
716
716
|
*/
|
|
717
|
-
ServiceNow?: ServiceNowMetadata;
|
|
717
|
+
ServiceNow?: ServiceNowMetadata | undefined;
|
|
718
718
|
/**
|
|
719
719
|
* <p> The connector metadata specific to Singular. </p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
|
-
Singular?: SingularMetadata;
|
|
722
|
+
Singular?: SingularMetadata | undefined;
|
|
723
723
|
/**
|
|
724
724
|
* <p> The connector metadata specific to Slack. </p>
|
|
725
725
|
* @public
|
|
726
726
|
*/
|
|
727
|
-
Slack?: SlackMetadata;
|
|
727
|
+
Slack?: SlackMetadata | undefined;
|
|
728
728
|
/**
|
|
729
729
|
* <p> The connector metadata specific to Snowflake. </p>
|
|
730
730
|
* @public
|
|
731
731
|
*/
|
|
732
|
-
Snowflake?: SnowflakeMetadata;
|
|
732
|
+
Snowflake?: SnowflakeMetadata | undefined;
|
|
733
733
|
/**
|
|
734
734
|
* <p> The connector metadata specific to Trend Micro. </p>
|
|
735
735
|
* @public
|
|
736
736
|
*/
|
|
737
|
-
Trendmicro?: TrendmicroMetadata;
|
|
737
|
+
Trendmicro?: TrendmicroMetadata | undefined;
|
|
738
738
|
/**
|
|
739
739
|
* <p> The connector metadata specific to Veeva. </p>
|
|
740
740
|
* @public
|
|
741
741
|
*/
|
|
742
|
-
Veeva?: VeevaMetadata;
|
|
742
|
+
Veeva?: VeevaMetadata | undefined;
|
|
743
743
|
/**
|
|
744
744
|
* <p> The connector metadata specific to Zendesk. </p>
|
|
745
745
|
* @public
|
|
746
746
|
*/
|
|
747
|
-
Zendesk?: ZendeskMetadata;
|
|
747
|
+
Zendesk?: ZendeskMetadata | undefined;
|
|
748
748
|
/**
|
|
749
749
|
* <p> The connector metadata specific to Amazon EventBridge. </p>
|
|
750
750
|
* @public
|
|
751
751
|
*/
|
|
752
|
-
EventBridge?: EventBridgeMetadata;
|
|
752
|
+
EventBridge?: EventBridgeMetadata | undefined;
|
|
753
753
|
/**
|
|
754
754
|
* <p> The connector metadata specific to Upsolver. </p>
|
|
755
755
|
* @public
|
|
756
756
|
*/
|
|
757
|
-
Upsolver?: UpsolverMetadata;
|
|
757
|
+
Upsolver?: UpsolverMetadata | undefined;
|
|
758
758
|
/**
|
|
759
759
|
* <p> The connector metadata specific to Amazon Connect Customer Profiles. </p>
|
|
760
760
|
* @public
|
|
761
761
|
*/
|
|
762
|
-
CustomerProfiles?: CustomerProfilesMetadata;
|
|
762
|
+
CustomerProfiles?: CustomerProfilesMetadata | undefined;
|
|
763
763
|
/**
|
|
764
764
|
* <p> The connector metadata specific to Amazon Honeycode. </p>
|
|
765
765
|
* @public
|
|
766
766
|
*/
|
|
767
|
-
Honeycode?: HoneycodeMetadata;
|
|
767
|
+
Honeycode?: HoneycodeMetadata | undefined;
|
|
768
768
|
/**
|
|
769
769
|
* <p> The connector metadata specific to SAPOData. </p>
|
|
770
770
|
* @public
|
|
771
771
|
*/
|
|
772
|
-
SAPOData?: SAPODataMetadata;
|
|
772
|
+
SAPOData?: SAPODataMetadata | undefined;
|
|
773
773
|
/**
|
|
774
774
|
* <p>The connector metadata specific to Salesforce Pardot.</p>
|
|
775
775
|
* @public
|
|
776
776
|
*/
|
|
777
|
-
Pardot?: PardotMetadata;
|
|
777
|
+
Pardot?: PardotMetadata | undefined;
|
|
778
778
|
}
|
|
779
779
|
/**
|
|
780
780
|
* <p>Contains information about the configuration of the lambda which is being registered as
|
|
@@ -798,7 +798,7 @@ export interface ConnectorProvisioningConfig {
|
|
|
798
798
|
* the connector.</p>
|
|
799
799
|
* @public
|
|
800
800
|
*/
|
|
801
|
-
lambda?: LambdaConnectorProvisioningConfig;
|
|
801
|
+
lambda?: LambdaConnectorProvisioningConfig | undefined;
|
|
802
802
|
}
|
|
803
803
|
/**
|
|
804
804
|
* @public
|
|
@@ -821,38 +821,38 @@ export interface ConnectorRuntimeSetting {
|
|
|
821
821
|
* <p>Contains value information about the connector runtime setting.</p>
|
|
822
822
|
* @public
|
|
823
823
|
*/
|
|
824
|
-
key?: string;
|
|
824
|
+
key?: string | undefined;
|
|
825
825
|
/**
|
|
826
826
|
* <p>Data type of the connector runtime setting.</p>
|
|
827
827
|
* @public
|
|
828
828
|
*/
|
|
829
|
-
dataType?: string;
|
|
829
|
+
dataType?: string | undefined;
|
|
830
830
|
/**
|
|
831
831
|
* <p>Indicates whether this connector runtime setting is required.</p>
|
|
832
832
|
* @public
|
|
833
833
|
*/
|
|
834
|
-
isRequired?: boolean;
|
|
834
|
+
isRequired?: boolean | undefined;
|
|
835
835
|
/**
|
|
836
836
|
* <p>A label used for connector runtime setting.</p>
|
|
837
837
|
* @public
|
|
838
838
|
*/
|
|
839
|
-
label?: string;
|
|
839
|
+
label?: string | undefined;
|
|
840
840
|
/**
|
|
841
841
|
* <p>A description about the connector runtime setting.</p>
|
|
842
842
|
* @public
|
|
843
843
|
*/
|
|
844
|
-
description?: string;
|
|
844
|
+
description?: string | undefined;
|
|
845
845
|
/**
|
|
846
846
|
* <p>Indicates the scope of the connector runtime setting.</p>
|
|
847
847
|
* @public
|
|
848
848
|
*/
|
|
849
|
-
scope?: string;
|
|
849
|
+
scope?: string | undefined;
|
|
850
850
|
/**
|
|
851
851
|
* <p>Contains default values for the connector runtime setting that are supplied by the
|
|
852
852
|
* connector.</p>
|
|
853
853
|
* @public
|
|
854
854
|
*/
|
|
855
|
-
connectorSuppliedValueOptions?: string[];
|
|
855
|
+
connectorSuppliedValueOptions?: string[] | undefined;
|
|
856
856
|
}
|
|
857
857
|
/**
|
|
858
858
|
* @public
|
|
@@ -911,7 +911,7 @@ export interface DataTransferApi {
|
|
|
911
911
|
* <p>The name of the connector application API.</p>
|
|
912
912
|
* @public
|
|
913
913
|
*/
|
|
914
|
-
Name?: string;
|
|
914
|
+
Name?: string | undefined;
|
|
915
915
|
/**
|
|
916
916
|
* <p>You can specify one of the following types:</p>
|
|
917
917
|
* <dl>
|
|
@@ -933,7 +933,7 @@ export interface DataTransferApi {
|
|
|
933
933
|
* </dl>
|
|
934
934
|
* @public
|
|
935
935
|
*/
|
|
936
|
-
Type?: DataTransferApiType;
|
|
936
|
+
Type?: DataTransferApiType | undefined;
|
|
937
937
|
}
|
|
938
938
|
/**
|
|
939
939
|
* @public
|
|
@@ -1030,133 +1030,133 @@ export interface ConnectorConfiguration {
|
|
|
1030
1030
|
* <p> Specifies whether the connector can be used as a source. </p>
|
|
1031
1031
|
* @public
|
|
1032
1032
|
*/
|
|
1033
|
-
canUseAsSource?: boolean;
|
|
1033
|
+
canUseAsSource?: boolean | undefined;
|
|
1034
1034
|
/**
|
|
1035
1035
|
* <p> Specifies whether the connector can be used as a destination. </p>
|
|
1036
1036
|
* @public
|
|
1037
1037
|
*/
|
|
1038
|
-
canUseAsDestination?: boolean;
|
|
1038
|
+
canUseAsDestination?: boolean | undefined;
|
|
1039
1039
|
/**
|
|
1040
1040
|
* <p> Lists the connectors that are available for use as destinations. </p>
|
|
1041
1041
|
* @public
|
|
1042
1042
|
*/
|
|
1043
|
-
supportedDestinationConnectors?: ConnectorType[];
|
|
1043
|
+
supportedDestinationConnectors?: ConnectorType[] | undefined;
|
|
1044
1044
|
/**
|
|
1045
1045
|
* <p> Specifies the supported flow frequency for that connector. </p>
|
|
1046
1046
|
* @public
|
|
1047
1047
|
*/
|
|
1048
|
-
supportedSchedulingFrequencies?: ScheduleFrequencyType[];
|
|
1048
|
+
supportedSchedulingFrequencies?: ScheduleFrequencyType[] | undefined;
|
|
1049
1049
|
/**
|
|
1050
1050
|
* <p> Specifies if PrivateLink is enabled for that connector. </p>
|
|
1051
1051
|
* @public
|
|
1052
1052
|
*/
|
|
1053
|
-
isPrivateLinkEnabled?: boolean;
|
|
1053
|
+
isPrivateLinkEnabled?: boolean | undefined;
|
|
1054
1054
|
/**
|
|
1055
1055
|
* <p> Specifies if a PrivateLink endpoint URL is required. </p>
|
|
1056
1056
|
* @public
|
|
1057
1057
|
*/
|
|
1058
|
-
isPrivateLinkEndpointUrlRequired?: boolean;
|
|
1058
|
+
isPrivateLinkEndpointUrlRequired?: boolean | undefined;
|
|
1059
1059
|
/**
|
|
1060
1060
|
* <p> Specifies the supported trigger types for the flow. </p>
|
|
1061
1061
|
* @public
|
|
1062
1062
|
*/
|
|
1063
|
-
supportedTriggerTypes?: TriggerType[];
|
|
1063
|
+
supportedTriggerTypes?: TriggerType[] | undefined;
|
|
1064
1064
|
/**
|
|
1065
1065
|
* <p> Specifies connector-specific metadata such as <code>oAuthScopes</code>,
|
|
1066
1066
|
* <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>
|
|
1067
1067
|
* @public
|
|
1068
1068
|
*/
|
|
1069
|
-
connectorMetadata?: ConnectorMetadata;
|
|
1069
|
+
connectorMetadata?: ConnectorMetadata | undefined;
|
|
1070
1070
|
/**
|
|
1071
1071
|
* <p>The connector type.</p>
|
|
1072
1072
|
* @public
|
|
1073
1073
|
*/
|
|
1074
|
-
connectorType?: ConnectorType;
|
|
1074
|
+
connectorType?: ConnectorType | undefined;
|
|
1075
1075
|
/**
|
|
1076
1076
|
* <p>The label used for registering the connector.</p>
|
|
1077
1077
|
* @public
|
|
1078
1078
|
*/
|
|
1079
|
-
connectorLabel?: string;
|
|
1079
|
+
connectorLabel?: string | undefined;
|
|
1080
1080
|
/**
|
|
1081
1081
|
* <p>A description about the connector.</p>
|
|
1082
1082
|
* @public
|
|
1083
1083
|
*/
|
|
1084
|
-
connectorDescription?: string;
|
|
1084
|
+
connectorDescription?: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
1086
|
* <p>The owner who developed the connector.</p>
|
|
1087
1087
|
* @public
|
|
1088
1088
|
*/
|
|
1089
|
-
connectorOwner?: string;
|
|
1089
|
+
connectorOwner?: string | undefined;
|
|
1090
1090
|
/**
|
|
1091
1091
|
* <p>The connector name.</p>
|
|
1092
1092
|
* @public
|
|
1093
1093
|
*/
|
|
1094
|
-
connectorName?: string;
|
|
1094
|
+
connectorName?: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>The connector version.</p>
|
|
1097
1097
|
* @public
|
|
1098
1098
|
*/
|
|
1099
|
-
connectorVersion?: string;
|
|
1099
|
+
connectorVersion?: string | undefined;
|
|
1100
1100
|
/**
|
|
1101
1101
|
* <p>The Amazon Resource Name (ARN) for the registered connector.</p>
|
|
1102
1102
|
* @public
|
|
1103
1103
|
*/
|
|
1104
|
-
connectorArn?: string;
|
|
1104
|
+
connectorArn?: string | undefined;
|
|
1105
1105
|
/**
|
|
1106
1106
|
* <p>The connection modes that the connector supports.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
connectorModes?: string[];
|
|
1109
|
+
connectorModes?: string[] | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>The authentication config required for the connector.</p>
|
|
1112
1112
|
* @public
|
|
1113
1113
|
*/
|
|
1114
|
-
authenticationConfig?: AuthenticationConfig;
|
|
1114
|
+
authenticationConfig?: AuthenticationConfig | undefined;
|
|
1115
1115
|
/**
|
|
1116
1116
|
* <p>The required connector runtime settings.</p>
|
|
1117
1117
|
* @public
|
|
1118
1118
|
*/
|
|
1119
|
-
connectorRuntimeSettings?: ConnectorRuntimeSetting[];
|
|
1119
|
+
connectorRuntimeSettings?: ConnectorRuntimeSetting[] | undefined;
|
|
1120
1120
|
/**
|
|
1121
1121
|
* <p>A list of API versions that are supported by the connector.</p>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
supportedApiVersions?: string[];
|
|
1124
|
+
supportedApiVersions?: string[] | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>A list of operators supported by the connector.</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
supportedOperators?: Operators[];
|
|
1129
|
+
supportedOperators?: Operators[] | undefined;
|
|
1130
1130
|
/**
|
|
1131
1131
|
* <p>A list of write operations supported by the connector.</p>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
supportedWriteOperations?: WriteOperationType[];
|
|
1134
|
+
supportedWriteOperations?: WriteOperationType[] | undefined;
|
|
1135
1135
|
/**
|
|
1136
1136
|
* <p>The provisioning type used to register the connector.</p>
|
|
1137
1137
|
* @public
|
|
1138
1138
|
*/
|
|
1139
|
-
connectorProvisioningType?: ConnectorProvisioningType;
|
|
1139
|
+
connectorProvisioningType?: ConnectorProvisioningType | undefined;
|
|
1140
1140
|
/**
|
|
1141
1141
|
* <p>The configuration required for registering the connector.</p>
|
|
1142
1142
|
* @public
|
|
1143
1143
|
*/
|
|
1144
|
-
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
1144
|
+
connectorProvisioningConfig?: ConnectorProvisioningConfig | undefined;
|
|
1145
1145
|
/**
|
|
1146
1146
|
* <p>Logo URL of the connector.</p>
|
|
1147
1147
|
* @public
|
|
1148
1148
|
*/
|
|
1149
|
-
logoURL?: string;
|
|
1149
|
+
logoURL?: string | undefined;
|
|
1150
1150
|
/**
|
|
1151
1151
|
* <p>The date on which the connector was registered.</p>
|
|
1152
1152
|
* @public
|
|
1153
1153
|
*/
|
|
1154
|
-
registeredAt?: Date;
|
|
1154
|
+
registeredAt?: Date | undefined;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* <p>Information about who registered the connector.</p>
|
|
1157
1157
|
* @public
|
|
1158
1158
|
*/
|
|
1159
|
-
registeredBy?: string;
|
|
1159
|
+
registeredBy?: string | undefined;
|
|
1160
1160
|
/**
|
|
1161
1161
|
* <p>The data transfer types that the connector supports.</p>
|
|
1162
1162
|
* <dl>
|
|
@@ -1171,13 +1171,13 @@ export interface ConnectorConfiguration {
|
|
|
1171
1171
|
* </dl>
|
|
1172
1172
|
* @public
|
|
1173
1173
|
*/
|
|
1174
|
-
supportedDataTransferTypes?: SupportedDataTransferType[];
|
|
1174
|
+
supportedDataTransferTypes?: SupportedDataTransferType[] | undefined;
|
|
1175
1175
|
/**
|
|
1176
1176
|
* <p>The APIs of the connector application that Amazon AppFlow can use to transfer your
|
|
1177
1177
|
* data.</p>
|
|
1178
1178
|
* @public
|
|
1179
1179
|
*/
|
|
1180
|
-
supportedDataTransferApis?: DataTransferApi[];
|
|
1180
|
+
supportedDataTransferApis?: DataTransferApi[] | undefined;
|
|
1181
1181
|
}
|
|
1182
1182
|
/**
|
|
1183
1183
|
* <p>Information about the registered connector.</p>
|
|
@@ -1188,57 +1188,57 @@ export interface ConnectorDetail {
|
|
|
1188
1188
|
* <p>A description about the registered connector.</p>
|
|
1189
1189
|
* @public
|
|
1190
1190
|
*/
|
|
1191
|
-
connectorDescription?: string;
|
|
1191
|
+
connectorDescription?: string | undefined;
|
|
1192
1192
|
/**
|
|
1193
1193
|
* <p>The name of the connector.</p>
|
|
1194
1194
|
* @public
|
|
1195
1195
|
*/
|
|
1196
|
-
connectorName?: string;
|
|
1196
|
+
connectorName?: string | undefined;
|
|
1197
1197
|
/**
|
|
1198
1198
|
* <p>The owner of the connector.</p>
|
|
1199
1199
|
* @public
|
|
1200
1200
|
*/
|
|
1201
|
-
connectorOwner?: string;
|
|
1201
|
+
connectorOwner?: string | undefined;
|
|
1202
1202
|
/**
|
|
1203
1203
|
* <p>The connector version.</p>
|
|
1204
1204
|
* @public
|
|
1205
1205
|
*/
|
|
1206
|
-
connectorVersion?: string;
|
|
1206
|
+
connectorVersion?: string | undefined;
|
|
1207
1207
|
/**
|
|
1208
1208
|
* <p>The application type of the connector.</p>
|
|
1209
1209
|
* @public
|
|
1210
1210
|
*/
|
|
1211
|
-
applicationType?: string;
|
|
1211
|
+
applicationType?: string | undefined;
|
|
1212
1212
|
/**
|
|
1213
1213
|
* <p>The connector type.</p>
|
|
1214
1214
|
* @public
|
|
1215
1215
|
*/
|
|
1216
|
-
connectorType?: ConnectorType;
|
|
1216
|
+
connectorType?: ConnectorType | undefined;
|
|
1217
1217
|
/**
|
|
1218
1218
|
* <p>A label used for the connector.</p>
|
|
1219
1219
|
* @public
|
|
1220
1220
|
*/
|
|
1221
|
-
connectorLabel?: string;
|
|
1221
|
+
connectorLabel?: string | undefined;
|
|
1222
1222
|
/**
|
|
1223
1223
|
* <p>The time at which the connector was registered.</p>
|
|
1224
1224
|
* @public
|
|
1225
1225
|
*/
|
|
1226
|
-
registeredAt?: Date;
|
|
1226
|
+
registeredAt?: Date | undefined;
|
|
1227
1227
|
/**
|
|
1228
1228
|
* <p>The user who registered the connector.</p>
|
|
1229
1229
|
* @public
|
|
1230
1230
|
*/
|
|
1231
|
-
registeredBy?: string;
|
|
1231
|
+
registeredBy?: string | undefined;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* <p>The provisioning type that the connector uses.</p>
|
|
1234
1234
|
* @public
|
|
1235
1235
|
*/
|
|
1236
|
-
connectorProvisioningType?: ConnectorProvisioningType;
|
|
1236
|
+
connectorProvisioningType?: ConnectorProvisioningType | undefined;
|
|
1237
1237
|
/**
|
|
1238
1238
|
* <p>The connection mode that the connector supports.</p>
|
|
1239
1239
|
* @public
|
|
1240
1240
|
*/
|
|
1241
|
-
connectorModes?: string[];
|
|
1241
|
+
connectorModes?: string[] | undefined;
|
|
1242
1242
|
/**
|
|
1243
1243
|
* <p>The data transfer types that the connector supports.</p>
|
|
1244
1244
|
* <dl>
|
|
@@ -1253,7 +1253,7 @@ export interface ConnectorDetail {
|
|
|
1253
1253
|
* </dl>
|
|
1254
1254
|
* @public
|
|
1255
1255
|
*/
|
|
1256
|
-
supportedDataTransferTypes?: SupportedDataTransferType[];
|
|
1256
|
+
supportedDataTransferTypes?: SupportedDataTransferType[] | undefined;
|
|
1257
1257
|
}
|
|
1258
1258
|
/**
|
|
1259
1259
|
* <p> The high-level entity that can be queried in Amazon AppFlow. For example, a
|
|
@@ -1272,7 +1272,7 @@ export interface ConnectorEntity {
|
|
|
1272
1272
|
* <p> The label applied to the connector entity. </p>
|
|
1273
1273
|
* @public
|
|
1274
1274
|
*/
|
|
1275
|
-
label?: string;
|
|
1275
|
+
label?: string | undefined;
|
|
1276
1276
|
/**
|
|
1277
1277
|
* <p> Specifies whether the connector entity is a parent or a category and has more entities
|
|
1278
1278
|
* nested underneath it. If another call is made with <code>entitiesPath =
|
|
@@ -1281,7 +1281,7 @@ export interface ConnectorEntity {
|
|
|
1281
1281
|
* fashion. </p>
|
|
1282
1282
|
* @public
|
|
1283
1283
|
*/
|
|
1284
|
-
hasNestedEntities?: boolean;
|
|
1284
|
+
hasNestedEntities?: boolean | undefined;
|
|
1285
1285
|
}
|
|
1286
1286
|
/**
|
|
1287
1287
|
* <p> The properties that can be applied to a field when connector is being used as a
|
|
@@ -1293,36 +1293,36 @@ export interface DestinationFieldProperties {
|
|
|
1293
1293
|
* <p> Specifies if the destination field can be created by the current user. </p>
|
|
1294
1294
|
* @public
|
|
1295
1295
|
*/
|
|
1296
|
-
isCreatable?: boolean;
|
|
1296
|
+
isCreatable?: boolean | undefined;
|
|
1297
1297
|
/**
|
|
1298
1298
|
* <p> Specifies if the destination field can have a null value. </p>
|
|
1299
1299
|
* @public
|
|
1300
1300
|
*/
|
|
1301
|
-
isNullable?: boolean;
|
|
1301
|
+
isNullable?: boolean | undefined;
|
|
1302
1302
|
/**
|
|
1303
1303
|
* <p> Specifies if the flow run can either insert new rows in the destination field if they do
|
|
1304
1304
|
* not already exist, or update them if they do. </p>
|
|
1305
1305
|
* @public
|
|
1306
1306
|
*/
|
|
1307
|
-
isUpsertable?: boolean;
|
|
1307
|
+
isUpsertable?: boolean | undefined;
|
|
1308
1308
|
/**
|
|
1309
1309
|
* <p> Specifies whether the field can be updated during an <code>UPDATE</code> or
|
|
1310
1310
|
* <code>UPSERT</code> write operation. </p>
|
|
1311
1311
|
* @public
|
|
1312
1312
|
*/
|
|
1313
|
-
isUpdatable?: boolean;
|
|
1313
|
+
isUpdatable?: boolean | undefined;
|
|
1314
1314
|
/**
|
|
1315
1315
|
* <p>Specifies whether the field can use the default value during a Create operation.</p>
|
|
1316
1316
|
* @public
|
|
1317
1317
|
*/
|
|
1318
|
-
isDefaultedOnCreate?: boolean;
|
|
1318
|
+
isDefaultedOnCreate?: boolean | undefined;
|
|
1319
1319
|
/**
|
|
1320
1320
|
* <p> A list of supported write operations. For each write operation listed, this field can be
|
|
1321
1321
|
* used in <code>idFieldNames</code> when that write operation is present as a destination
|
|
1322
1322
|
* option. </p>
|
|
1323
1323
|
* @public
|
|
1324
1324
|
*/
|
|
1325
|
-
supportedWriteOperations?: WriteOperationType[];
|
|
1325
|
+
supportedWriteOperations?: WriteOperationType[] | undefined;
|
|
1326
1326
|
}
|
|
1327
1327
|
/**
|
|
1328
1328
|
* <p> The properties that can be applied to a field when the connector is being used as a
|
|
@@ -1334,17 +1334,17 @@ export interface SourceFieldProperties {
|
|
|
1334
1334
|
* <p> Indicates whether the field can be returned in a search result. </p>
|
|
1335
1335
|
* @public
|
|
1336
1336
|
*/
|
|
1337
|
-
isRetrievable?: boolean;
|
|
1337
|
+
isRetrievable?: boolean | undefined;
|
|
1338
1338
|
/**
|
|
1339
1339
|
* <p> Indicates if the field can be queried. </p>
|
|
1340
1340
|
* @public
|
|
1341
1341
|
*/
|
|
1342
|
-
isQueryable?: boolean;
|
|
1342
|
+
isQueryable?: boolean | undefined;
|
|
1343
1343
|
/**
|
|
1344
1344
|
* <p>Indicates if this timestamp field can be used for incremental queries.</p>
|
|
1345
1345
|
* @public
|
|
1346
1346
|
*/
|
|
1347
|
-
isTimestampFieldForIncrementalQueries?: boolean;
|
|
1347
|
+
isTimestampFieldForIncrementalQueries?: boolean | undefined;
|
|
1348
1348
|
}
|
|
1349
1349
|
/**
|
|
1350
1350
|
* <p>The range of values that the property supports.</p>
|
|
@@ -1355,12 +1355,12 @@ export interface Range {
|
|
|
1355
1355
|
* <p>Maximum value supported by the field.</p>
|
|
1356
1356
|
* @public
|
|
1357
1357
|
*/
|
|
1358
|
-
maximum?: number;
|
|
1358
|
+
maximum?: number | undefined;
|
|
1359
1359
|
/**
|
|
1360
1360
|
* <p>Minimum value supported by the field.</p>
|
|
1361
1361
|
* @public
|
|
1362
1362
|
*/
|
|
1363
|
-
minimum?: number;
|
|
1363
|
+
minimum?: number | undefined;
|
|
1364
1364
|
}
|
|
1365
1365
|
/**
|
|
1366
1366
|
* @public
|
|
@@ -1414,27 +1414,27 @@ export interface FieldTypeDetails {
|
|
|
1414
1414
|
* <code>fieldType</code> can have two values: "true" and "false". </p>
|
|
1415
1415
|
* @public
|
|
1416
1416
|
*/
|
|
1417
|
-
supportedValues?: string[];
|
|
1417
|
+
supportedValues?: string[] | undefined;
|
|
1418
1418
|
/**
|
|
1419
1419
|
* <p>The regular expression pattern for the field name.</p>
|
|
1420
1420
|
* @public
|
|
1421
1421
|
*/
|
|
1422
|
-
valueRegexPattern?: string;
|
|
1422
|
+
valueRegexPattern?: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
1424
|
* <p>The date format that the field supports.</p>
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
|
-
supportedDateFormat?: string;
|
|
1427
|
+
supportedDateFormat?: string | undefined;
|
|
1428
1428
|
/**
|
|
1429
1429
|
* <p>The range of values this field can hold.</p>
|
|
1430
1430
|
* @public
|
|
1431
1431
|
*/
|
|
1432
|
-
fieldValueRange?: Range;
|
|
1432
|
+
fieldValueRange?: Range | undefined;
|
|
1433
1433
|
/**
|
|
1434
1434
|
* <p>This is the allowable length range for this field's value.</p>
|
|
1435
1435
|
* @public
|
|
1436
1436
|
*/
|
|
1437
|
-
fieldLengthRange?: Range;
|
|
1437
|
+
fieldLengthRange?: Range | undefined;
|
|
1438
1438
|
}
|
|
1439
1439
|
/**
|
|
1440
1440
|
* <p> Contains details regarding all the supported <code>FieldTypes</code> and their
|
|
@@ -1465,55 +1465,55 @@ export interface ConnectorEntityField {
|
|
|
1465
1465
|
* <p>The parent identifier of the connector field.</p>
|
|
1466
1466
|
* @public
|
|
1467
1467
|
*/
|
|
1468
|
-
parentIdentifier?: string;
|
|
1468
|
+
parentIdentifier?: string | undefined;
|
|
1469
1469
|
/**
|
|
1470
1470
|
* <p> The label applied to a connector entity field. </p>
|
|
1471
1471
|
* @public
|
|
1472
1472
|
*/
|
|
1473
|
-
label?: string;
|
|
1473
|
+
label?: string | undefined;
|
|
1474
1474
|
/**
|
|
1475
1475
|
* <p>Booelan value that indicates whether this field can be used as a primary key.</p>
|
|
1476
1476
|
* @public
|
|
1477
1477
|
*/
|
|
1478
|
-
isPrimaryKey?: boolean;
|
|
1478
|
+
isPrimaryKey?: boolean | undefined;
|
|
1479
1479
|
/**
|
|
1480
1480
|
* <p>Default value that can be assigned to this field.</p>
|
|
1481
1481
|
* @public
|
|
1482
1482
|
*/
|
|
1483
|
-
defaultValue?: string;
|
|
1483
|
+
defaultValue?: string | undefined;
|
|
1484
1484
|
/**
|
|
1485
1485
|
* <p>Booelan value that indicates whether this field is deprecated or not.</p>
|
|
1486
1486
|
* @public
|
|
1487
1487
|
*/
|
|
1488
|
-
isDeprecated?: boolean;
|
|
1488
|
+
isDeprecated?: boolean | undefined;
|
|
1489
1489
|
/**
|
|
1490
1490
|
* <p> Contains details regarding the supported <code>FieldType</code>, including the
|
|
1491
1491
|
* corresponding <code>filterOperators</code> and <code>supportedValues</code>. </p>
|
|
1492
1492
|
* @public
|
|
1493
1493
|
*/
|
|
1494
|
-
supportedFieldTypeDetails?: SupportedFieldTypeDetails;
|
|
1494
|
+
supportedFieldTypeDetails?: SupportedFieldTypeDetails | undefined;
|
|
1495
1495
|
/**
|
|
1496
1496
|
* <p> A description of the connector entity field. </p>
|
|
1497
1497
|
* @public
|
|
1498
1498
|
*/
|
|
1499
|
-
description?: string;
|
|
1499
|
+
description?: string | undefined;
|
|
1500
1500
|
/**
|
|
1501
1501
|
* <p> The properties that can be applied to a field when the connector is being used as a
|
|
1502
1502
|
* source. </p>
|
|
1503
1503
|
* @public
|
|
1504
1504
|
*/
|
|
1505
|
-
sourceProperties?: SourceFieldProperties;
|
|
1505
|
+
sourceProperties?: SourceFieldProperties | undefined;
|
|
1506
1506
|
/**
|
|
1507
1507
|
* <p> The properties applied to a field when the connector is being used as a destination.
|
|
1508
1508
|
* </p>
|
|
1509
1509
|
* @public
|
|
1510
1510
|
*/
|
|
1511
|
-
destinationProperties?: DestinationFieldProperties;
|
|
1511
|
+
destinationProperties?: DestinationFieldProperties | undefined;
|
|
1512
1512
|
/**
|
|
1513
1513
|
* <p>A map that has specific properties related to the ConnectorEntityField.</p>
|
|
1514
1514
|
* @public
|
|
1515
1515
|
*/
|
|
1516
|
-
customProperties?: Record<string, string
|
|
1516
|
+
customProperties?: Record<string, string> | undefined;
|
|
1517
1517
|
}
|
|
1518
1518
|
/**
|
|
1519
1519
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
@@ -1526,13 +1526,13 @@ export interface ConnectorOAuthRequest {
|
|
|
1526
1526
|
* </p>
|
|
1527
1527
|
* @public
|
|
1528
1528
|
*/
|
|
1529
|
-
authCode?: string;
|
|
1529
|
+
authCode?: string | undefined;
|
|
1530
1530
|
/**
|
|
1531
1531
|
* <p> The URL to which the authentication server redirects the browser after authorization has
|
|
1532
1532
|
* been granted. </p>
|
|
1533
1533
|
* @public
|
|
1534
1534
|
*/
|
|
1535
|
-
redirectUri?: string;
|
|
1535
|
+
redirectUri?: string | undefined;
|
|
1536
1536
|
}
|
|
1537
1537
|
/**
|
|
1538
1538
|
* @public
|
|
@@ -1935,87 +1935,87 @@ export interface ConnectorOperator {
|
|
|
1935
1935
|
* <p> The operation to be performed on the provided Amplitude source fields. </p>
|
|
1936
1936
|
* @public
|
|
1937
1937
|
*/
|
|
1938
|
-
Amplitude?: AmplitudeConnectorOperator;
|
|
1938
|
+
Amplitude?: AmplitudeConnectorOperator | undefined;
|
|
1939
1939
|
/**
|
|
1940
1940
|
* <p> The operation to be performed on the provided Datadog source fields. </p>
|
|
1941
1941
|
* @public
|
|
1942
1942
|
*/
|
|
1943
|
-
Datadog?: DatadogConnectorOperator;
|
|
1943
|
+
Datadog?: DatadogConnectorOperator | undefined;
|
|
1944
1944
|
/**
|
|
1945
1945
|
* <p> The operation to be performed on the provided Dynatrace source fields. </p>
|
|
1946
1946
|
* @public
|
|
1947
1947
|
*/
|
|
1948
|
-
Dynatrace?: DynatraceConnectorOperator;
|
|
1948
|
+
Dynatrace?: DynatraceConnectorOperator | undefined;
|
|
1949
1949
|
/**
|
|
1950
1950
|
* <p> The operation to be performed on the provided Google Analytics source fields. </p>
|
|
1951
1951
|
* @public
|
|
1952
1952
|
*/
|
|
1953
|
-
GoogleAnalytics?: GoogleAnalyticsConnectorOperator;
|
|
1953
|
+
GoogleAnalytics?: GoogleAnalyticsConnectorOperator | undefined;
|
|
1954
1954
|
/**
|
|
1955
1955
|
* <p> The operation to be performed on the provided Infor Nexus source fields. </p>
|
|
1956
1956
|
* @public
|
|
1957
1957
|
*/
|
|
1958
|
-
InforNexus?: InforNexusConnectorOperator;
|
|
1958
|
+
InforNexus?: InforNexusConnectorOperator | undefined;
|
|
1959
1959
|
/**
|
|
1960
1960
|
* <p> The operation to be performed on the provided Marketo source fields. </p>
|
|
1961
1961
|
* @public
|
|
1962
1962
|
*/
|
|
1963
|
-
Marketo?: MarketoConnectorOperator;
|
|
1963
|
+
Marketo?: MarketoConnectorOperator | undefined;
|
|
1964
1964
|
/**
|
|
1965
1965
|
* <p> The operation to be performed on the provided Amazon S3 source fields. </p>
|
|
1966
1966
|
* @public
|
|
1967
1967
|
*/
|
|
1968
|
-
S3?: S3ConnectorOperator;
|
|
1968
|
+
S3?: S3ConnectorOperator | undefined;
|
|
1969
1969
|
/**
|
|
1970
1970
|
* <p> The operation to be performed on the provided Salesforce source fields. </p>
|
|
1971
1971
|
* @public
|
|
1972
1972
|
*/
|
|
1973
|
-
Salesforce?: SalesforceConnectorOperator;
|
|
1973
|
+
Salesforce?: SalesforceConnectorOperator | undefined;
|
|
1974
1974
|
/**
|
|
1975
1975
|
* <p> The operation to be performed on the provided ServiceNow source fields. </p>
|
|
1976
1976
|
* @public
|
|
1977
1977
|
*/
|
|
1978
|
-
ServiceNow?: ServiceNowConnectorOperator;
|
|
1978
|
+
ServiceNow?: ServiceNowConnectorOperator | undefined;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* <p> The operation to be performed on the provided Singular source fields. </p>
|
|
1981
1981
|
* @public
|
|
1982
1982
|
*/
|
|
1983
|
-
Singular?: SingularConnectorOperator;
|
|
1983
|
+
Singular?: SingularConnectorOperator | undefined;
|
|
1984
1984
|
/**
|
|
1985
1985
|
* <p> The operation to be performed on the provided Slack source fields. </p>
|
|
1986
1986
|
* @public
|
|
1987
1987
|
*/
|
|
1988
|
-
Slack?: SlackConnectorOperator;
|
|
1988
|
+
Slack?: SlackConnectorOperator | undefined;
|
|
1989
1989
|
/**
|
|
1990
1990
|
* <p> The operation to be performed on the provided Trend Micro source fields. </p>
|
|
1991
1991
|
* @public
|
|
1992
1992
|
*/
|
|
1993
|
-
Trendmicro?: TrendmicroConnectorOperator;
|
|
1993
|
+
Trendmicro?: TrendmicroConnectorOperator | undefined;
|
|
1994
1994
|
/**
|
|
1995
1995
|
* <p> The operation to be performed on the provided Veeva source fields. </p>
|
|
1996
1996
|
* @public
|
|
1997
1997
|
*/
|
|
1998
|
-
Veeva?: VeevaConnectorOperator;
|
|
1998
|
+
Veeva?: VeevaConnectorOperator | undefined;
|
|
1999
1999
|
/**
|
|
2000
2000
|
* <p> The operation to be performed on the provided Zendesk source fields. </p>
|
|
2001
2001
|
* @public
|
|
2002
2002
|
*/
|
|
2003
|
-
Zendesk?: ZendeskConnectorOperator;
|
|
2003
|
+
Zendesk?: ZendeskConnectorOperator | undefined;
|
|
2004
2004
|
/**
|
|
2005
2005
|
* <p> The operation to be performed on the provided SAPOData source fields. </p>
|
|
2006
2006
|
* @public
|
|
2007
2007
|
*/
|
|
2008
|
-
SAPOData?: SAPODataConnectorOperator;
|
|
2008
|
+
SAPOData?: SAPODataConnectorOperator | undefined;
|
|
2009
2009
|
/**
|
|
2010
2010
|
* <p>Operators supported by the custom connector.</p>
|
|
2011
2011
|
* @public
|
|
2012
2012
|
*/
|
|
2013
|
-
CustomConnector?: Operator;
|
|
2013
|
+
CustomConnector?: Operator | undefined;
|
|
2014
2014
|
/**
|
|
2015
2015
|
* <p>The operation to be performed on the provided Salesforce Pardot source fields.</p>
|
|
2016
2016
|
* @public
|
|
2017
2017
|
*/
|
|
2018
|
-
Pardot?: PardotConnectorOperator;
|
|
2018
|
+
Pardot?: PardotConnectorOperator | undefined;
|
|
2019
2019
|
}
|
|
2020
2020
|
/**
|
|
2021
2021
|
* <p>The OAuth 2.0 properties required for OAuth 2.0 authentication.</p>
|
|
@@ -2038,7 +2038,7 @@ export interface OAuth2Properties {
|
|
|
2038
2038
|
* request.</p>
|
|
2039
2039
|
* @public
|
|
2040
2040
|
*/
|
|
2041
|
-
tokenUrlCustomProperties?: Record<string, string
|
|
2041
|
+
tokenUrlCustomProperties?: Record<string, string> | undefined;
|
|
2042
2042
|
}
|
|
2043
2043
|
/**
|
|
2044
2044
|
* <p>The profile properties required by the custom connector.</p>
|
|
@@ -2049,12 +2049,12 @@ export interface CustomConnectorProfileProperties {
|
|
|
2049
2049
|
* <p>A map of properties that are required to create a profile for the custom connector.</p>
|
|
2050
2050
|
* @public
|
|
2051
2051
|
*/
|
|
2052
|
-
profileProperties?: Record<string, string
|
|
2052
|
+
profileProperties?: Record<string, string> | undefined;
|
|
2053
2053
|
/**
|
|
2054
2054
|
* <p>The OAuth 2.0 properties required for OAuth 2.0 authentication.</p>
|
|
2055
2055
|
* @public
|
|
2056
2056
|
*/
|
|
2057
|
-
oAuth2Properties?: OAuth2Properties;
|
|
2057
|
+
oAuth2Properties?: OAuth2Properties | undefined;
|
|
2058
2058
|
}
|
|
2059
2059
|
/**
|
|
2060
2060
|
* <p> The connector-specific profile properties required by Datadog. </p>
|
|
@@ -2121,18 +2121,18 @@ export interface PardotConnectorProfileProperties {
|
|
|
2121
2121
|
* <p>The location of the Salesforce Pardot resource.</p>
|
|
2122
2122
|
* @public
|
|
2123
2123
|
*/
|
|
2124
|
-
instanceUrl?: string;
|
|
2124
|
+
instanceUrl?: string | undefined;
|
|
2125
2125
|
/**
|
|
2126
2126
|
* <p>Indicates whether the connector profile applies to a sandbox or production
|
|
2127
2127
|
* environment.</p>
|
|
2128
2128
|
* @public
|
|
2129
2129
|
*/
|
|
2130
|
-
isSandboxEnvironment?: boolean;
|
|
2130
|
+
isSandboxEnvironment?: boolean | undefined;
|
|
2131
2131
|
/**
|
|
2132
2132
|
* <p>The business unit id of Salesforce Pardot instance.</p>
|
|
2133
2133
|
* @public
|
|
2134
2134
|
*/
|
|
2135
|
-
businessUnitId?: string;
|
|
2135
|
+
businessUnitId?: string | undefined;
|
|
2136
2136
|
}
|
|
2137
2137
|
/**
|
|
2138
2138
|
* <p> The connector-specific profile properties when using Amazon Redshift. </p>
|
|
@@ -2143,7 +2143,7 @@ export interface RedshiftConnectorProfileProperties {
|
|
|
2143
2143
|
* <p> The JDBC URL of the Amazon Redshift cluster. </p>
|
|
2144
2144
|
* @public
|
|
2145
2145
|
*/
|
|
2146
|
-
databaseUrl?: string;
|
|
2146
|
+
databaseUrl?: string | undefined;
|
|
2147
2147
|
/**
|
|
2148
2148
|
* <p> A name for the associated Amazon S3 bucket. </p>
|
|
2149
2149
|
* @public
|
|
@@ -2154,7 +2154,7 @@ export interface RedshiftConnectorProfileProperties {
|
|
|
2154
2154
|
* </p>
|
|
2155
2155
|
* @public
|
|
2156
2156
|
*/
|
|
2157
|
-
bucketPrefix?: string;
|
|
2157
|
+
bucketPrefix?: string | undefined;
|
|
2158
2158
|
/**
|
|
2159
2159
|
* <p> The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift
|
|
2160
2160
|
* read-only access to Amazon S3. For more information, and for the polices that you
|
|
@@ -2168,28 +2168,28 @@ export interface RedshiftConnectorProfileProperties {
|
|
|
2168
2168
|
* API</a>.</p>
|
|
2169
2169
|
* @public
|
|
2170
2170
|
*/
|
|
2171
|
-
dataApiRoleArn?: string;
|
|
2171
|
+
dataApiRoleArn?: string | undefined;
|
|
2172
2172
|
/**
|
|
2173
2173
|
* <p>Indicates whether the connector profile defines a connection to an Amazon Redshift
|
|
2174
2174
|
* Serverless data warehouse.</p>
|
|
2175
2175
|
* @public
|
|
2176
2176
|
*/
|
|
2177
|
-
isRedshiftServerless?: boolean;
|
|
2177
|
+
isRedshiftServerless?: boolean | undefined;
|
|
2178
2178
|
/**
|
|
2179
2179
|
* <p>The unique ID that's assigned to an Amazon Redshift cluster.</p>
|
|
2180
2180
|
* @public
|
|
2181
2181
|
*/
|
|
2182
|
-
clusterIdentifier?: string;
|
|
2182
|
+
clusterIdentifier?: string | undefined;
|
|
2183
2183
|
/**
|
|
2184
2184
|
* <p>The name of an Amazon Redshift workgroup.</p>
|
|
2185
2185
|
* @public
|
|
2186
2186
|
*/
|
|
2187
|
-
workgroupName?: string;
|
|
2187
|
+
workgroupName?: string | undefined;
|
|
2188
2188
|
/**
|
|
2189
2189
|
* <p>The name of an Amazon Redshift database.</p>
|
|
2190
2190
|
* @public
|
|
2191
2191
|
*/
|
|
2192
|
-
databaseName?: string;
|
|
2192
|
+
databaseName?: string | undefined;
|
|
2193
2193
|
}
|
|
2194
2194
|
/**
|
|
2195
2195
|
* <p> The connector-specific profile properties required when using Salesforce. </p>
|
|
@@ -2200,13 +2200,13 @@ export interface SalesforceConnectorProfileProperties {
|
|
|
2200
2200
|
* <p> The location of the Salesforce resource. </p>
|
|
2201
2201
|
* @public
|
|
2202
2202
|
*/
|
|
2203
|
-
instanceUrl?: string;
|
|
2203
|
+
instanceUrl?: string | undefined;
|
|
2204
2204
|
/**
|
|
2205
2205
|
* <p> Indicates whether the connector profile applies to a sandbox or production environment.
|
|
2206
2206
|
* </p>
|
|
2207
2207
|
* @public
|
|
2208
2208
|
*/
|
|
2209
|
-
isSandboxEnvironment?: boolean;
|
|
2209
|
+
isSandboxEnvironment?: boolean | undefined;
|
|
2210
2210
|
/**
|
|
2211
2211
|
* <p>If the connection mode for the connector profile is private, this parameter sets whether
|
|
2212
2212
|
* Amazon AppFlow uses the private network to send metadata and authorization calls to
|
|
@@ -2256,7 +2256,7 @@ export interface SalesforceConnectorProfileProperties {
|
|
|
2256
2256
|
* </dl>
|
|
2257
2257
|
* @public
|
|
2258
2258
|
*/
|
|
2259
|
-
usePrivateLinkForMetadataAndAuthorization?: boolean;
|
|
2259
|
+
usePrivateLinkForMetadataAndAuthorization?: boolean | undefined;
|
|
2260
2260
|
}
|
|
2261
2261
|
/**
|
|
2262
2262
|
* <p> The OAuth properties required for OAuth type authentication. </p>
|
|
@@ -2310,17 +2310,17 @@ export interface SAPODataConnectorProfileProperties {
|
|
|
2310
2310
|
* <p> The logon language of SAPOData instance. </p>
|
|
2311
2311
|
* @public
|
|
2312
2312
|
*/
|
|
2313
|
-
logonLanguage?: string;
|
|
2313
|
+
logonLanguage?: string | undefined;
|
|
2314
2314
|
/**
|
|
2315
2315
|
* <p> The SAPOData Private Link service name to be used for private data transfers. </p>
|
|
2316
2316
|
* @public
|
|
2317
2317
|
*/
|
|
2318
|
-
privateLinkServiceName?: string;
|
|
2318
|
+
privateLinkServiceName?: string | undefined;
|
|
2319
2319
|
/**
|
|
2320
2320
|
* <p> The SAPOData OAuth properties required for OAuth type authentication. </p>
|
|
2321
2321
|
* @public
|
|
2322
2322
|
*/
|
|
2323
|
-
oAuthProperties?: OAuthProperties;
|
|
2323
|
+
oAuthProperties?: OAuthProperties | undefined;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* <p>If you set this parameter to <code>true</code>, Amazon AppFlow bypasses the single
|
|
2326
2326
|
* sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.</p>
|
|
@@ -2332,7 +2332,7 @@ export interface SAPODataConnectorProfileProperties {
|
|
|
2332
2332
|
* affect.</p>
|
|
2333
2333
|
* @public
|
|
2334
2334
|
*/
|
|
2335
|
-
disableSSO?: boolean;
|
|
2335
|
+
disableSSO?: boolean | undefined;
|
|
2336
2336
|
}
|
|
2337
2337
|
/**
|
|
2338
2338
|
* <p> The connector-specific profile properties required when using ServiceNow. </p>
|
|
@@ -2388,22 +2388,22 @@ export interface SnowflakeConnectorProfileProperties {
|
|
|
2388
2388
|
* </p>
|
|
2389
2389
|
* @public
|
|
2390
2390
|
*/
|
|
2391
|
-
bucketPrefix?: string;
|
|
2391
|
+
bucketPrefix?: string | undefined;
|
|
2392
2392
|
/**
|
|
2393
2393
|
* <p> The Snowflake Private Link service name to be used for private data transfers. </p>
|
|
2394
2394
|
* @public
|
|
2395
2395
|
*/
|
|
2396
|
-
privateLinkServiceName?: string;
|
|
2396
|
+
privateLinkServiceName?: string | undefined;
|
|
2397
2397
|
/**
|
|
2398
2398
|
* <p> The name of the account. </p>
|
|
2399
2399
|
* @public
|
|
2400
2400
|
*/
|
|
2401
|
-
accountName?: string;
|
|
2401
|
+
accountName?: string | undefined;
|
|
2402
2402
|
/**
|
|
2403
2403
|
* <p> The Amazon Web Services Region of the Snowflake account. </p>
|
|
2404
2404
|
* @public
|
|
2405
2405
|
*/
|
|
2406
|
-
region?: string;
|
|
2406
|
+
region?: string | undefined;
|
|
2407
2407
|
}
|
|
2408
2408
|
/**
|
|
2409
2409
|
* <p> The connector-specific profile properties required when using Trend Micro. </p>
|
|
@@ -2442,97 +2442,97 @@ export interface ConnectorProfileProperties {
|
|
|
2442
2442
|
* <p> The connector-specific properties required by Amplitude. </p>
|
|
2443
2443
|
* @public
|
|
2444
2444
|
*/
|
|
2445
|
-
Amplitude?: AmplitudeConnectorProfileProperties;
|
|
2445
|
+
Amplitude?: AmplitudeConnectorProfileProperties | undefined;
|
|
2446
2446
|
/**
|
|
2447
2447
|
* <p> The connector-specific properties required by Datadog. </p>
|
|
2448
2448
|
* @public
|
|
2449
2449
|
*/
|
|
2450
|
-
Datadog?: DatadogConnectorProfileProperties;
|
|
2450
|
+
Datadog?: DatadogConnectorProfileProperties | undefined;
|
|
2451
2451
|
/**
|
|
2452
2452
|
* <p> The connector-specific properties required by Dynatrace. </p>
|
|
2453
2453
|
* @public
|
|
2454
2454
|
*/
|
|
2455
|
-
Dynatrace?: DynatraceConnectorProfileProperties;
|
|
2455
|
+
Dynatrace?: DynatraceConnectorProfileProperties | undefined;
|
|
2456
2456
|
/**
|
|
2457
2457
|
* <p> The connector-specific properties required Google Analytics. </p>
|
|
2458
2458
|
* @public
|
|
2459
2459
|
*/
|
|
2460
|
-
GoogleAnalytics?: GoogleAnalyticsConnectorProfileProperties;
|
|
2460
|
+
GoogleAnalytics?: GoogleAnalyticsConnectorProfileProperties | undefined;
|
|
2461
2461
|
/**
|
|
2462
2462
|
* <p> The connector-specific properties required by Amazon Honeycode. </p>
|
|
2463
2463
|
* @public
|
|
2464
2464
|
*/
|
|
2465
|
-
Honeycode?: HoneycodeConnectorProfileProperties;
|
|
2465
|
+
Honeycode?: HoneycodeConnectorProfileProperties | undefined;
|
|
2466
2466
|
/**
|
|
2467
2467
|
* <p> The connector-specific properties required by Infor Nexus. </p>
|
|
2468
2468
|
* @public
|
|
2469
2469
|
*/
|
|
2470
|
-
InforNexus?: InforNexusConnectorProfileProperties;
|
|
2470
|
+
InforNexus?: InforNexusConnectorProfileProperties | undefined;
|
|
2471
2471
|
/**
|
|
2472
2472
|
* <p> The connector-specific properties required by Marketo. </p>
|
|
2473
2473
|
* @public
|
|
2474
2474
|
*/
|
|
2475
|
-
Marketo?: MarketoConnectorProfileProperties;
|
|
2475
|
+
Marketo?: MarketoConnectorProfileProperties | undefined;
|
|
2476
2476
|
/**
|
|
2477
2477
|
* <p> The connector-specific properties required by Amazon Redshift. </p>
|
|
2478
2478
|
* @public
|
|
2479
2479
|
*/
|
|
2480
|
-
Redshift?: RedshiftConnectorProfileProperties;
|
|
2480
|
+
Redshift?: RedshiftConnectorProfileProperties | undefined;
|
|
2481
2481
|
/**
|
|
2482
2482
|
* <p> The connector-specific properties required by Salesforce. </p>
|
|
2483
2483
|
* @public
|
|
2484
2484
|
*/
|
|
2485
|
-
Salesforce?: SalesforceConnectorProfileProperties;
|
|
2485
|
+
Salesforce?: SalesforceConnectorProfileProperties | undefined;
|
|
2486
2486
|
/**
|
|
2487
2487
|
* <p> The connector-specific properties required by serviceNow. </p>
|
|
2488
2488
|
* @public
|
|
2489
2489
|
*/
|
|
2490
|
-
ServiceNow?: ServiceNowConnectorProfileProperties;
|
|
2490
|
+
ServiceNow?: ServiceNowConnectorProfileProperties | undefined;
|
|
2491
2491
|
/**
|
|
2492
2492
|
* <p> The connector-specific properties required by Singular. </p>
|
|
2493
2493
|
* @public
|
|
2494
2494
|
*/
|
|
2495
|
-
Singular?: SingularConnectorProfileProperties;
|
|
2495
|
+
Singular?: SingularConnectorProfileProperties | undefined;
|
|
2496
2496
|
/**
|
|
2497
2497
|
* <p> The connector-specific properties required by Slack. </p>
|
|
2498
2498
|
* @public
|
|
2499
2499
|
*/
|
|
2500
|
-
Slack?: SlackConnectorProfileProperties;
|
|
2500
|
+
Slack?: SlackConnectorProfileProperties | undefined;
|
|
2501
2501
|
/**
|
|
2502
2502
|
* <p> The connector-specific properties required by Snowflake. </p>
|
|
2503
2503
|
* @public
|
|
2504
2504
|
*/
|
|
2505
|
-
Snowflake?: SnowflakeConnectorProfileProperties;
|
|
2505
|
+
Snowflake?: SnowflakeConnectorProfileProperties | undefined;
|
|
2506
2506
|
/**
|
|
2507
2507
|
* <p> The connector-specific properties required by Trend Micro. </p>
|
|
2508
2508
|
* @public
|
|
2509
2509
|
*/
|
|
2510
|
-
Trendmicro?: TrendmicroConnectorProfileProperties;
|
|
2510
|
+
Trendmicro?: TrendmicroConnectorProfileProperties | undefined;
|
|
2511
2511
|
/**
|
|
2512
2512
|
* <p> The connector-specific properties required by Veeva. </p>
|
|
2513
2513
|
* @public
|
|
2514
2514
|
*/
|
|
2515
|
-
Veeva?: VeevaConnectorProfileProperties;
|
|
2515
|
+
Veeva?: VeevaConnectorProfileProperties | undefined;
|
|
2516
2516
|
/**
|
|
2517
2517
|
* <p> The connector-specific properties required by Zendesk. </p>
|
|
2518
2518
|
* @public
|
|
2519
2519
|
*/
|
|
2520
|
-
Zendesk?: ZendeskConnectorProfileProperties;
|
|
2520
|
+
Zendesk?: ZendeskConnectorProfileProperties | undefined;
|
|
2521
2521
|
/**
|
|
2522
2522
|
* <p> The connector-specific profile properties required when using SAPOData. </p>
|
|
2523
2523
|
* @public
|
|
2524
2524
|
*/
|
|
2525
|
-
SAPOData?: SAPODataConnectorProfileProperties;
|
|
2525
|
+
SAPOData?: SAPODataConnectorProfileProperties | undefined;
|
|
2526
2526
|
/**
|
|
2527
2527
|
* <p>The properties required by the custom connector.</p>
|
|
2528
2528
|
* @public
|
|
2529
2529
|
*/
|
|
2530
|
-
CustomConnector?: CustomConnectorProfileProperties;
|
|
2530
|
+
CustomConnector?: CustomConnectorProfileProperties | undefined;
|
|
2531
2531
|
/**
|
|
2532
2532
|
* <p>The connector-specific properties required by Salesforce Pardot.</p>
|
|
2533
2533
|
* @public
|
|
2534
2534
|
*/
|
|
2535
|
-
Pardot?: PardotConnectorProfileProperties;
|
|
2535
|
+
Pardot?: PardotConnectorProfileProperties | undefined;
|
|
2536
2536
|
}
|
|
2537
2537
|
/**
|
|
2538
2538
|
* @public
|
|
@@ -2571,17 +2571,17 @@ export interface PrivateConnectionProvisioningState {
|
|
|
2571
2571
|
* <p> Specifies the private connection provisioning status. </p>
|
|
2572
2572
|
* @public
|
|
2573
2573
|
*/
|
|
2574
|
-
status?: PrivateConnectionProvisioningStatus;
|
|
2574
|
+
status?: PrivateConnectionProvisioningStatus | undefined;
|
|
2575
2575
|
/**
|
|
2576
2576
|
* <p> Specifies the private connection provisioning failure reason. </p>
|
|
2577
2577
|
* @public
|
|
2578
2578
|
*/
|
|
2579
|
-
failureMessage?: string;
|
|
2579
|
+
failureMessage?: string | undefined;
|
|
2580
2580
|
/**
|
|
2581
2581
|
* <p> Specifies the private connection provisioning failure cause. </p>
|
|
2582
2582
|
* @public
|
|
2583
2583
|
*/
|
|
2584
|
-
failureCause?: PrivateConnectionProvisioningFailureCause;
|
|
2584
|
+
failureCause?: PrivateConnectionProvisioningFailureCause | undefined;
|
|
2585
2585
|
}
|
|
2586
2586
|
/**
|
|
2587
2587
|
* <p> Describes an instance of a connector. This includes the provided name, credentials ARN,
|
|
@@ -2596,53 +2596,53 @@ export interface ConnectorProfile {
|
|
|
2596
2596
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
2597
2597
|
* @public
|
|
2598
2598
|
*/
|
|
2599
|
-
connectorProfileArn?: string;
|
|
2599
|
+
connectorProfileArn?: string | undefined;
|
|
2600
2600
|
/**
|
|
2601
2601
|
* <p> The name of the connector profile. The name is unique for each
|
|
2602
2602
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
2603
2603
|
* @public
|
|
2604
2604
|
*/
|
|
2605
|
-
connectorProfileName?: string;
|
|
2605
|
+
connectorProfileName?: string | undefined;
|
|
2606
2606
|
/**
|
|
2607
2607
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
2608
2608
|
* @public
|
|
2609
2609
|
*/
|
|
2610
|
-
connectorType?: ConnectorType;
|
|
2610
|
+
connectorType?: ConnectorType | undefined;
|
|
2611
2611
|
/**
|
|
2612
2612
|
* <p>The label for the connector profile being created.</p>
|
|
2613
2613
|
* @public
|
|
2614
2614
|
*/
|
|
2615
|
-
connectorLabel?: string;
|
|
2615
|
+
connectorLabel?: string | undefined;
|
|
2616
2616
|
/**
|
|
2617
2617
|
* <p> Indicates the connection mode and if it is public or private. </p>
|
|
2618
2618
|
* @public
|
|
2619
2619
|
*/
|
|
2620
|
-
connectionMode?: ConnectionMode;
|
|
2620
|
+
connectionMode?: ConnectionMode | undefined;
|
|
2621
2621
|
/**
|
|
2622
2622
|
* <p> The Amazon Resource Name (ARN) of the connector profile credentials. </p>
|
|
2623
2623
|
* @public
|
|
2624
2624
|
*/
|
|
2625
|
-
credentialsArn?: string;
|
|
2625
|
+
credentialsArn?: string | undefined;
|
|
2626
2626
|
/**
|
|
2627
2627
|
* <p> The connector-specific properties of the profile configuration. </p>
|
|
2628
2628
|
* @public
|
|
2629
2629
|
*/
|
|
2630
|
-
connectorProfileProperties?: ConnectorProfileProperties;
|
|
2630
|
+
connectorProfileProperties?: ConnectorProfileProperties | undefined;
|
|
2631
2631
|
/**
|
|
2632
2632
|
* <p> Specifies when the connector profile was created. </p>
|
|
2633
2633
|
* @public
|
|
2634
2634
|
*/
|
|
2635
|
-
createdAt?: Date;
|
|
2635
|
+
createdAt?: Date | undefined;
|
|
2636
2636
|
/**
|
|
2637
2637
|
* <p> Specifies when the connector profile was last updated. </p>
|
|
2638
2638
|
* @public
|
|
2639
2639
|
*/
|
|
2640
|
-
lastUpdatedAt?: Date;
|
|
2640
|
+
lastUpdatedAt?: Date | undefined;
|
|
2641
2641
|
/**
|
|
2642
2642
|
* <p> Specifies the private connection provisioning state. </p>
|
|
2643
2643
|
* @public
|
|
2644
2644
|
*/
|
|
2645
|
-
privateConnectionProvisioningState?: PrivateConnectionProvisioningState;
|
|
2645
|
+
privateConnectionProvisioningState?: PrivateConnectionProvisioningState | undefined;
|
|
2646
2646
|
}
|
|
2647
2647
|
/**
|
|
2648
2648
|
* <p>The custom credentials required for custom authentication.</p>
|
|
@@ -2658,7 +2658,7 @@ export interface CustomAuthCredentials {
|
|
|
2658
2658
|
* <p>A map that holds custom authentication credentials.</p>
|
|
2659
2659
|
* @public
|
|
2660
2660
|
*/
|
|
2661
|
-
credentialsMap?: Record<string, string
|
|
2661
|
+
credentialsMap?: Record<string, string> | undefined;
|
|
2662
2662
|
}
|
|
2663
2663
|
/**
|
|
2664
2664
|
* <p>The OAuth 2.0 credentials required for OAuth 2.0 authentication.</p>
|
|
@@ -2669,29 +2669,29 @@ export interface OAuth2Credentials {
|
|
|
2669
2669
|
* <p>The identifier for the desired client.</p>
|
|
2670
2670
|
* @public
|
|
2671
2671
|
*/
|
|
2672
|
-
clientId?: string;
|
|
2672
|
+
clientId?: string | undefined;
|
|
2673
2673
|
/**
|
|
2674
2674
|
* <p>The client secret used by the OAuth client to authenticate to the authorization
|
|
2675
2675
|
* server.</p>
|
|
2676
2676
|
* @public
|
|
2677
2677
|
*/
|
|
2678
|
-
clientSecret?: string;
|
|
2678
|
+
clientSecret?: string | undefined;
|
|
2679
2679
|
/**
|
|
2680
2680
|
* <p>The access token used to access the connector on your behalf.</p>
|
|
2681
2681
|
* @public
|
|
2682
2682
|
*/
|
|
2683
|
-
accessToken?: string;
|
|
2683
|
+
accessToken?: string | undefined;
|
|
2684
2684
|
/**
|
|
2685
2685
|
* <p>The refresh token used to refresh an expired access token.</p>
|
|
2686
2686
|
* @public
|
|
2687
2687
|
*/
|
|
2688
|
-
refreshToken?: string;
|
|
2688
|
+
refreshToken?: string | undefined;
|
|
2689
2689
|
/**
|
|
2690
2690
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2691
2691
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2692
2692
|
* @public
|
|
2693
2693
|
*/
|
|
2694
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2694
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2695
2695
|
}
|
|
2696
2696
|
/**
|
|
2697
2697
|
* <p>The connector-specific profile credentials that are required when using the custom
|
|
@@ -2709,23 +2709,23 @@ export interface CustomConnectorProfileCredentials {
|
|
|
2709
2709
|
* <p>The basic credentials that are required for the authentication of the user.</p>
|
|
2710
2710
|
* @public
|
|
2711
2711
|
*/
|
|
2712
|
-
basic?: BasicAuthCredentials;
|
|
2712
|
+
basic?: BasicAuthCredentials | undefined;
|
|
2713
2713
|
/**
|
|
2714
2714
|
* <p>The OAuth 2.0 credentials required for the authentication of the user.</p>
|
|
2715
2715
|
* @public
|
|
2716
2716
|
*/
|
|
2717
|
-
oauth2?: OAuth2Credentials;
|
|
2717
|
+
oauth2?: OAuth2Credentials | undefined;
|
|
2718
2718
|
/**
|
|
2719
2719
|
* <p>The API keys required for the authentication of the user.</p>
|
|
2720
2720
|
* @public
|
|
2721
2721
|
*/
|
|
2722
|
-
apiKey?: ApiKeyCredentials;
|
|
2722
|
+
apiKey?: ApiKeyCredentials | undefined;
|
|
2723
2723
|
/**
|
|
2724
2724
|
* <p>If the connector uses the custom authentication mechanism, this holds the required
|
|
2725
2725
|
* credentials.</p>
|
|
2726
2726
|
* @public
|
|
2727
2727
|
*/
|
|
2728
|
-
custom?: CustomAuthCredentials;
|
|
2728
|
+
custom?: CustomAuthCredentials | undefined;
|
|
2729
2729
|
}
|
|
2730
2730
|
/**
|
|
2731
2731
|
* <p> The connector-specific credentials required by Datadog. </p>
|
|
@@ -2777,19 +2777,19 @@ export interface GoogleAnalyticsConnectorProfileCredentials {
|
|
|
2777
2777
|
* <p> The credentials used to access protected Google Analytics resources. </p>
|
|
2778
2778
|
* @public
|
|
2779
2779
|
*/
|
|
2780
|
-
accessToken?: string;
|
|
2780
|
+
accessToken?: string | undefined;
|
|
2781
2781
|
/**
|
|
2782
2782
|
* <p> The credentials used to acquire new access tokens. This is required only for OAuth2
|
|
2783
2783
|
* access tokens, and is not required for OAuth1 access tokens. </p>
|
|
2784
2784
|
* @public
|
|
2785
2785
|
*/
|
|
2786
|
-
refreshToken?: string;
|
|
2786
|
+
refreshToken?: string | undefined;
|
|
2787
2787
|
/**
|
|
2788
2788
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2789
2789
|
* </p>
|
|
2790
2790
|
* @public
|
|
2791
2791
|
*/
|
|
2792
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2792
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2793
2793
|
}
|
|
2794
2794
|
/**
|
|
2795
2795
|
* <p> The connector-specific credentials required when using Amazon Honeycode. </p>
|
|
@@ -2800,18 +2800,18 @@ export interface HoneycodeConnectorProfileCredentials {
|
|
|
2800
2800
|
* <p> The credentials used to access protected Amazon Honeycode resources. </p>
|
|
2801
2801
|
* @public
|
|
2802
2802
|
*/
|
|
2803
|
-
accessToken?: string;
|
|
2803
|
+
accessToken?: string | undefined;
|
|
2804
2804
|
/**
|
|
2805
2805
|
* <p> The credentials used to acquire new access tokens. </p>
|
|
2806
2806
|
* @public
|
|
2807
2807
|
*/
|
|
2808
|
-
refreshToken?: string;
|
|
2808
|
+
refreshToken?: string | undefined;
|
|
2809
2809
|
/**
|
|
2810
2810
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2811
2811
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2812
2812
|
* @public
|
|
2813
2813
|
*/
|
|
2814
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2814
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2815
2815
|
}
|
|
2816
2816
|
/**
|
|
2817
2817
|
* <p> The connector-specific profile credentials required by Infor Nexus. </p>
|
|
@@ -2859,13 +2859,13 @@ export interface MarketoConnectorProfileCredentials {
|
|
|
2859
2859
|
* <p> The credentials used to access protected Marketo resources. </p>
|
|
2860
2860
|
* @public
|
|
2861
2861
|
*/
|
|
2862
|
-
accessToken?: string;
|
|
2862
|
+
accessToken?: string | undefined;
|
|
2863
2863
|
/**
|
|
2864
2864
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2865
2865
|
* </p>
|
|
2866
2866
|
* @public
|
|
2867
2867
|
*/
|
|
2868
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2868
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2869
2869
|
}
|
|
2870
2870
|
/**
|
|
2871
2871
|
* <p>The connector-specific profile credentials required when using Salesforce Pardot.</p>
|
|
@@ -2876,24 +2876,24 @@ export interface PardotConnectorProfileCredentials {
|
|
|
2876
2876
|
* <p>The credentials used to access protected Salesforce Pardot resources.</p>
|
|
2877
2877
|
* @public
|
|
2878
2878
|
*/
|
|
2879
|
-
accessToken?: string;
|
|
2879
|
+
accessToken?: string | undefined;
|
|
2880
2880
|
/**
|
|
2881
2881
|
* <p>The credentials used to acquire new access tokens.</p>
|
|
2882
2882
|
* @public
|
|
2883
2883
|
*/
|
|
2884
|
-
refreshToken?: string;
|
|
2884
|
+
refreshToken?: string | undefined;
|
|
2885
2885
|
/**
|
|
2886
2886
|
* <p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce,
|
|
2887
2887
|
* Google Analytics, Marketo, Zendesk, and Slack. </p>
|
|
2888
2888
|
* @public
|
|
2889
2889
|
*/
|
|
2890
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2890
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2891
2891
|
/**
|
|
2892
2892
|
* <p>The secret manager ARN, which contains the client ID and client secret of the connected
|
|
2893
2893
|
* app.</p>
|
|
2894
2894
|
* @public
|
|
2895
2895
|
*/
|
|
2896
|
-
clientCredentialsArn?: string;
|
|
2896
|
+
clientCredentialsArn?: string | undefined;
|
|
2897
2897
|
}
|
|
2898
2898
|
/**
|
|
2899
2899
|
* <p> The connector-specific profile credentials required when using Amazon Redshift. </p>
|
|
@@ -2904,12 +2904,12 @@ export interface RedshiftConnectorProfileCredentials {
|
|
|
2904
2904
|
* <p> The name of the user. </p>
|
|
2905
2905
|
* @public
|
|
2906
2906
|
*/
|
|
2907
|
-
username?: string;
|
|
2907
|
+
username?: string | undefined;
|
|
2908
2908
|
/**
|
|
2909
2909
|
* <p> The password that corresponds to the user name. </p>
|
|
2910
2910
|
* @public
|
|
2911
2911
|
*/
|
|
2912
|
-
password?: string;
|
|
2912
|
+
password?: string | undefined;
|
|
2913
2913
|
}
|
|
2914
2914
|
/**
|
|
2915
2915
|
* <p> The connector-specific profile credentials required when using Salesforce. </p>
|
|
@@ -2920,24 +2920,24 @@ export interface SalesforceConnectorProfileCredentials {
|
|
|
2920
2920
|
* <p> The credentials used to access protected Salesforce resources. </p>
|
|
2921
2921
|
* @public
|
|
2922
2922
|
*/
|
|
2923
|
-
accessToken?: string;
|
|
2923
|
+
accessToken?: string | undefined;
|
|
2924
2924
|
/**
|
|
2925
2925
|
* <p> The credentials used to acquire new access tokens. </p>
|
|
2926
2926
|
* @public
|
|
2927
2927
|
*/
|
|
2928
|
-
refreshToken?: string;
|
|
2928
|
+
refreshToken?: string | undefined;
|
|
2929
2929
|
/**
|
|
2930
2930
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
2931
2931
|
* </p>
|
|
2932
2932
|
* @public
|
|
2933
2933
|
*/
|
|
2934
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
2934
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
2935
2935
|
/**
|
|
2936
2936
|
* <p> The secret manager ARN, which contains the client ID and client secret of the connected
|
|
2937
2937
|
* app. </p>
|
|
2938
2938
|
* @public
|
|
2939
2939
|
*/
|
|
2940
|
-
clientCredentialsArn?: string;
|
|
2940
|
+
clientCredentialsArn?: string | undefined;
|
|
2941
2941
|
/**
|
|
2942
2942
|
* <p>Specifies the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an
|
|
2943
2943
|
* access token from Salesforce. Amazon AppFlow requires an access token each time it
|
|
@@ -2965,13 +2965,13 @@ export interface SalesforceConnectorProfileCredentials {
|
|
|
2965
2965
|
* </note>
|
|
2966
2966
|
* @public
|
|
2967
2967
|
*/
|
|
2968
|
-
oAuth2GrantType?: OAuth2GrantType;
|
|
2968
|
+
oAuth2GrantType?: OAuth2GrantType | undefined;
|
|
2969
2969
|
/**
|
|
2970
2970
|
* <p>A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce
|
|
2971
2971
|
* records.</p>
|
|
2972
2972
|
* @public
|
|
2973
2973
|
*/
|
|
2974
|
-
jwtToken?: string;
|
|
2974
|
+
jwtToken?: string | undefined;
|
|
2975
2975
|
}
|
|
2976
2976
|
/**
|
|
2977
2977
|
* <p> The OAuth credentials required for OAuth type authentication. </p>
|
|
@@ -2993,18 +2993,18 @@ export interface OAuthCredentials {
|
|
|
2993
2993
|
* <p> The access token used to access protected SAPOData resources. </p>
|
|
2994
2994
|
* @public
|
|
2995
2995
|
*/
|
|
2996
|
-
accessToken?: string;
|
|
2996
|
+
accessToken?: string | undefined;
|
|
2997
2997
|
/**
|
|
2998
2998
|
* <p> The refresh token used to refresh expired access token. </p>
|
|
2999
2999
|
* @public
|
|
3000
3000
|
*/
|
|
3001
|
-
refreshToken?: string;
|
|
3001
|
+
refreshToken?: string | undefined;
|
|
3002
3002
|
/**
|
|
3003
3003
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
3004
3004
|
* </p>
|
|
3005
3005
|
* @public
|
|
3006
3006
|
*/
|
|
3007
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
3007
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
3008
3008
|
}
|
|
3009
3009
|
/**
|
|
3010
3010
|
* <p> The connector-specific profile credentials required when using SAPOData. </p>
|
|
@@ -3015,12 +3015,12 @@ export interface SAPODataConnectorProfileCredentials {
|
|
|
3015
3015
|
* <p> The SAPOData basic authentication credentials. </p>
|
|
3016
3016
|
* @public
|
|
3017
3017
|
*/
|
|
3018
|
-
basicAuthCredentials?: BasicAuthCredentials;
|
|
3018
|
+
basicAuthCredentials?: BasicAuthCredentials | undefined;
|
|
3019
3019
|
/**
|
|
3020
3020
|
* <p> The SAPOData OAuth type authentication credentials. </p>
|
|
3021
3021
|
* @public
|
|
3022
3022
|
*/
|
|
3023
|
-
oAuthCredentials?: OAuthCredentials;
|
|
3023
|
+
oAuthCredentials?: OAuthCredentials | undefined;
|
|
3024
3024
|
}
|
|
3025
3025
|
/**
|
|
3026
3026
|
* <p> The connector-specific profile credentials required when using ServiceNow. </p>
|
|
@@ -3031,17 +3031,17 @@ export interface ServiceNowConnectorProfileCredentials {
|
|
|
3031
3031
|
* <p> The name of the user. </p>
|
|
3032
3032
|
* @public
|
|
3033
3033
|
*/
|
|
3034
|
-
username?: string;
|
|
3034
|
+
username?: string | undefined;
|
|
3035
3035
|
/**
|
|
3036
3036
|
* <p> The password that corresponds to the user name. </p>
|
|
3037
3037
|
* @public
|
|
3038
3038
|
*/
|
|
3039
|
-
password?: string;
|
|
3039
|
+
password?: string | undefined;
|
|
3040
3040
|
/**
|
|
3041
3041
|
* <p> The OAuth 2.0 credentials required to authenticate the user. </p>
|
|
3042
3042
|
* @public
|
|
3043
3043
|
*/
|
|
3044
|
-
oAuth2Credentials?: OAuth2Credentials;
|
|
3044
|
+
oAuth2Credentials?: OAuth2Credentials | undefined;
|
|
3045
3045
|
}
|
|
3046
3046
|
/**
|
|
3047
3047
|
* <p> The connector-specific profile credentials required when using Singular. </p>
|
|
@@ -3075,13 +3075,13 @@ export interface SlackConnectorProfileCredentials {
|
|
|
3075
3075
|
* <p> The credentials used to access protected Slack resources. </p>
|
|
3076
3076
|
* @public
|
|
3077
3077
|
*/
|
|
3078
|
-
accessToken?: string;
|
|
3078
|
+
accessToken?: string | undefined;
|
|
3079
3079
|
/**
|
|
3080
3080
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
3081
3081
|
* </p>
|
|
3082
3082
|
* @public
|
|
3083
3083
|
*/
|
|
3084
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
3084
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
3085
3085
|
}
|
|
3086
3086
|
/**
|
|
3087
3087
|
* <p> The connector-specific profile credentials required when using Snowflake. </p>
|
|
@@ -3146,13 +3146,13 @@ export interface ZendeskConnectorProfileCredentials {
|
|
|
3146
3146
|
* <p> The credentials used to access protected Zendesk resources. </p>
|
|
3147
3147
|
* @public
|
|
3148
3148
|
*/
|
|
3149
|
-
accessToken?: string;
|
|
3149
|
+
accessToken?: string | undefined;
|
|
3150
3150
|
/**
|
|
3151
3151
|
* <p> The OAuth requirement needed to request security tokens from the connector endpoint.
|
|
3152
3152
|
* </p>
|
|
3153
3153
|
* @public
|
|
3154
3154
|
*/
|
|
3155
|
-
oAuthRequest?: ConnectorOAuthRequest;
|
|
3155
|
+
oAuthRequest?: ConnectorOAuthRequest | undefined;
|
|
3156
3156
|
}
|
|
3157
3157
|
/**
|
|
3158
3158
|
* <p> The connector-specific credentials required by a connector. </p>
|
|
@@ -3163,98 +3163,98 @@ export interface ConnectorProfileCredentials {
|
|
|
3163
3163
|
* <p> The connector-specific credentials required when using Amplitude. </p>
|
|
3164
3164
|
* @public
|
|
3165
3165
|
*/
|
|
3166
|
-
Amplitude?: AmplitudeConnectorProfileCredentials;
|
|
3166
|
+
Amplitude?: AmplitudeConnectorProfileCredentials | undefined;
|
|
3167
3167
|
/**
|
|
3168
3168
|
* <p> The connector-specific credentials required when using Datadog. </p>
|
|
3169
3169
|
* @public
|
|
3170
3170
|
*/
|
|
3171
|
-
Datadog?: DatadogConnectorProfileCredentials;
|
|
3171
|
+
Datadog?: DatadogConnectorProfileCredentials | undefined;
|
|
3172
3172
|
/**
|
|
3173
3173
|
* <p> The connector-specific credentials required when using Dynatrace. </p>
|
|
3174
3174
|
* @public
|
|
3175
3175
|
*/
|
|
3176
|
-
Dynatrace?: DynatraceConnectorProfileCredentials;
|
|
3176
|
+
Dynatrace?: DynatraceConnectorProfileCredentials | undefined;
|
|
3177
3177
|
/**
|
|
3178
3178
|
* <p> The connector-specific credentials required when using Google Analytics. </p>
|
|
3179
3179
|
* @public
|
|
3180
3180
|
*/
|
|
3181
|
-
GoogleAnalytics?: GoogleAnalyticsConnectorProfileCredentials;
|
|
3181
|
+
GoogleAnalytics?: GoogleAnalyticsConnectorProfileCredentials | undefined;
|
|
3182
3182
|
/**
|
|
3183
3183
|
* <p> The connector-specific credentials required when using Amazon Honeycode. </p>
|
|
3184
3184
|
* @public
|
|
3185
3185
|
*/
|
|
3186
|
-
Honeycode?: HoneycodeConnectorProfileCredentials;
|
|
3186
|
+
Honeycode?: HoneycodeConnectorProfileCredentials | undefined;
|
|
3187
3187
|
/**
|
|
3188
3188
|
* <p> The connector-specific credentials required when using Infor Nexus. </p>
|
|
3189
3189
|
* @public
|
|
3190
3190
|
*/
|
|
3191
|
-
InforNexus?: InforNexusConnectorProfileCredentials;
|
|
3191
|
+
InforNexus?: InforNexusConnectorProfileCredentials | undefined;
|
|
3192
3192
|
/**
|
|
3193
3193
|
* <p> The connector-specific credentials required when using Marketo. </p>
|
|
3194
3194
|
* @public
|
|
3195
3195
|
*/
|
|
3196
|
-
Marketo?: MarketoConnectorProfileCredentials;
|
|
3196
|
+
Marketo?: MarketoConnectorProfileCredentials | undefined;
|
|
3197
3197
|
/**
|
|
3198
3198
|
* <p> The connector-specific credentials required when using Amazon Redshift. </p>
|
|
3199
3199
|
* @public
|
|
3200
3200
|
*/
|
|
3201
|
-
Redshift?: RedshiftConnectorProfileCredentials;
|
|
3201
|
+
Redshift?: RedshiftConnectorProfileCredentials | undefined;
|
|
3202
3202
|
/**
|
|
3203
3203
|
* <p> The connector-specific credentials required when using Salesforce. </p>
|
|
3204
3204
|
* @public
|
|
3205
3205
|
*/
|
|
3206
|
-
Salesforce?: SalesforceConnectorProfileCredentials;
|
|
3206
|
+
Salesforce?: SalesforceConnectorProfileCredentials | undefined;
|
|
3207
3207
|
/**
|
|
3208
3208
|
* <p> The connector-specific credentials required when using ServiceNow. </p>
|
|
3209
3209
|
* @public
|
|
3210
3210
|
*/
|
|
3211
|
-
ServiceNow?: ServiceNowConnectorProfileCredentials;
|
|
3211
|
+
ServiceNow?: ServiceNowConnectorProfileCredentials | undefined;
|
|
3212
3212
|
/**
|
|
3213
3213
|
* <p> The connector-specific credentials required when using Singular. </p>
|
|
3214
3214
|
* @public
|
|
3215
3215
|
*/
|
|
3216
|
-
Singular?: SingularConnectorProfileCredentials;
|
|
3216
|
+
Singular?: SingularConnectorProfileCredentials | undefined;
|
|
3217
3217
|
/**
|
|
3218
3218
|
* <p> The connector-specific credentials required when using Slack. </p>
|
|
3219
3219
|
* @public
|
|
3220
3220
|
*/
|
|
3221
|
-
Slack?: SlackConnectorProfileCredentials;
|
|
3221
|
+
Slack?: SlackConnectorProfileCredentials | undefined;
|
|
3222
3222
|
/**
|
|
3223
3223
|
* <p> The connector-specific credentials required when using Snowflake. </p>
|
|
3224
3224
|
* @public
|
|
3225
3225
|
*/
|
|
3226
|
-
Snowflake?: SnowflakeConnectorProfileCredentials;
|
|
3226
|
+
Snowflake?: SnowflakeConnectorProfileCredentials | undefined;
|
|
3227
3227
|
/**
|
|
3228
3228
|
* <p> The connector-specific credentials required when using Trend Micro. </p>
|
|
3229
3229
|
* @public
|
|
3230
3230
|
*/
|
|
3231
|
-
Trendmicro?: TrendmicroConnectorProfileCredentials;
|
|
3231
|
+
Trendmicro?: TrendmicroConnectorProfileCredentials | undefined;
|
|
3232
3232
|
/**
|
|
3233
3233
|
* <p> The connector-specific credentials required when using Veeva. </p>
|
|
3234
3234
|
* @public
|
|
3235
3235
|
*/
|
|
3236
|
-
Veeva?: VeevaConnectorProfileCredentials;
|
|
3236
|
+
Veeva?: VeevaConnectorProfileCredentials | undefined;
|
|
3237
3237
|
/**
|
|
3238
3238
|
* <p> The connector-specific credentials required when using Zendesk. </p>
|
|
3239
3239
|
* @public
|
|
3240
3240
|
*/
|
|
3241
|
-
Zendesk?: ZendeskConnectorProfileCredentials;
|
|
3241
|
+
Zendesk?: ZendeskConnectorProfileCredentials | undefined;
|
|
3242
3242
|
/**
|
|
3243
3243
|
* <p> The connector-specific profile credentials required when using SAPOData. </p>
|
|
3244
3244
|
* @public
|
|
3245
3245
|
*/
|
|
3246
|
-
SAPOData?: SAPODataConnectorProfileCredentials;
|
|
3246
|
+
SAPOData?: SAPODataConnectorProfileCredentials | undefined;
|
|
3247
3247
|
/**
|
|
3248
3248
|
* <p>The connector-specific profile credentials that are required when using the custom
|
|
3249
3249
|
* connector.</p>
|
|
3250
3250
|
* @public
|
|
3251
3251
|
*/
|
|
3252
|
-
CustomConnector?: CustomConnectorProfileCredentials;
|
|
3252
|
+
CustomConnector?: CustomConnectorProfileCredentials | undefined;
|
|
3253
3253
|
/**
|
|
3254
3254
|
* <p>The connector-specific credentials required when using Salesforce Pardot.</p>
|
|
3255
3255
|
* @public
|
|
3256
3256
|
*/
|
|
3257
|
-
Pardot?: PardotConnectorProfileCredentials;
|
|
3257
|
+
Pardot?: PardotConnectorProfileCredentials | undefined;
|
|
3258
3258
|
}
|
|
3259
3259
|
/**
|
|
3260
3260
|
* <p> Defines the connector-specific configuration and credentials for the connector profile.
|
|
@@ -3271,7 +3271,7 @@ export interface ConnectorProfileConfig {
|
|
|
3271
3271
|
* <p> The connector-specific credentials required by each connector. </p>
|
|
3272
3272
|
* @public
|
|
3273
3273
|
*/
|
|
3274
|
-
connectorProfileCredentials?: ConnectorProfileCredentials;
|
|
3274
|
+
connectorProfileCredentials?: ConnectorProfileCredentials | undefined;
|
|
3275
3275
|
}
|
|
3276
3276
|
/**
|
|
3277
3277
|
* <p> An error occurred when retrieving data from the connector endpoint. </p>
|
|
@@ -3301,7 +3301,7 @@ export interface CreateConnectorProfileRequest {
|
|
|
3301
3301
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
3302
3302
|
* @public
|
|
3303
3303
|
*/
|
|
3304
|
-
kmsArn?: string;
|
|
3304
|
+
kmsArn?: string | undefined;
|
|
3305
3305
|
/**
|
|
3306
3306
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
3307
3307
|
* @public
|
|
@@ -3313,7 +3313,7 @@ export interface CreateConnectorProfileRequest {
|
|
|
3313
3313
|
* calling for CUSTOMCONNECTOR connector type/.</p>
|
|
3314
3314
|
* @public
|
|
3315
3315
|
*/
|
|
3316
|
-
connectorLabel?: string;
|
|
3316
|
+
connectorLabel?: string | undefined;
|
|
3317
3317
|
/**
|
|
3318
3318
|
* <p> Indicates the connection mode and specifies whether it is public or private. Private
|
|
3319
3319
|
* flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure
|
|
@@ -3339,7 +3339,7 @@ export interface CreateConnectorProfileRequest {
|
|
|
3339
3339
|
* call to <code>CreateConnectorProfile</code>. The token is active for 8 hours.</p>
|
|
3340
3340
|
* @public
|
|
3341
3341
|
*/
|
|
3342
|
-
clientToken?: string;
|
|
3342
|
+
clientToken?: string | undefined;
|
|
3343
3343
|
}
|
|
3344
3344
|
/**
|
|
3345
3345
|
* @public
|
|
@@ -3349,7 +3349,7 @@ export interface CreateConnectorProfileResponse {
|
|
|
3349
3349
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
3350
3350
|
* @public
|
|
3351
3351
|
*/
|
|
3352
|
-
connectorProfileArn?: string;
|
|
3352
|
+
connectorProfileArn?: string | undefined;
|
|
3353
3353
|
}
|
|
3354
3354
|
/**
|
|
3355
3355
|
* <p> The request would cause a service quota (such as the number of flows) to be exceeded.
|
|
@@ -3378,17 +3378,17 @@ export interface ErrorHandlingConfig {
|
|
|
3378
3378
|
* to place data in the destination. </p>
|
|
3379
3379
|
* @public
|
|
3380
3380
|
*/
|
|
3381
|
-
failOnFirstDestinationError?: boolean;
|
|
3381
|
+
failOnFirstDestinationError?: boolean | undefined;
|
|
3382
3382
|
/**
|
|
3383
3383
|
* <p> Specifies the Amazon S3 bucket prefix. </p>
|
|
3384
3384
|
* @public
|
|
3385
3385
|
*/
|
|
3386
|
-
bucketPrefix?: string;
|
|
3386
|
+
bucketPrefix?: string | undefined;
|
|
3387
3387
|
/**
|
|
3388
3388
|
* <p> Specifies the name of the Amazon S3 bucket. </p>
|
|
3389
3389
|
* @public
|
|
3390
3390
|
*/
|
|
3391
|
-
bucketName?: string;
|
|
3391
|
+
bucketName?: string | undefined;
|
|
3392
3392
|
}
|
|
3393
3393
|
/**
|
|
3394
3394
|
* <p>The properties that are applied when the custom connector is being used as a
|
|
@@ -3406,25 +3406,25 @@ export interface CustomConnectorDestinationProperties {
|
|
|
3406
3406
|
* the custom connector as destination.</p>
|
|
3407
3407
|
* @public
|
|
3408
3408
|
*/
|
|
3409
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3409
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3410
3410
|
/**
|
|
3411
3411
|
* <p>Specifies the type of write operation to be performed in the custom connector when it's
|
|
3412
3412
|
* used as destination.</p>
|
|
3413
3413
|
* @public
|
|
3414
3414
|
*/
|
|
3415
|
-
writeOperationType?: WriteOperationType;
|
|
3415
|
+
writeOperationType?: WriteOperationType | undefined;
|
|
3416
3416
|
/**
|
|
3417
3417
|
* <p>The name of the field that Amazon AppFlow uses as an ID when performing a write
|
|
3418
3418
|
* operation such as update, delete, or upsert.</p>
|
|
3419
3419
|
* @public
|
|
3420
3420
|
*/
|
|
3421
|
-
idFieldNames?: string[];
|
|
3421
|
+
idFieldNames?: string[] | undefined;
|
|
3422
3422
|
/**
|
|
3423
3423
|
* <p>The custom properties that are specific to the connector when it's used as a destination
|
|
3424
3424
|
* in the flow.</p>
|
|
3425
3425
|
* @public
|
|
3426
3426
|
*/
|
|
3427
|
-
customProperties?: Record<string, string
|
|
3427
|
+
customProperties?: Record<string, string> | undefined;
|
|
3428
3428
|
}
|
|
3429
3429
|
/**
|
|
3430
3430
|
* <p> The properties that are applied when Amazon Connect Customer Profiles is used as a
|
|
@@ -3442,7 +3442,7 @@ export interface CustomerProfilesDestinationProperties {
|
|
|
3442
3442
|
* </p>
|
|
3443
3443
|
* @public
|
|
3444
3444
|
*/
|
|
3445
|
-
objectTypeName?: string;
|
|
3445
|
+
objectTypeName?: string | undefined;
|
|
3446
3446
|
}
|
|
3447
3447
|
/**
|
|
3448
3448
|
* <p> The properties that are applied when Amazon EventBridge is being used as a
|
|
@@ -3463,7 +3463,7 @@ export interface EventBridgeDestinationProperties {
|
|
|
3463
3463
|
* </p>
|
|
3464
3464
|
* @public
|
|
3465
3465
|
*/
|
|
3466
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3466
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3467
3467
|
}
|
|
3468
3468
|
/**
|
|
3469
3469
|
* <p> The properties that are applied when Amazon Honeycode is used as a destination. </p>
|
|
@@ -3483,7 +3483,7 @@ export interface HoneycodeDestinationProperties {
|
|
|
3483
3483
|
* </p>
|
|
3484
3484
|
* @public
|
|
3485
3485
|
*/
|
|
3486
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3486
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3487
3487
|
}
|
|
3488
3488
|
/**
|
|
3489
3489
|
* <p> The properties that are applied when Amazon Lookout for Metrics is used as a destination.
|
|
@@ -3511,7 +3511,7 @@ export interface MarketoDestinationProperties {
|
|
|
3511
3511
|
* </p>
|
|
3512
3512
|
* @public
|
|
3513
3513
|
*/
|
|
3514
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3514
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3515
3515
|
}
|
|
3516
3516
|
/**
|
|
3517
3517
|
* <p> The properties that are applied when Amazon Redshift is being used as a destination.
|
|
@@ -3534,7 +3534,7 @@ export interface RedshiftDestinationProperties {
|
|
|
3534
3534
|
* </p>
|
|
3535
3535
|
* @public
|
|
3536
3536
|
*/
|
|
3537
|
-
bucketPrefix?: string;
|
|
3537
|
+
bucketPrefix?: string | undefined;
|
|
3538
3538
|
/**
|
|
3539
3539
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3540
3540
|
* the Amazon Redshift destination. For example, this setting would determine if the flow
|
|
@@ -3543,7 +3543,7 @@ export interface RedshiftDestinationProperties {
|
|
|
3543
3543
|
* destination connector details. </p>
|
|
3544
3544
|
* @public
|
|
3545
3545
|
*/
|
|
3546
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3546
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3547
3547
|
}
|
|
3548
3548
|
/**
|
|
3549
3549
|
* @public
|
|
@@ -3609,13 +3609,13 @@ export interface PrefixConfig {
|
|
|
3609
3609
|
* or both. </p>
|
|
3610
3610
|
* @public
|
|
3611
3611
|
*/
|
|
3612
|
-
prefixType?: PrefixType;
|
|
3612
|
+
prefixType?: PrefixType | undefined;
|
|
3613
3613
|
/**
|
|
3614
3614
|
* <p>Determines the level of granularity for the date and time that's included in the prefix.
|
|
3615
3615
|
* </p>
|
|
3616
3616
|
* @public
|
|
3617
3617
|
*/
|
|
3618
|
-
prefixFormat?: PrefixFormat;
|
|
3618
|
+
prefixFormat?: PrefixFormat | undefined;
|
|
3619
3619
|
/**
|
|
3620
3620
|
* <p>Specifies whether the destination file path includes either or both of the following
|
|
3621
3621
|
* elements:</p>
|
|
@@ -3644,7 +3644,7 @@ export interface PrefixConfig {
|
|
|
3644
3644
|
* </dl>
|
|
3645
3645
|
* @public
|
|
3646
3646
|
*/
|
|
3647
|
-
pathPrefixHierarchy?: PathPrefix[];
|
|
3647
|
+
pathPrefixHierarchy?: PathPrefix[] | undefined;
|
|
3648
3648
|
}
|
|
3649
3649
|
/**
|
|
3650
3650
|
* <p> The configuration that determines how Amazon AppFlow should format the flow output
|
|
@@ -3657,18 +3657,18 @@ export interface S3OutputFormatConfig {
|
|
|
3657
3657
|
* </p>
|
|
3658
3658
|
* @public
|
|
3659
3659
|
*/
|
|
3660
|
-
fileType?: FileType;
|
|
3660
|
+
fileType?: FileType | undefined;
|
|
3661
3661
|
/**
|
|
3662
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>
|
|
3663
3663
|
* @public
|
|
3664
3664
|
*/
|
|
3665
|
-
prefixConfig?: PrefixConfig;
|
|
3665
|
+
prefixConfig?: PrefixConfig | undefined;
|
|
3666
3666
|
/**
|
|
3667
3667
|
* <p> The aggregation settings that you can use to customize the output format of your flow
|
|
3668
3668
|
* data. </p>
|
|
3669
3669
|
* @public
|
|
3670
3670
|
*/
|
|
3671
|
-
aggregationConfig?: AggregationConfig;
|
|
3671
|
+
aggregationConfig?: AggregationConfig | undefined;
|
|
3672
3672
|
/**
|
|
3673
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>
|
|
3674
3674
|
* <ul>
|
|
@@ -3687,7 +3687,7 @@ export interface S3OutputFormatConfig {
|
|
|
3687
3687
|
* </ul>
|
|
3688
3688
|
* @public
|
|
3689
3689
|
*/
|
|
3690
|
-
preserveSourceDataTyping?: boolean;
|
|
3690
|
+
preserveSourceDataTyping?: boolean | undefined;
|
|
3691
3691
|
}
|
|
3692
3692
|
/**
|
|
3693
3693
|
* <p> The properties that are applied when Amazon S3 is used as a destination. </p>
|
|
@@ -3705,13 +3705,13 @@ export interface S3DestinationProperties {
|
|
|
3705
3705
|
* </p>
|
|
3706
3706
|
* @public
|
|
3707
3707
|
*/
|
|
3708
|
-
bucketPrefix?: string;
|
|
3708
|
+
bucketPrefix?: string | undefined;
|
|
3709
3709
|
/**
|
|
3710
3710
|
* <p> The configuration that determines how Amazon AppFlow should format the flow output
|
|
3711
3711
|
* data when Amazon S3 is used as the destination. </p>
|
|
3712
3712
|
* @public
|
|
3713
3713
|
*/
|
|
3714
|
-
s3OutputFormatConfig?: S3OutputFormatConfig;
|
|
3714
|
+
s3OutputFormatConfig?: S3OutputFormatConfig | undefined;
|
|
3715
3715
|
}
|
|
3716
3716
|
/**
|
|
3717
3717
|
* <p> The properties that are applied when Salesforce is being used as a destination. </p>
|
|
@@ -3728,7 +3728,7 @@ export interface SalesforceDestinationProperties {
|
|
|
3728
3728
|
* operation such as update or delete. </p>
|
|
3729
3729
|
* @public
|
|
3730
3730
|
*/
|
|
3731
|
-
idFieldNames?: string[];
|
|
3731
|
+
idFieldNames?: string[] | undefined;
|
|
3732
3732
|
/**
|
|
3733
3733
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3734
3734
|
* the Salesforce destination. For example, this setting would determine if the flow should fail
|
|
@@ -3737,13 +3737,13 @@ export interface SalesforceDestinationProperties {
|
|
|
3737
3737
|
* details. </p>
|
|
3738
3738
|
* @public
|
|
3739
3739
|
*/
|
|
3740
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3740
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3741
3741
|
/**
|
|
3742
3742
|
* <p> This specifies the type of write operation to be performed in Salesforce. When the value
|
|
3743
3743
|
* is <code>UPSERT</code>, then <code>idFieldNames</code> is required. </p>
|
|
3744
3744
|
* @public
|
|
3745
3745
|
*/
|
|
3746
|
-
writeOperationType?: WriteOperationType;
|
|
3746
|
+
writeOperationType?: WriteOperationType | undefined;
|
|
3747
3747
|
/**
|
|
3748
3748
|
* <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
|
|
3749
3749
|
* data to Salesforce.</p>
|
|
@@ -3784,7 +3784,7 @@ export interface SalesforceDestinationProperties {
|
|
|
3784
3784
|
* </dl>
|
|
3785
3785
|
* @public
|
|
3786
3786
|
*/
|
|
3787
|
-
dataTransferApi?: SalesforceDataTransferApi;
|
|
3787
|
+
dataTransferApi?: SalesforceDataTransferApi | undefined;
|
|
3788
3788
|
}
|
|
3789
3789
|
/**
|
|
3790
3790
|
* <p>Determines how Amazon AppFlow handles the success response that it gets from the
|
|
@@ -3798,12 +3798,12 @@ export interface SuccessResponseHandlingConfig {
|
|
|
3798
3798
|
* <p>The Amazon S3 bucket prefix.</p>
|
|
3799
3799
|
* @public
|
|
3800
3800
|
*/
|
|
3801
|
-
bucketPrefix?: string;
|
|
3801
|
+
bucketPrefix?: string | undefined;
|
|
3802
3802
|
/**
|
|
3803
3803
|
* <p>The name of the Amazon S3 bucket.</p>
|
|
3804
3804
|
* @public
|
|
3805
3805
|
*/
|
|
3806
|
-
bucketName?: string;
|
|
3806
|
+
bucketName?: string | undefined;
|
|
3807
3807
|
}
|
|
3808
3808
|
/**
|
|
3809
3809
|
* <p>The properties that are applied when using SAPOData as a flow destination</p>
|
|
@@ -3822,13 +3822,13 @@ export interface SAPODataDestinationProperties {
|
|
|
3822
3822
|
* connector upon a successful insert operation.</p>
|
|
3823
3823
|
* @public
|
|
3824
3824
|
*/
|
|
3825
|
-
successResponseHandlingConfig?: SuccessResponseHandlingConfig;
|
|
3825
|
+
successResponseHandlingConfig?: SuccessResponseHandlingConfig | undefined;
|
|
3826
3826
|
/**
|
|
3827
3827
|
* <p> A list of field names that can be used as an ID field when performing a write operation.
|
|
3828
3828
|
* </p>
|
|
3829
3829
|
* @public
|
|
3830
3830
|
*/
|
|
3831
|
-
idFieldNames?: string[];
|
|
3831
|
+
idFieldNames?: string[] | undefined;
|
|
3832
3832
|
/**
|
|
3833
3833
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3834
3834
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
@@ -3837,13 +3837,13 @@ export interface SAPODataDestinationProperties {
|
|
|
3837
3837
|
* </p>
|
|
3838
3838
|
* @public
|
|
3839
3839
|
*/
|
|
3840
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3840
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3841
3841
|
/**
|
|
3842
3842
|
* <p> The possible write operations in the destination connector. When this value is not
|
|
3843
3843
|
* provided, this defaults to the <code>INSERT</code> operation. </p>
|
|
3844
3844
|
* @public
|
|
3845
3845
|
*/
|
|
3846
|
-
writeOperationType?: WriteOperationType;
|
|
3846
|
+
writeOperationType?: WriteOperationType | undefined;
|
|
3847
3847
|
}
|
|
3848
3848
|
/**
|
|
3849
3849
|
* <p> The properties that are applied when Snowflake is being used as a destination. </p>
|
|
@@ -3866,7 +3866,7 @@ export interface SnowflakeDestinationProperties {
|
|
|
3866
3866
|
* </p>
|
|
3867
3867
|
* @public
|
|
3868
3868
|
*/
|
|
3869
|
-
bucketPrefix?: string;
|
|
3869
|
+
bucketPrefix?: string | undefined;
|
|
3870
3870
|
/**
|
|
3871
3871
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3872
3872
|
* the Snowflake destination. For example, this setting would determine if the flow should fail
|
|
@@ -3875,7 +3875,7 @@ export interface SnowflakeDestinationProperties {
|
|
|
3875
3875
|
* details. </p>
|
|
3876
3876
|
* @public
|
|
3877
3877
|
*/
|
|
3878
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3878
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3879
3879
|
}
|
|
3880
3880
|
/**
|
|
3881
3881
|
* <p> The configuration that determines how Amazon AppFlow formats the flow output data
|
|
@@ -3888,7 +3888,7 @@ export interface UpsolverS3OutputFormatConfig {
|
|
|
3888
3888
|
* bucket. </p>
|
|
3889
3889
|
* @public
|
|
3890
3890
|
*/
|
|
3891
|
-
fileType?: FileType;
|
|
3891
|
+
fileType?: FileType | undefined;
|
|
3892
3892
|
/**
|
|
3893
3893
|
* <p>Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
|
|
3894
3894
|
* destination.</p>
|
|
@@ -3900,7 +3900,7 @@ export interface UpsolverS3OutputFormatConfig {
|
|
|
3900
3900
|
* data. </p>
|
|
3901
3901
|
* @public
|
|
3902
3902
|
*/
|
|
3903
|
-
aggregationConfig?: AggregationConfig;
|
|
3903
|
+
aggregationConfig?: AggregationConfig | undefined;
|
|
3904
3904
|
}
|
|
3905
3905
|
/**
|
|
3906
3906
|
* <p> The properties that are applied when Upsolver is used as a destination. </p>
|
|
@@ -3917,7 +3917,7 @@ export interface UpsolverDestinationProperties {
|
|
|
3917
3917
|
* <p> The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files. </p>
|
|
3918
3918
|
* @public
|
|
3919
3919
|
*/
|
|
3920
|
-
bucketPrefix?: string;
|
|
3920
|
+
bucketPrefix?: string | undefined;
|
|
3921
3921
|
/**
|
|
3922
3922
|
* <p> The configuration that determines how data is formatted when Upsolver is used as the flow
|
|
3923
3923
|
* destination. </p>
|
|
@@ -3940,7 +3940,7 @@ export interface ZendeskDestinationProperties {
|
|
|
3940
3940
|
* </p>
|
|
3941
3941
|
* @public
|
|
3942
3942
|
*/
|
|
3943
|
-
idFieldNames?: string[];
|
|
3943
|
+
idFieldNames?: string[] | undefined;
|
|
3944
3944
|
/**
|
|
3945
3945
|
* <p> The settings that determine how Amazon AppFlow handles an error when placing data in
|
|
3946
3946
|
* the destination. For example, this setting would determine if the flow should fail after one
|
|
@@ -3949,13 +3949,13 @@ export interface ZendeskDestinationProperties {
|
|
|
3949
3949
|
* </p>
|
|
3950
3950
|
* @public
|
|
3951
3951
|
*/
|
|
3952
|
-
errorHandlingConfig?: ErrorHandlingConfig;
|
|
3952
|
+
errorHandlingConfig?: ErrorHandlingConfig | undefined;
|
|
3953
3953
|
/**
|
|
3954
3954
|
* <p> The possible write operations in the destination connector. When this value is not
|
|
3955
3955
|
* provided, this defaults to the <code>INSERT</code> operation. </p>
|
|
3956
3956
|
* @public
|
|
3957
3957
|
*/
|
|
3958
|
-
writeOperationType?: WriteOperationType;
|
|
3958
|
+
writeOperationType?: WriteOperationType | undefined;
|
|
3959
3959
|
}
|
|
3960
3960
|
/**
|
|
3961
3961
|
* <p> This stores the information that is required to query a particular connector. </p>
|
|
@@ -3966,67 +3966,67 @@ export interface DestinationConnectorProperties {
|
|
|
3966
3966
|
* <p> The properties required to query Amazon Redshift. </p>
|
|
3967
3967
|
* @public
|
|
3968
3968
|
*/
|
|
3969
|
-
Redshift?: RedshiftDestinationProperties;
|
|
3969
|
+
Redshift?: RedshiftDestinationProperties | undefined;
|
|
3970
3970
|
/**
|
|
3971
3971
|
* <p> The properties required to query Amazon S3. </p>
|
|
3972
3972
|
* @public
|
|
3973
3973
|
*/
|
|
3974
|
-
S3?: S3DestinationProperties;
|
|
3974
|
+
S3?: S3DestinationProperties | undefined;
|
|
3975
3975
|
/**
|
|
3976
3976
|
* <p> The properties required to query Salesforce. </p>
|
|
3977
3977
|
* @public
|
|
3978
3978
|
*/
|
|
3979
|
-
Salesforce?: SalesforceDestinationProperties;
|
|
3979
|
+
Salesforce?: SalesforceDestinationProperties | undefined;
|
|
3980
3980
|
/**
|
|
3981
3981
|
* <p> The properties required to query Snowflake. </p>
|
|
3982
3982
|
* @public
|
|
3983
3983
|
*/
|
|
3984
|
-
Snowflake?: SnowflakeDestinationProperties;
|
|
3984
|
+
Snowflake?: SnowflakeDestinationProperties | undefined;
|
|
3985
3985
|
/**
|
|
3986
3986
|
* <p> The properties required to query Amazon EventBridge. </p>
|
|
3987
3987
|
* @public
|
|
3988
3988
|
*/
|
|
3989
|
-
EventBridge?: EventBridgeDestinationProperties;
|
|
3989
|
+
EventBridge?: EventBridgeDestinationProperties | undefined;
|
|
3990
3990
|
/**
|
|
3991
3991
|
* <p> The properties required to query Amazon Lookout for Metrics. </p>
|
|
3992
3992
|
* @public
|
|
3993
3993
|
*/
|
|
3994
|
-
LookoutMetrics?: LookoutMetricsDestinationProperties;
|
|
3994
|
+
LookoutMetrics?: LookoutMetricsDestinationProperties | undefined;
|
|
3995
3995
|
/**
|
|
3996
3996
|
* <p> The properties required to query Upsolver. </p>
|
|
3997
3997
|
* @public
|
|
3998
3998
|
*/
|
|
3999
|
-
Upsolver?: UpsolverDestinationProperties;
|
|
3999
|
+
Upsolver?: UpsolverDestinationProperties | undefined;
|
|
4000
4000
|
/**
|
|
4001
4001
|
* <p> The properties required to query Amazon Honeycode. </p>
|
|
4002
4002
|
* @public
|
|
4003
4003
|
*/
|
|
4004
|
-
Honeycode?: HoneycodeDestinationProperties;
|
|
4004
|
+
Honeycode?: HoneycodeDestinationProperties | undefined;
|
|
4005
4005
|
/**
|
|
4006
4006
|
* <p> The properties required to query Amazon Connect Customer Profiles. </p>
|
|
4007
4007
|
* @public
|
|
4008
4008
|
*/
|
|
4009
|
-
CustomerProfiles?: CustomerProfilesDestinationProperties;
|
|
4009
|
+
CustomerProfiles?: CustomerProfilesDestinationProperties | undefined;
|
|
4010
4010
|
/**
|
|
4011
4011
|
* <p>The properties required to query Zendesk.</p>
|
|
4012
4012
|
* @public
|
|
4013
4013
|
*/
|
|
4014
|
-
Zendesk?: ZendeskDestinationProperties;
|
|
4014
|
+
Zendesk?: ZendeskDestinationProperties | undefined;
|
|
4015
4015
|
/**
|
|
4016
4016
|
* <p>The properties required to query Marketo.</p>
|
|
4017
4017
|
* @public
|
|
4018
4018
|
*/
|
|
4019
|
-
Marketo?: MarketoDestinationProperties;
|
|
4019
|
+
Marketo?: MarketoDestinationProperties | undefined;
|
|
4020
4020
|
/**
|
|
4021
4021
|
* <p>The properties that are required to query the custom Connector.</p>
|
|
4022
4022
|
* @public
|
|
4023
4023
|
*/
|
|
4024
|
-
CustomConnector?: CustomConnectorDestinationProperties;
|
|
4024
|
+
CustomConnector?: CustomConnectorDestinationProperties | undefined;
|
|
4025
4025
|
/**
|
|
4026
4026
|
* <p>The properties required to query SAPOData.</p>
|
|
4027
4027
|
* @public
|
|
4028
4028
|
*/
|
|
4029
|
-
SAPOData?: SAPODataDestinationProperties;
|
|
4029
|
+
SAPOData?: SAPODataDestinationProperties | undefined;
|
|
4030
4030
|
}
|
|
4031
4031
|
/**
|
|
4032
4032
|
* <p> Contains information about the configuration of destination connectors present in the
|
|
@@ -4043,13 +4043,13 @@ export interface DestinationFlowConfig {
|
|
|
4043
4043
|
* <p>The API version that the destination connector uses.</p>
|
|
4044
4044
|
* @public
|
|
4045
4045
|
*/
|
|
4046
|
-
apiVersion?: string;
|
|
4046
|
+
apiVersion?: string | undefined;
|
|
4047
4047
|
/**
|
|
4048
4048
|
* <p> The name of the connector profile. This name must be unique for each connector profile in
|
|
4049
4049
|
* the Amazon Web Services account. </p>
|
|
4050
4050
|
* @public
|
|
4051
4051
|
*/
|
|
4052
|
-
connectorProfileName?: string;
|
|
4052
|
+
connectorProfileName?: string | undefined;
|
|
4053
4053
|
/**
|
|
4054
4054
|
* <p> This stores the information that is required to query a particular connector. </p>
|
|
4055
4055
|
* @public
|
|
@@ -4104,7 +4104,7 @@ export interface MetadataCatalogConfig {
|
|
|
4104
4104
|
* the Glue Data Catalog.</p>
|
|
4105
4105
|
* @public
|
|
4106
4106
|
*/
|
|
4107
|
-
glueDataCatalog?: GlueDataCatalogConfig;
|
|
4107
|
+
glueDataCatalog?: GlueDataCatalogConfig | undefined;
|
|
4108
4108
|
}
|
|
4109
4109
|
/**
|
|
4110
4110
|
* <p> Specifies the configuration used when importing incremental records from the source.
|
|
@@ -4117,7 +4117,7 @@ export interface IncrementalPullConfig {
|
|
|
4117
4117
|
* importing incremental records from the source. </p>
|
|
4118
4118
|
* @public
|
|
4119
4119
|
*/
|
|
4120
|
-
datetimeTypeFieldName?: string;
|
|
4120
|
+
datetimeTypeFieldName?: string | undefined;
|
|
4121
4121
|
}
|
|
4122
4122
|
/**
|
|
4123
4123
|
* <p>The properties that are applied when the custom connector is being used as a
|
|
@@ -4134,13 +4134,13 @@ export interface CustomConnectorSourceProperties {
|
|
|
4134
4134
|
* <p>Custom properties that are required to use the custom connector as a source.</p>
|
|
4135
4135
|
* @public
|
|
4136
4136
|
*/
|
|
4137
|
-
customProperties?: Record<string, string
|
|
4137
|
+
customProperties?: Record<string, string> | undefined;
|
|
4138
4138
|
/**
|
|
4139
4139
|
* <p>The API of the connector application that Amazon AppFlow uses to transfer your
|
|
4140
4140
|
* data.</p>
|
|
4141
4141
|
* @public
|
|
4142
4142
|
*/
|
|
4143
|
-
dataTransferApi?: DataTransferApi;
|
|
4143
|
+
dataTransferApi?: DataTransferApi | undefined;
|
|
4144
4144
|
}
|
|
4145
4145
|
/**
|
|
4146
4146
|
* <p> The properties that are applied when Datadog is being used as a source. </p>
|
|
@@ -4230,7 +4230,7 @@ export interface S3InputFormatConfig {
|
|
|
4230
4230
|
* <p> The file type that Amazon AppFlow gets from your Amazon S3 bucket. </p>
|
|
4231
4231
|
* @public
|
|
4232
4232
|
*/
|
|
4233
|
-
s3InputFileType?: S3InputFileType;
|
|
4233
|
+
s3InputFileType?: S3InputFileType | undefined;
|
|
4234
4234
|
}
|
|
4235
4235
|
/**
|
|
4236
4236
|
* <p> The properties that are applied when Amazon S3 is being used as the flow source.
|
|
@@ -4248,13 +4248,13 @@ export interface S3SourceProperties {
|
|
|
4248
4248
|
* </p>
|
|
4249
4249
|
* @public
|
|
4250
4250
|
*/
|
|
4251
|
-
bucketPrefix?: string;
|
|
4251
|
+
bucketPrefix?: string | undefined;
|
|
4252
4252
|
/**
|
|
4253
4253
|
* <p> When you use Amazon S3 as the source, the configuration format that you provide
|
|
4254
4254
|
* the flow input data. </p>
|
|
4255
4255
|
* @public
|
|
4256
4256
|
*/
|
|
4257
|
-
s3InputFormatConfig?: S3InputFormatConfig;
|
|
4257
|
+
s3InputFormatConfig?: S3InputFormatConfig | undefined;
|
|
4258
4258
|
}
|
|
4259
4259
|
/**
|
|
4260
4260
|
* <p> The properties that are applied when Salesforce is being used as a source. </p>
|
|
@@ -4271,12 +4271,12 @@ export interface SalesforceSourceProperties {
|
|
|
4271
4271
|
* objects while running a flow. </p>
|
|
4272
4272
|
* @public
|
|
4273
4273
|
*/
|
|
4274
|
-
enableDynamicFieldUpdate?: boolean;
|
|
4274
|
+
enableDynamicFieldUpdate?: boolean | undefined;
|
|
4275
4275
|
/**
|
|
4276
4276
|
* <p> Indicates whether Amazon AppFlow includes deleted files in the flow run. </p>
|
|
4277
4277
|
* @public
|
|
4278
4278
|
*/
|
|
4279
|
-
includeDeletedRecords?: boolean;
|
|
4279
|
+
includeDeletedRecords?: boolean | undefined;
|
|
4280
4280
|
/**
|
|
4281
4281
|
* <p>Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers
|
|
4282
4282
|
* data from Salesforce.</p>
|
|
@@ -4317,7 +4317,7 @@ export interface SalesforceSourceProperties {
|
|
|
4317
4317
|
* </dl>
|
|
4318
4318
|
* @public
|
|
4319
4319
|
*/
|
|
4320
|
-
dataTransferApi?: SalesforceDataTransferApi;
|
|
4320
|
+
dataTransferApi?: SalesforceDataTransferApi | undefined;
|
|
4321
4321
|
}
|
|
4322
4322
|
/**
|
|
4323
4323
|
* <p>Sets the page size for each <i>concurrent process</i> that transfers OData
|
|
@@ -4360,19 +4360,19 @@ export interface SAPODataSourceProperties {
|
|
|
4360
4360
|
* <p> The object path specified in the SAPOData flow source. </p>
|
|
4361
4361
|
* @public
|
|
4362
4362
|
*/
|
|
4363
|
-
objectPath?: string;
|
|
4363
|
+
objectPath?: string | undefined;
|
|
4364
4364
|
/**
|
|
4365
4365
|
* <p>Sets the number of concurrent processes that transfers OData records from your SAP
|
|
4366
4366
|
* instance.</p>
|
|
4367
4367
|
* @public
|
|
4368
4368
|
*/
|
|
4369
|
-
parallelismConfig?: SAPODataParallelismConfig;
|
|
4369
|
+
parallelismConfig?: SAPODataParallelismConfig | undefined;
|
|
4370
4370
|
/**
|
|
4371
4371
|
* <p>Sets the page size for each concurrent process that transfers OData records from your SAP
|
|
4372
4372
|
* instance.</p>
|
|
4373
4373
|
* @public
|
|
4374
4374
|
*/
|
|
4375
|
-
paginationConfig?: SAPODataPaginationConfig;
|
|
4375
|
+
paginationConfig?: SAPODataPaginationConfig | undefined;
|
|
4376
4376
|
}
|
|
4377
4377
|
/**
|
|
4378
4378
|
* <p> The properties that are applied when ServiceNow is being used as a source. </p>
|
|
@@ -4432,22 +4432,22 @@ export interface VeevaSourceProperties {
|
|
|
4432
4432
|
* <p>The document type specified in the Veeva document extract flow.</p>
|
|
4433
4433
|
* @public
|
|
4434
4434
|
*/
|
|
4435
|
-
documentType?: string;
|
|
4435
|
+
documentType?: string | undefined;
|
|
4436
4436
|
/**
|
|
4437
4437
|
* <p>Boolean value to include source files in Veeva document extract flow.</p>
|
|
4438
4438
|
* @public
|
|
4439
4439
|
*/
|
|
4440
|
-
includeSourceFiles?: boolean;
|
|
4440
|
+
includeSourceFiles?: boolean | undefined;
|
|
4441
4441
|
/**
|
|
4442
4442
|
* <p>Boolean value to include file renditions in Veeva document extract flow.</p>
|
|
4443
4443
|
* @public
|
|
4444
4444
|
*/
|
|
4445
|
-
includeRenditions?: boolean;
|
|
4445
|
+
includeRenditions?: boolean | undefined;
|
|
4446
4446
|
/**
|
|
4447
4447
|
* <p>Boolean value to include All Versions of files in Veeva document extract flow.</p>
|
|
4448
4448
|
* @public
|
|
4449
4449
|
*/
|
|
4450
|
-
includeAllVersions?: boolean;
|
|
4450
|
+
includeAllVersions?: boolean | undefined;
|
|
4451
4451
|
}
|
|
4452
4452
|
/**
|
|
4453
4453
|
* <p> The properties that are applied when using Zendesk as a flow source. </p>
|
|
@@ -4469,88 +4469,88 @@ export interface SourceConnectorProperties {
|
|
|
4469
4469
|
* <p> Specifies the information that is required for querying Amplitude. </p>
|
|
4470
4470
|
* @public
|
|
4471
4471
|
*/
|
|
4472
|
-
Amplitude?: AmplitudeSourceProperties;
|
|
4472
|
+
Amplitude?: AmplitudeSourceProperties | undefined;
|
|
4473
4473
|
/**
|
|
4474
4474
|
* <p> Specifies the information that is required for querying Datadog. </p>
|
|
4475
4475
|
* @public
|
|
4476
4476
|
*/
|
|
4477
|
-
Datadog?: DatadogSourceProperties;
|
|
4477
|
+
Datadog?: DatadogSourceProperties | undefined;
|
|
4478
4478
|
/**
|
|
4479
4479
|
* <p> Specifies the information that is required for querying Dynatrace. </p>
|
|
4480
4480
|
* @public
|
|
4481
4481
|
*/
|
|
4482
|
-
Dynatrace?: DynatraceSourceProperties;
|
|
4482
|
+
Dynatrace?: DynatraceSourceProperties | undefined;
|
|
4483
4483
|
/**
|
|
4484
4484
|
* <p> Specifies the information that is required for querying Google Analytics. </p>
|
|
4485
4485
|
* @public
|
|
4486
4486
|
*/
|
|
4487
|
-
GoogleAnalytics?: GoogleAnalyticsSourceProperties;
|
|
4487
|
+
GoogleAnalytics?: GoogleAnalyticsSourceProperties | undefined;
|
|
4488
4488
|
/**
|
|
4489
4489
|
* <p> Specifies the information that is required for querying Infor Nexus. </p>
|
|
4490
4490
|
* @public
|
|
4491
4491
|
*/
|
|
4492
|
-
InforNexus?: InforNexusSourceProperties;
|
|
4492
|
+
InforNexus?: InforNexusSourceProperties | undefined;
|
|
4493
4493
|
/**
|
|
4494
4494
|
* <p> Specifies the information that is required for querying Marketo. </p>
|
|
4495
4495
|
* @public
|
|
4496
4496
|
*/
|
|
4497
|
-
Marketo?: MarketoSourceProperties;
|
|
4497
|
+
Marketo?: MarketoSourceProperties | undefined;
|
|
4498
4498
|
/**
|
|
4499
4499
|
* <p> Specifies the information that is required for querying Amazon S3. </p>
|
|
4500
4500
|
* @public
|
|
4501
4501
|
*/
|
|
4502
|
-
S3?: S3SourceProperties;
|
|
4502
|
+
S3?: S3SourceProperties | undefined;
|
|
4503
4503
|
/**
|
|
4504
4504
|
* <p> Specifies the information that is required for querying Salesforce. </p>
|
|
4505
4505
|
* @public
|
|
4506
4506
|
*/
|
|
4507
|
-
Salesforce?: SalesforceSourceProperties;
|
|
4507
|
+
Salesforce?: SalesforceSourceProperties | undefined;
|
|
4508
4508
|
/**
|
|
4509
4509
|
* <p> Specifies the information that is required for querying ServiceNow. </p>
|
|
4510
4510
|
* @public
|
|
4511
4511
|
*/
|
|
4512
|
-
ServiceNow?: ServiceNowSourceProperties;
|
|
4512
|
+
ServiceNow?: ServiceNowSourceProperties | undefined;
|
|
4513
4513
|
/**
|
|
4514
4514
|
* <p> Specifies the information that is required for querying Singular. </p>
|
|
4515
4515
|
* @public
|
|
4516
4516
|
*/
|
|
4517
|
-
Singular?: SingularSourceProperties;
|
|
4517
|
+
Singular?: SingularSourceProperties | undefined;
|
|
4518
4518
|
/**
|
|
4519
4519
|
* <p> Specifies the information that is required for querying Slack. </p>
|
|
4520
4520
|
* @public
|
|
4521
4521
|
*/
|
|
4522
|
-
Slack?: SlackSourceProperties;
|
|
4522
|
+
Slack?: SlackSourceProperties | undefined;
|
|
4523
4523
|
/**
|
|
4524
4524
|
* <p> Specifies the information that is required for querying Trend Micro. </p>
|
|
4525
4525
|
* @public
|
|
4526
4526
|
*/
|
|
4527
|
-
Trendmicro?: TrendmicroSourceProperties;
|
|
4527
|
+
Trendmicro?: TrendmicroSourceProperties | undefined;
|
|
4528
4528
|
/**
|
|
4529
4529
|
* <p> Specifies the information that is required for querying Veeva. </p>
|
|
4530
4530
|
* @public
|
|
4531
4531
|
*/
|
|
4532
|
-
Veeva?: VeevaSourceProperties;
|
|
4532
|
+
Veeva?: VeevaSourceProperties | undefined;
|
|
4533
4533
|
/**
|
|
4534
4534
|
* <p> Specifies the information that is required for querying Zendesk. </p>
|
|
4535
4535
|
* @public
|
|
4536
4536
|
*/
|
|
4537
|
-
Zendesk?: ZendeskSourceProperties;
|
|
4537
|
+
Zendesk?: ZendeskSourceProperties | undefined;
|
|
4538
4538
|
/**
|
|
4539
4539
|
* <p> The properties that are applied when using SAPOData as a flow source. </p>
|
|
4540
4540
|
* @public
|
|
4541
4541
|
*/
|
|
4542
|
-
SAPOData?: SAPODataSourceProperties;
|
|
4542
|
+
SAPOData?: SAPODataSourceProperties | undefined;
|
|
4543
4543
|
/**
|
|
4544
4544
|
* <p>The properties that are applied when the custom connector is being used as a
|
|
4545
4545
|
* source.</p>
|
|
4546
4546
|
* @public
|
|
4547
4547
|
*/
|
|
4548
|
-
CustomConnector?: CustomConnectorSourceProperties;
|
|
4548
|
+
CustomConnector?: CustomConnectorSourceProperties | undefined;
|
|
4549
4549
|
/**
|
|
4550
4550
|
* <p>Specifies the information that is required for querying Salesforce Pardot.</p>
|
|
4551
4551
|
* @public
|
|
4552
4552
|
*/
|
|
4553
|
-
Pardot?: PardotSourceProperties;
|
|
4553
|
+
Pardot?: PardotSourceProperties | undefined;
|
|
4554
4554
|
}
|
|
4555
4555
|
/**
|
|
4556
4556
|
* <p> Contains information about the configuration of the source connector used in the flow.
|
|
@@ -4567,13 +4567,13 @@ export interface SourceFlowConfig {
|
|
|
4567
4567
|
* <p>The API version of the connector when it's used as a source in the flow.</p>
|
|
4568
4568
|
* @public
|
|
4569
4569
|
*/
|
|
4570
|
-
apiVersion?: string;
|
|
4570
|
+
apiVersion?: string | undefined;
|
|
4571
4571
|
/**
|
|
4572
4572
|
* <p> The name of the connector profile. This name must be unique for each connector profile in
|
|
4573
4573
|
* the Amazon Web Services account. </p>
|
|
4574
4574
|
* @public
|
|
4575
4575
|
*/
|
|
4576
|
-
connectorProfileName?: string;
|
|
4576
|
+
connectorProfileName?: string | undefined;
|
|
4577
4577
|
/**
|
|
4578
4578
|
* <p> Specifies the information that is required to query a particular source connector.
|
|
4579
4579
|
* </p>
|
|
@@ -4586,7 +4586,7 @@ export interface SourceFlowConfig {
|
|
|
4586
4586
|
* incremental data pull. </p>
|
|
4587
4587
|
* @public
|
|
4588
4588
|
*/
|
|
4589
|
-
incrementalPullConfig?: IncrementalPullConfig;
|
|
4589
|
+
incrementalPullConfig?: IncrementalPullConfig | undefined;
|
|
4590
4590
|
}
|
|
4591
4591
|
/**
|
|
4592
4592
|
* @public
|
|
@@ -4650,13 +4650,13 @@ export interface Task {
|
|
|
4650
4650
|
* <p> The operation to be performed on the provided source fields. </p>
|
|
4651
4651
|
* @public
|
|
4652
4652
|
*/
|
|
4653
|
-
connectorOperator?: ConnectorOperator;
|
|
4653
|
+
connectorOperator?: ConnectorOperator | undefined;
|
|
4654
4654
|
/**
|
|
4655
4655
|
* <p> A field in a destination connector, or a field value against which Amazon AppFlow
|
|
4656
4656
|
* validates a source field. </p>
|
|
4657
4657
|
* @public
|
|
4658
4658
|
*/
|
|
4659
|
-
destinationField?: string;
|
|
4659
|
+
destinationField?: string | undefined;
|
|
4660
4660
|
/**
|
|
4661
4661
|
* <p> Specifies the particular task implementation that Amazon AppFlow performs. </p>
|
|
4662
4662
|
* @public
|
|
@@ -4667,7 +4667,7 @@ export interface Task {
|
|
|
4667
4667
|
* information based on the <code>TaskType</code>. </p>
|
|
4668
4668
|
* @public
|
|
4669
4669
|
*/
|
|
4670
|
-
taskProperties?: Partial<Record<OperatorPropertiesKeys, string
|
|
4670
|
+
taskProperties?: Partial<Record<OperatorPropertiesKeys, string>> | undefined;
|
|
4671
4671
|
}
|
|
4672
4672
|
/**
|
|
4673
4673
|
* @public
|
|
@@ -4698,19 +4698,19 @@ export interface ScheduledTriggerProperties {
|
|
|
4698
4698
|
* transfer for each flow run. </p>
|
|
4699
4699
|
* @public
|
|
4700
4700
|
*/
|
|
4701
|
-
dataPullMode?: DataPullMode;
|
|
4701
|
+
dataPullMode?: DataPullMode | undefined;
|
|
4702
4702
|
/**
|
|
4703
4703
|
* <p>The time at which the scheduled flow starts. The time is formatted as a timestamp that
|
|
4704
4704
|
* follows the ISO 8601 standard, such as <code>2022-04-26T13:00:00-07:00</code>.</p>
|
|
4705
4705
|
* @public
|
|
4706
4706
|
*/
|
|
4707
|
-
scheduleStartTime?: Date;
|
|
4707
|
+
scheduleStartTime?: Date | undefined;
|
|
4708
4708
|
/**
|
|
4709
4709
|
* <p>The time at which the scheduled flow ends. The time is formatted as a timestamp that
|
|
4710
4710
|
* follows the ISO 8601 standard, such as <code>2022-04-27T13:00:00-07:00</code>.</p>
|
|
4711
4711
|
* @public
|
|
4712
4712
|
*/
|
|
4713
|
-
scheduleEndTime?: Date;
|
|
4713
|
+
scheduleEndTime?: Date | undefined;
|
|
4714
4714
|
/**
|
|
4715
4715
|
* <p>Specifies the time zone used when referring to the dates and times of a scheduled flow,
|
|
4716
4716
|
* such as <code>America/New_York</code>. This time zone is only a descriptive label. It doesn't
|
|
@@ -4722,25 +4722,25 @@ export interface ScheduledTriggerProperties {
|
|
|
4722
4722
|
* EST</code>.</p>
|
|
4723
4723
|
* @public
|
|
4724
4724
|
*/
|
|
4725
|
-
timezone?: string;
|
|
4725
|
+
timezone?: string | undefined;
|
|
4726
4726
|
/**
|
|
4727
4727
|
* <p> Specifies the optional offset that is added to the time interval for a schedule-triggered
|
|
4728
4728
|
* flow. </p>
|
|
4729
4729
|
* @public
|
|
4730
4730
|
*/
|
|
4731
|
-
scheduleOffset?: number;
|
|
4731
|
+
scheduleOffset?: number | undefined;
|
|
4732
4732
|
/**
|
|
4733
4733
|
* <p> Specifies the date range for the records to import from the connector in the first flow
|
|
4734
4734
|
* run. </p>
|
|
4735
4735
|
* @public
|
|
4736
4736
|
*/
|
|
4737
|
-
firstExecutionFrom?: Date;
|
|
4737
|
+
firstExecutionFrom?: Date | undefined;
|
|
4738
4738
|
/**
|
|
4739
4739
|
* <p>Defines how many times a scheduled flow fails consecutively before Amazon AppFlow
|
|
4740
4740
|
* deactivates it.</p>
|
|
4741
4741
|
* @public
|
|
4742
4742
|
*/
|
|
4743
|
-
flowErrorDeactivationThreshold?: number;
|
|
4743
|
+
flowErrorDeactivationThreshold?: number | undefined;
|
|
4744
4744
|
}
|
|
4745
4745
|
/**
|
|
4746
4746
|
* <p> Specifies the configuration details that control the trigger for a flow. Currently, these
|
|
@@ -4753,7 +4753,7 @@ export interface TriggerProperties {
|
|
|
4753
4753
|
* </p>
|
|
4754
4754
|
* @public
|
|
4755
4755
|
*/
|
|
4756
|
-
Scheduled?: ScheduledTriggerProperties;
|
|
4756
|
+
Scheduled?: ScheduledTriggerProperties | undefined;
|
|
4757
4757
|
}
|
|
4758
4758
|
/**
|
|
4759
4759
|
* <p> The trigger settings that determine how and when Amazon AppFlow runs the specified
|
|
@@ -4772,7 +4772,7 @@ export interface TriggerConfig {
|
|
|
4772
4772
|
* Currently, these settings only apply to the <code>Scheduled</code> trigger type. </p>
|
|
4773
4773
|
* @public
|
|
4774
4774
|
*/
|
|
4775
|
-
triggerProperties?: TriggerProperties;
|
|
4775
|
+
triggerProperties?: TriggerProperties | undefined;
|
|
4776
4776
|
}
|
|
4777
4777
|
/**
|
|
4778
4778
|
* @public
|
|
@@ -4788,14 +4788,14 @@ export interface CreateFlowRequest {
|
|
|
4788
4788
|
* <p> A description of the flow you want to create. </p>
|
|
4789
4789
|
* @public
|
|
4790
4790
|
*/
|
|
4791
|
-
description?: string;
|
|
4791
|
+
description?: string | undefined;
|
|
4792
4792
|
/**
|
|
4793
4793
|
* <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
|
|
4794
4794
|
* encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS
|
|
4795
4795
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
4796
4796
|
* @public
|
|
4797
4797
|
*/
|
|
4798
|
-
kmsArn?: string;
|
|
4798
|
+
kmsArn?: string | undefined;
|
|
4799
4799
|
/**
|
|
4800
4800
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
4801
4801
|
* @public
|
|
@@ -4823,14 +4823,14 @@ export interface CreateFlowRequest {
|
|
|
4823
4823
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
4824
4824
|
* @public
|
|
4825
4825
|
*/
|
|
4826
|
-
tags?: Record<string, string
|
|
4826
|
+
tags?: Record<string, string> | undefined;
|
|
4827
4827
|
/**
|
|
4828
4828
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
|
|
4829
4829
|
* transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
|
|
4830
4830
|
* stores metadata in a data catalog.</p>
|
|
4831
4831
|
* @public
|
|
4832
4832
|
*/
|
|
4833
|
-
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
4833
|
+
metadataCatalogConfig?: MetadataCatalogConfig | undefined;
|
|
4834
4834
|
/**
|
|
4835
4835
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
4836
4836
|
* <code>CreateFlow</code> request completes only once. You choose the value to pass. For
|
|
@@ -4844,7 +4844,7 @@ export interface CreateFlowRequest {
|
|
|
4844
4844
|
* call to <code>CreateFlow</code>. The token is active for 8 hours.</p>
|
|
4845
4845
|
* @public
|
|
4846
4846
|
*/
|
|
4847
|
-
clientToken?: string;
|
|
4847
|
+
clientToken?: string | undefined;
|
|
4848
4848
|
}
|
|
4849
4849
|
/**
|
|
4850
4850
|
* @public
|
|
@@ -4870,12 +4870,12 @@ export interface CreateFlowResponse {
|
|
|
4870
4870
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
4871
4871
|
* @public
|
|
4872
4872
|
*/
|
|
4873
|
-
flowArn?: string;
|
|
4873
|
+
flowArn?: string | undefined;
|
|
4874
4874
|
/**
|
|
4875
4875
|
* <p> Indicates the current status of the flow. </p>
|
|
4876
4876
|
* @public
|
|
4877
4877
|
*/
|
|
4878
|
-
flowStatus?: FlowStatus;
|
|
4878
|
+
flowStatus?: FlowStatus | undefined;
|
|
4879
4879
|
}
|
|
4880
4880
|
/**
|
|
4881
4881
|
* @public
|
|
@@ -4892,7 +4892,7 @@ export interface DeleteConnectorProfileRequest {
|
|
|
4892
4892
|
* in use in one or more flows. </p>
|
|
4893
4893
|
* @public
|
|
4894
4894
|
*/
|
|
4895
|
-
forceDelete?: boolean;
|
|
4895
|
+
forceDelete?: boolean | undefined;
|
|
4896
4896
|
}
|
|
4897
4897
|
/**
|
|
4898
4898
|
* @public
|
|
@@ -4914,7 +4914,7 @@ export interface DeleteFlowRequest {
|
|
|
4914
4914
|
* use. </p>
|
|
4915
4915
|
* @public
|
|
4916
4916
|
*/
|
|
4917
|
-
forceDelete?: boolean;
|
|
4917
|
+
forceDelete?: boolean | undefined;
|
|
4918
4918
|
}
|
|
4919
4919
|
/**
|
|
4920
4920
|
* @public
|
|
@@ -4937,7 +4937,7 @@ export interface DescribeConnectorRequest {
|
|
|
4937
4937
|
* calling for CUSTOMCONNECTOR connector type/.</p>
|
|
4938
4938
|
* @public
|
|
4939
4939
|
*/
|
|
4940
|
-
connectorLabel?: string;
|
|
4940
|
+
connectorLabel?: string | undefined;
|
|
4941
4941
|
}
|
|
4942
4942
|
/**
|
|
4943
4943
|
* @public
|
|
@@ -4947,7 +4947,7 @@ export interface DescribeConnectorResponse {
|
|
|
4947
4947
|
* <p>Configuration info of all the connectors that the user requested.</p>
|
|
4948
4948
|
* @public
|
|
4949
4949
|
*/
|
|
4950
|
-
connectorConfiguration?: ConnectorConfiguration;
|
|
4950
|
+
connectorConfiguration?: ConnectorConfiguration | undefined;
|
|
4951
4951
|
}
|
|
4952
4952
|
/**
|
|
4953
4953
|
* @public
|
|
@@ -4962,18 +4962,18 @@ export interface DescribeConnectorEntityRequest {
|
|
|
4962
4962
|
* <p> The type of connector application, such as Salesforce, Amplitude, and so on. </p>
|
|
4963
4963
|
* @public
|
|
4964
4964
|
*/
|
|
4965
|
-
connectorType?: ConnectorType;
|
|
4965
|
+
connectorType?: ConnectorType | undefined;
|
|
4966
4966
|
/**
|
|
4967
4967
|
* <p> The name of the connector profile. The name is unique for each
|
|
4968
4968
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
4969
4969
|
* @public
|
|
4970
4970
|
*/
|
|
4971
|
-
connectorProfileName?: string;
|
|
4971
|
+
connectorProfileName?: string | undefined;
|
|
4972
4972
|
/**
|
|
4973
4973
|
* <p>The version of the API that's used by the connector.</p>
|
|
4974
4974
|
* @public
|
|
4975
4975
|
*/
|
|
4976
|
-
apiVersion?: string;
|
|
4976
|
+
apiVersion?: string | undefined;
|
|
4977
4977
|
}
|
|
4978
4978
|
/**
|
|
4979
4979
|
* @public
|
|
@@ -4996,30 +4996,30 @@ export interface DescribeConnectorProfilesRequest {
|
|
|
4996
4996
|
* <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
|
|
4997
4997
|
* @public
|
|
4998
4998
|
*/
|
|
4999
|
-
connectorProfileNames?: string[];
|
|
4999
|
+
connectorProfileNames?: string[] | undefined;
|
|
5000
5000
|
/**
|
|
5001
5001
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
5002
5002
|
* @public
|
|
5003
5003
|
*/
|
|
5004
|
-
connectorType?: ConnectorType;
|
|
5004
|
+
connectorType?: ConnectorType | undefined;
|
|
5005
5005
|
/**
|
|
5006
5006
|
* <p>The name of the connector. The name is unique for each <code>ConnectorRegistration</code>
|
|
5007
5007
|
* in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector
|
|
5008
5008
|
* type/.</p>
|
|
5009
5009
|
* @public
|
|
5010
5010
|
*/
|
|
5011
|
-
connectorLabel?: string;
|
|
5011
|
+
connectorLabel?: string | undefined;
|
|
5012
5012
|
/**
|
|
5013
5013
|
* <p> Specifies the maximum number of items that should be returned in the result set. The
|
|
5014
5014
|
* default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
|
|
5015
5015
|
* @public
|
|
5016
5016
|
*/
|
|
5017
|
-
maxResults?: number;
|
|
5017
|
+
maxResults?: number | undefined;
|
|
5018
5018
|
/**
|
|
5019
5019
|
* <p> The pagination token for the next page of data. </p>
|
|
5020
5020
|
* @public
|
|
5021
5021
|
*/
|
|
5022
|
-
nextToken?: string;
|
|
5022
|
+
nextToken?: string | undefined;
|
|
5023
5023
|
}
|
|
5024
5024
|
/**
|
|
5025
5025
|
* @public
|
|
@@ -5029,13 +5029,13 @@ export interface DescribeConnectorProfilesResponse {
|
|
|
5029
5029
|
* <p> Returns information about the connector profiles associated with the flow. </p>
|
|
5030
5030
|
* @public
|
|
5031
5031
|
*/
|
|
5032
|
-
connectorProfileDetails?: ConnectorProfile[];
|
|
5032
|
+
connectorProfileDetails?: ConnectorProfile[] | undefined;
|
|
5033
5033
|
/**
|
|
5034
5034
|
* <p> The pagination token for the next page of data. If <code>nextToken=null</code>, this
|
|
5035
5035
|
* means that all records have been fetched. </p>
|
|
5036
5036
|
* @public
|
|
5037
5037
|
*/
|
|
5038
|
-
nextToken?: string;
|
|
5038
|
+
nextToken?: string | undefined;
|
|
5039
5039
|
}
|
|
5040
5040
|
/**
|
|
5041
5041
|
* @public
|
|
@@ -5045,18 +5045,18 @@ export interface DescribeConnectorsRequest {
|
|
|
5045
5045
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
5046
5046
|
* @public
|
|
5047
5047
|
*/
|
|
5048
|
-
connectorTypes?: ConnectorType[];
|
|
5048
|
+
connectorTypes?: ConnectorType[] | undefined;
|
|
5049
5049
|
/**
|
|
5050
5050
|
* <p>The maximum number of items that should be returned in the result set. The default is
|
|
5051
5051
|
* 20.</p>
|
|
5052
5052
|
* @public
|
|
5053
5053
|
*/
|
|
5054
|
-
maxResults?: number;
|
|
5054
|
+
maxResults?: number | undefined;
|
|
5055
5055
|
/**
|
|
5056
5056
|
* <p> The pagination token for the next page of data. </p>
|
|
5057
5057
|
* @public
|
|
5058
5058
|
*/
|
|
5059
|
-
nextToken?: string;
|
|
5059
|
+
nextToken?: string | undefined;
|
|
5060
5060
|
}
|
|
5061
5061
|
/**
|
|
5062
5062
|
* @public
|
|
@@ -5066,17 +5066,17 @@ export interface DescribeConnectorsResponse {
|
|
|
5066
5066
|
* <p> The configuration that is applied to the connectors used in the flow. </p>
|
|
5067
5067
|
* @public
|
|
5068
5068
|
*/
|
|
5069
|
-
connectorConfigurations?: Partial<Record<ConnectorType, ConnectorConfiguration
|
|
5069
|
+
connectorConfigurations?: Partial<Record<ConnectorType, ConnectorConfiguration>> | undefined;
|
|
5070
5070
|
/**
|
|
5071
5071
|
* <p>Information about the connectors supported in Amazon AppFlow.</p>
|
|
5072
5072
|
* @public
|
|
5073
5073
|
*/
|
|
5074
|
-
connectors?: ConnectorDetail[];
|
|
5074
|
+
connectors?: ConnectorDetail[] | undefined;
|
|
5075
5075
|
/**
|
|
5076
5076
|
* <p> The pagination token for the next page of data. </p>
|
|
5077
5077
|
* @public
|
|
5078
5078
|
*/
|
|
5079
|
-
nextToken?: string;
|
|
5079
|
+
nextToken?: string | undefined;
|
|
5080
5080
|
}
|
|
5081
5081
|
/**
|
|
5082
5082
|
* @public
|
|
@@ -5114,17 +5114,17 @@ export interface ExecutionDetails {
|
|
|
5114
5114
|
* <p> Describes the details of the most recent flow run. </p>
|
|
5115
5115
|
* @public
|
|
5116
5116
|
*/
|
|
5117
|
-
mostRecentExecutionMessage?: string;
|
|
5117
|
+
mostRecentExecutionMessage?: string | undefined;
|
|
5118
5118
|
/**
|
|
5119
5119
|
* <p> Specifies the time of the most recent flow run. </p>
|
|
5120
5120
|
* @public
|
|
5121
5121
|
*/
|
|
5122
|
-
mostRecentExecutionTime?: Date;
|
|
5122
|
+
mostRecentExecutionTime?: Date | undefined;
|
|
5123
5123
|
/**
|
|
5124
5124
|
* <p> Specifies the status of the most recent flow run. </p>
|
|
5125
5125
|
* @public
|
|
5126
5126
|
*/
|
|
5127
|
-
mostRecentExecutionStatus?: ExecutionStatus;
|
|
5127
|
+
mostRecentExecutionStatus?: ExecutionStatus | undefined;
|
|
5128
5128
|
}
|
|
5129
5129
|
/**
|
|
5130
5130
|
* <p>Describes the status of an attempt from Amazon AppFlow to register a resource.</p>
|
|
@@ -5140,18 +5140,18 @@ export interface RegistrationOutput {
|
|
|
5140
5140
|
* fails, the message explains why.</p>
|
|
5141
5141
|
* @public
|
|
5142
5142
|
*/
|
|
5143
|
-
message?: string;
|
|
5143
|
+
message?: string | undefined;
|
|
5144
5144
|
/**
|
|
5145
5145
|
* <p>Indicates the number of resources that Amazon AppFlow created or updated. Possible
|
|
5146
5146
|
* resources include metadata tables and data partitions.</p>
|
|
5147
5147
|
* @public
|
|
5148
5148
|
*/
|
|
5149
|
-
result?: string;
|
|
5149
|
+
result?: string | undefined;
|
|
5150
5150
|
/**
|
|
5151
5151
|
* <p>Indicates the status of the registration attempt from Amazon AppFlow.</p>
|
|
5152
5152
|
* @public
|
|
5153
5153
|
*/
|
|
5154
|
-
status?: ExecutionStatus;
|
|
5154
|
+
status?: ExecutionStatus | undefined;
|
|
5155
5155
|
}
|
|
5156
5156
|
/**
|
|
5157
5157
|
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
@@ -5170,21 +5170,21 @@ export interface MetadataCatalogDetail {
|
|
|
5170
5170
|
* </dl>
|
|
5171
5171
|
* @public
|
|
5172
5172
|
*/
|
|
5173
|
-
catalogType?: CatalogType;
|
|
5173
|
+
catalogType?: CatalogType | undefined;
|
|
5174
5174
|
/**
|
|
5175
5175
|
* <p>The name of the table that stores the metadata for the associated flow run. The table
|
|
5176
5176
|
* stores metadata that represents the data that the flow transferred. Amazon AppFlow stores
|
|
5177
5177
|
* the table in the metadata catalog.</p>
|
|
5178
5178
|
* @public
|
|
5179
5179
|
*/
|
|
5180
|
-
tableName?: string;
|
|
5180
|
+
tableName?: string | undefined;
|
|
5181
5181
|
/**
|
|
5182
5182
|
* <p>Describes the status of the attempt from Amazon AppFlow to register the metadata
|
|
5183
5183
|
* table with the metadata catalog. Amazon AppFlow creates or updates this table for the
|
|
5184
5184
|
* associated flow run.</p>
|
|
5185
5185
|
* @public
|
|
5186
5186
|
*/
|
|
5187
|
-
tableRegistrationOutput?: RegistrationOutput;
|
|
5187
|
+
tableRegistrationOutput?: RegistrationOutput | undefined;
|
|
5188
5188
|
/**
|
|
5189
5189
|
* <p>Describes the status of the attempt from Amazon AppFlow to register the data
|
|
5190
5190
|
* partitions with the metadata catalog. The data partitions organize the flow output into a
|
|
@@ -5192,7 +5192,7 @@ export interface MetadataCatalogDetail {
|
|
|
5192
5192
|
* partitions (if they don't already exist) based on your flow configuration.</p>
|
|
5193
5193
|
* @public
|
|
5194
5194
|
*/
|
|
5195
|
-
partitionRegistrationOutput?: RegistrationOutput;
|
|
5195
|
+
partitionRegistrationOutput?: RegistrationOutput | undefined;
|
|
5196
5196
|
}
|
|
5197
5197
|
/**
|
|
5198
5198
|
* @public
|
|
@@ -5202,101 +5202,101 @@ export interface DescribeFlowResponse {
|
|
|
5202
5202
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5203
5203
|
* @public
|
|
5204
5204
|
*/
|
|
5205
|
-
flowArn?: string;
|
|
5205
|
+
flowArn?: string | undefined;
|
|
5206
5206
|
/**
|
|
5207
5207
|
* <p> A description of the flow. </p>
|
|
5208
5208
|
* @public
|
|
5209
5209
|
*/
|
|
5210
|
-
description?: string;
|
|
5210
|
+
description?: string | undefined;
|
|
5211
5211
|
/**
|
|
5212
5212
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
5213
5213
|
* (-) only. </p>
|
|
5214
5214
|
* @public
|
|
5215
5215
|
*/
|
|
5216
|
-
flowName?: string;
|
|
5216
|
+
flowName?: string | undefined;
|
|
5217
5217
|
/**
|
|
5218
5218
|
* <p> The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
|
|
5219
5219
|
* encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS
|
|
5220
5220
|
* key. If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key. </p>
|
|
5221
5221
|
* @public
|
|
5222
5222
|
*/
|
|
5223
|
-
kmsArn?: string;
|
|
5223
|
+
kmsArn?: string | undefined;
|
|
5224
5224
|
/**
|
|
5225
5225
|
* <p> Indicates the current status of the flow. </p>
|
|
5226
5226
|
* @public
|
|
5227
5227
|
*/
|
|
5228
|
-
flowStatus?: FlowStatus;
|
|
5228
|
+
flowStatus?: FlowStatus | undefined;
|
|
5229
5229
|
/**
|
|
5230
5230
|
* <p> Contains an error message if the flow status is in a suspended or error state. This
|
|
5231
5231
|
* applies only to scheduled or event-triggered flows. </p>
|
|
5232
5232
|
* @public
|
|
5233
5233
|
*/
|
|
5234
|
-
flowStatusMessage?: string;
|
|
5234
|
+
flowStatusMessage?: string | undefined;
|
|
5235
5235
|
/**
|
|
5236
5236
|
* <p> The configuration that controls how Amazon AppFlow retrieves data from the source
|
|
5237
5237
|
* connector. </p>
|
|
5238
5238
|
* @public
|
|
5239
5239
|
*/
|
|
5240
|
-
sourceFlowConfig?: SourceFlowConfig;
|
|
5240
|
+
sourceFlowConfig?: SourceFlowConfig | undefined;
|
|
5241
5241
|
/**
|
|
5242
5242
|
* <p> The configuration that controls how Amazon AppFlow transfers data to the destination
|
|
5243
5243
|
* connector. </p>
|
|
5244
5244
|
* @public
|
|
5245
5245
|
*/
|
|
5246
|
-
destinationFlowConfigList?: DestinationFlowConfig[];
|
|
5246
|
+
destinationFlowConfigList?: DestinationFlowConfig[] | undefined;
|
|
5247
5247
|
/**
|
|
5248
5248
|
* <p> Describes the details of the most recent flow run. </p>
|
|
5249
5249
|
* @public
|
|
5250
5250
|
*/
|
|
5251
|
-
lastRunExecutionDetails?: ExecutionDetails;
|
|
5251
|
+
lastRunExecutionDetails?: ExecutionDetails | undefined;
|
|
5252
5252
|
/**
|
|
5253
5253
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
5254
5254
|
* @public
|
|
5255
5255
|
*/
|
|
5256
|
-
triggerConfig?: TriggerConfig;
|
|
5256
|
+
triggerConfig?: TriggerConfig | undefined;
|
|
5257
5257
|
/**
|
|
5258
5258
|
* <p> A list of tasks that Amazon AppFlow performs while transferring the data in the flow
|
|
5259
5259
|
* run. </p>
|
|
5260
5260
|
* @public
|
|
5261
5261
|
*/
|
|
5262
|
-
tasks?: Task[];
|
|
5262
|
+
tasks?: Task[] | undefined;
|
|
5263
5263
|
/**
|
|
5264
5264
|
* <p> Specifies when the flow was created. </p>
|
|
5265
5265
|
* @public
|
|
5266
5266
|
*/
|
|
5267
|
-
createdAt?: Date;
|
|
5267
|
+
createdAt?: Date | undefined;
|
|
5268
5268
|
/**
|
|
5269
5269
|
* <p> Specifies when the flow was last updated. </p>
|
|
5270
5270
|
* @public
|
|
5271
5271
|
*/
|
|
5272
|
-
lastUpdatedAt?: Date;
|
|
5272
|
+
lastUpdatedAt?: Date | undefined;
|
|
5273
5273
|
/**
|
|
5274
5274
|
* <p> The ARN of the user who created the flow. </p>
|
|
5275
5275
|
* @public
|
|
5276
5276
|
*/
|
|
5277
|
-
createdBy?: string;
|
|
5277
|
+
createdBy?: string | undefined;
|
|
5278
5278
|
/**
|
|
5279
5279
|
* <p> Specifies the user name of the account that performed the most recent update. </p>
|
|
5280
5280
|
* @public
|
|
5281
5281
|
*/
|
|
5282
|
-
lastUpdatedBy?: string;
|
|
5282
|
+
lastUpdatedBy?: string | undefined;
|
|
5283
5283
|
/**
|
|
5284
5284
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
5285
5285
|
* @public
|
|
5286
5286
|
*/
|
|
5287
|
-
tags?: Record<string, string
|
|
5287
|
+
tags?: Record<string, string> | undefined;
|
|
5288
5288
|
/**
|
|
5289
5289
|
* <p>Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
|
|
5290
5290
|
* transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
|
|
5291
5291
|
* stores metadata in a data catalog.</p>
|
|
5292
5292
|
* @public
|
|
5293
5293
|
*/
|
|
5294
|
-
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
5294
|
+
metadataCatalogConfig?: MetadataCatalogConfig | undefined;
|
|
5295
5295
|
/**
|
|
5296
5296
|
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
5297
5297
|
* @public
|
|
5298
5298
|
*/
|
|
5299
|
-
lastRunMetadataCatalogDetails?: MetadataCatalogDetail[];
|
|
5299
|
+
lastRunMetadataCatalogDetails?: MetadataCatalogDetail[] | undefined;
|
|
5300
5300
|
/**
|
|
5301
5301
|
* <p>The version number of your data schema. Amazon AppFlow assigns this version number.
|
|
5302
5302
|
* The version number increases by one when you change any of the following settings in your flow
|
|
@@ -5314,7 +5314,7 @@ export interface DescribeFlowResponse {
|
|
|
5314
5314
|
* </ul>
|
|
5315
5315
|
* @public
|
|
5316
5316
|
*/
|
|
5317
|
-
schemaVersion?: number;
|
|
5317
|
+
schemaVersion?: number | undefined;
|
|
5318
5318
|
}
|
|
5319
5319
|
/**
|
|
5320
5320
|
* @public
|
|
@@ -5331,12 +5331,12 @@ export interface DescribeFlowExecutionRecordsRequest {
|
|
|
5331
5331
|
* default for <code>maxResults</code> is 20 (for all paginated API operations). </p>
|
|
5332
5332
|
* @public
|
|
5333
5333
|
*/
|
|
5334
|
-
maxResults?: number;
|
|
5334
|
+
maxResults?: number | undefined;
|
|
5335
5335
|
/**
|
|
5336
5336
|
* <p> The pagination token for the next page of data. </p>
|
|
5337
5337
|
* @public
|
|
5338
5338
|
*/
|
|
5339
|
-
nextToken?: string;
|
|
5339
|
+
nextToken?: string | undefined;
|
|
5340
5340
|
}
|
|
5341
5341
|
/**
|
|
5342
5342
|
* <p> Provides details in the event of a failed flow, including the failure count and the
|
|
@@ -5348,12 +5348,12 @@ export interface ErrorInfo {
|
|
|
5348
5348
|
* <p> Specifies the failure count for the attempted flow. </p>
|
|
5349
5349
|
* @public
|
|
5350
5350
|
*/
|
|
5351
|
-
putFailuresCount?: number;
|
|
5351
|
+
putFailuresCount?: number | undefined;
|
|
5352
5352
|
/**
|
|
5353
5353
|
* <p> Specifies the error message that appears if a flow fails. </p>
|
|
5354
5354
|
* @public
|
|
5355
5355
|
*/
|
|
5356
|
-
executionMessage?: string;
|
|
5356
|
+
executionMessage?: string | undefined;
|
|
5357
5357
|
}
|
|
5358
5358
|
/**
|
|
5359
5359
|
* <p> Specifies the end result of the flow run. </p>
|
|
@@ -5364,34 +5364,34 @@ export interface ExecutionResult {
|
|
|
5364
5364
|
* <p> Provides any error message information related to the flow run. </p>
|
|
5365
5365
|
* @public
|
|
5366
5366
|
*/
|
|
5367
|
-
errorInfo?: ErrorInfo;
|
|
5367
|
+
errorInfo?: ErrorInfo | undefined;
|
|
5368
5368
|
/**
|
|
5369
5369
|
* <p> The total number of bytes processed by the flow run. </p>
|
|
5370
5370
|
* @public
|
|
5371
5371
|
*/
|
|
5372
|
-
bytesProcessed?: number;
|
|
5372
|
+
bytesProcessed?: number | undefined;
|
|
5373
5373
|
/**
|
|
5374
5374
|
* <p> The total number of bytes written as a result of the flow run. </p>
|
|
5375
5375
|
* @public
|
|
5376
5376
|
*/
|
|
5377
|
-
bytesWritten?: number;
|
|
5377
|
+
bytesWritten?: number | undefined;
|
|
5378
5378
|
/**
|
|
5379
5379
|
* <p> The number of records processed in the flow run. </p>
|
|
5380
5380
|
* @public
|
|
5381
5381
|
*/
|
|
5382
|
-
recordsProcessed?: number;
|
|
5382
|
+
recordsProcessed?: number | undefined;
|
|
5383
5383
|
/**
|
|
5384
5384
|
* <p>The number of processes that Amazon AppFlow ran at the same time when it retrieved
|
|
5385
5385
|
* your data.</p>
|
|
5386
5386
|
* @public
|
|
5387
5387
|
*/
|
|
5388
|
-
numParallelProcesses?: number;
|
|
5388
|
+
numParallelProcesses?: number | undefined;
|
|
5389
5389
|
/**
|
|
5390
5390
|
* <p>The maximum number of records that Amazon AppFlow receives in each page of the
|
|
5391
5391
|
* response from your SAP application.</p>
|
|
5392
5392
|
* @public
|
|
5393
5393
|
*/
|
|
5394
|
-
maxPageSize?: number;
|
|
5394
|
+
maxPageSize?: number | undefined;
|
|
5395
5395
|
}
|
|
5396
5396
|
/**
|
|
5397
5397
|
* <p> Specifies information about the past flow run instances for a given flow. </p>
|
|
@@ -5402,45 +5402,45 @@ export interface ExecutionRecord {
|
|
|
5402
5402
|
* <p> Specifies the identifier of the given flow run. </p>
|
|
5403
5403
|
* @public
|
|
5404
5404
|
*/
|
|
5405
|
-
executionId?: string;
|
|
5405
|
+
executionId?: string | undefined;
|
|
5406
5406
|
/**
|
|
5407
5407
|
* <p> Specifies the flow run status and whether it is in progress, has completed successfully,
|
|
5408
5408
|
* or has failed. </p>
|
|
5409
5409
|
* @public
|
|
5410
5410
|
*/
|
|
5411
|
-
executionStatus?: ExecutionStatus;
|
|
5411
|
+
executionStatus?: ExecutionStatus | undefined;
|
|
5412
5412
|
/**
|
|
5413
5413
|
* <p> Describes the result of the given flow run. </p>
|
|
5414
5414
|
* @public
|
|
5415
5415
|
*/
|
|
5416
|
-
executionResult?: ExecutionResult;
|
|
5416
|
+
executionResult?: ExecutionResult | undefined;
|
|
5417
5417
|
/**
|
|
5418
5418
|
* <p> Specifies the start time of the flow run. </p>
|
|
5419
5419
|
* @public
|
|
5420
5420
|
*/
|
|
5421
|
-
startedAt?: Date;
|
|
5421
|
+
startedAt?: Date | undefined;
|
|
5422
5422
|
/**
|
|
5423
5423
|
* <p> Specifies the time of the most recent update. </p>
|
|
5424
5424
|
* @public
|
|
5425
5425
|
*/
|
|
5426
|
-
lastUpdatedAt?: Date;
|
|
5426
|
+
lastUpdatedAt?: Date | undefined;
|
|
5427
5427
|
/**
|
|
5428
5428
|
* <p> The timestamp that determines the first new or updated record to be transferred in the
|
|
5429
5429
|
* flow run. </p>
|
|
5430
5430
|
* @public
|
|
5431
5431
|
*/
|
|
5432
|
-
dataPullStartTime?: Date;
|
|
5432
|
+
dataPullStartTime?: Date | undefined;
|
|
5433
5433
|
/**
|
|
5434
5434
|
* <p> The timestamp that indicates the last new or updated record to be transferred in the flow
|
|
5435
5435
|
* run. </p>
|
|
5436
5436
|
* @public
|
|
5437
5437
|
*/
|
|
5438
|
-
dataPullEndTime?: Date;
|
|
5438
|
+
dataPullEndTime?: Date | undefined;
|
|
5439
5439
|
/**
|
|
5440
5440
|
* <p>Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used for the associated flow run.</p>
|
|
5441
5441
|
* @public
|
|
5442
5442
|
*/
|
|
5443
|
-
metadataCatalogDetails?: MetadataCatalogDetail[];
|
|
5443
|
+
metadataCatalogDetails?: MetadataCatalogDetail[] | undefined;
|
|
5444
5444
|
}
|
|
5445
5445
|
/**
|
|
5446
5446
|
* @public
|
|
@@ -5450,12 +5450,12 @@ export interface DescribeFlowExecutionRecordsResponse {
|
|
|
5450
5450
|
* <p> Returns a list of all instances when this flow was run. </p>
|
|
5451
5451
|
* @public
|
|
5452
5452
|
*/
|
|
5453
|
-
flowExecutions?: ExecutionRecord[];
|
|
5453
|
+
flowExecutions?: ExecutionRecord[] | undefined;
|
|
5454
5454
|
/**
|
|
5455
5455
|
* <p> The pagination token for the next page of data. </p>
|
|
5456
5456
|
* @public
|
|
5457
5457
|
*/
|
|
5458
|
-
nextToken?: string;
|
|
5458
|
+
nextToken?: string | undefined;
|
|
5459
5459
|
}
|
|
5460
5460
|
/**
|
|
5461
5461
|
* <p> The properties of the flow, such as its source, destination, trigger type, and so on.
|
|
@@ -5467,81 +5467,81 @@ export interface FlowDefinition {
|
|
|
5467
5467
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5468
5468
|
* @public
|
|
5469
5469
|
*/
|
|
5470
|
-
flowArn?: string;
|
|
5470
|
+
flowArn?: string | undefined;
|
|
5471
5471
|
/**
|
|
5472
5472
|
* <p> A user-entered description of the flow. </p>
|
|
5473
5473
|
* @public
|
|
5474
5474
|
*/
|
|
5475
|
-
description?: string;
|
|
5475
|
+
description?: string | undefined;
|
|
5476
5476
|
/**
|
|
5477
5477
|
* <p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens
|
|
5478
5478
|
* (-) only. </p>
|
|
5479
5479
|
* @public
|
|
5480
5480
|
*/
|
|
5481
|
-
flowName?: string;
|
|
5481
|
+
flowName?: string | undefined;
|
|
5482
5482
|
/**
|
|
5483
5483
|
* <p> Indicates the current status of the flow. </p>
|
|
5484
5484
|
* @public
|
|
5485
5485
|
*/
|
|
5486
|
-
flowStatus?: FlowStatus;
|
|
5486
|
+
flowStatus?: FlowStatus | undefined;
|
|
5487
5487
|
/**
|
|
5488
5488
|
* <p> Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude,
|
|
5489
5489
|
* and so on. </p>
|
|
5490
5490
|
* @public
|
|
5491
5491
|
*/
|
|
5492
|
-
sourceConnectorType?: ConnectorType;
|
|
5492
|
+
sourceConnectorType?: ConnectorType | undefined;
|
|
5493
5493
|
/**
|
|
5494
5494
|
* <p>The label of the source connector in the flow.</p>
|
|
5495
5495
|
* @public
|
|
5496
5496
|
*/
|
|
5497
|
-
sourceConnectorLabel?: string;
|
|
5497
|
+
sourceConnectorLabel?: string | undefined;
|
|
5498
5498
|
/**
|
|
5499
5499
|
* <p> Specifies the destination connector type, such as Salesforce, Amazon S3,
|
|
5500
5500
|
* Amplitude, and so on. </p>
|
|
5501
5501
|
* @public
|
|
5502
5502
|
*/
|
|
5503
|
-
destinationConnectorType?: ConnectorType;
|
|
5503
|
+
destinationConnectorType?: ConnectorType | undefined;
|
|
5504
5504
|
/**
|
|
5505
5505
|
* <p>The label of the destination connector in the flow.</p>
|
|
5506
5506
|
* @public
|
|
5507
5507
|
*/
|
|
5508
|
-
destinationConnectorLabel?: string;
|
|
5508
|
+
destinationConnectorLabel?: string | undefined;
|
|
5509
5509
|
/**
|
|
5510
5510
|
* <p> Specifies the type of flow trigger. This can be <code>OnDemand</code>,
|
|
5511
5511
|
* <code>Scheduled</code>, or <code>Event</code>. </p>
|
|
5512
5512
|
* @public
|
|
5513
5513
|
*/
|
|
5514
|
-
triggerType?: TriggerType;
|
|
5514
|
+
triggerType?: TriggerType | undefined;
|
|
5515
5515
|
/**
|
|
5516
5516
|
* <p> Specifies when the flow was created. </p>
|
|
5517
5517
|
* @public
|
|
5518
5518
|
*/
|
|
5519
|
-
createdAt?: Date;
|
|
5519
|
+
createdAt?: Date | undefined;
|
|
5520
5520
|
/**
|
|
5521
5521
|
* <p> Specifies when the flow was last updated. </p>
|
|
5522
5522
|
* @public
|
|
5523
5523
|
*/
|
|
5524
|
-
lastUpdatedAt?: Date;
|
|
5524
|
+
lastUpdatedAt?: Date | undefined;
|
|
5525
5525
|
/**
|
|
5526
5526
|
* <p> The ARN of the user who created the flow. </p>
|
|
5527
5527
|
* @public
|
|
5528
5528
|
*/
|
|
5529
|
-
createdBy?: string;
|
|
5529
|
+
createdBy?: string | undefined;
|
|
5530
5530
|
/**
|
|
5531
5531
|
* <p> Specifies the account user name that most recently updated the flow. </p>
|
|
5532
5532
|
* @public
|
|
5533
5533
|
*/
|
|
5534
|
-
lastUpdatedBy?: string;
|
|
5534
|
+
lastUpdatedBy?: string | undefined;
|
|
5535
5535
|
/**
|
|
5536
5536
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
5537
5537
|
* @public
|
|
5538
5538
|
*/
|
|
5539
|
-
tags?: Record<string, string
|
|
5539
|
+
tags?: Record<string, string> | undefined;
|
|
5540
5540
|
/**
|
|
5541
5541
|
* <p> Describes the details of the most recent flow run. </p>
|
|
5542
5542
|
* @public
|
|
5543
5543
|
*/
|
|
5544
|
-
lastRunExecutionDetails?: ExecutionDetails;
|
|
5544
|
+
lastRunExecutionDetails?: ExecutionDetails | undefined;
|
|
5545
5545
|
}
|
|
5546
5546
|
/**
|
|
5547
5547
|
* @public
|
|
@@ -5553,12 +5553,12 @@ export interface ListConnectorEntitiesRequest {
|
|
|
5553
5553
|
* downstream connector. </p>
|
|
5554
5554
|
* @public
|
|
5555
5555
|
*/
|
|
5556
|
-
connectorProfileName?: string;
|
|
5556
|
+
connectorProfileName?: string | undefined;
|
|
5557
5557
|
/**
|
|
5558
5558
|
* <p> The type of connector, such as Salesforce, Amplitude, and so on. </p>
|
|
5559
5559
|
* @public
|
|
5560
5560
|
*/
|
|
5561
|
-
connectorType?: ConnectorType;
|
|
5561
|
+
connectorType?: ConnectorType | undefined;
|
|
5562
5562
|
/**
|
|
5563
5563
|
* <p> This optional parameter is specific to connector implementation. Some connectors support
|
|
5564
5564
|
* multiple levels or categories of entities. You can find out the list of roots for such
|
|
@@ -5567,24 +5567,24 @@ export interface ListConnectorEntitiesRequest {
|
|
|
5567
5567
|
* roots. Otherwise, this request returns all entities supported by the provider. </p>
|
|
5568
5568
|
* @public
|
|
5569
5569
|
*/
|
|
5570
|
-
entitiesPath?: string;
|
|
5570
|
+
entitiesPath?: string | undefined;
|
|
5571
5571
|
/**
|
|
5572
5572
|
* <p>The version of the API that's used by the connector.</p>
|
|
5573
5573
|
* @public
|
|
5574
5574
|
*/
|
|
5575
|
-
apiVersion?: string;
|
|
5575
|
+
apiVersion?: string | undefined;
|
|
5576
5576
|
/**
|
|
5577
5577
|
* <p>The maximum number of items that the operation returns in the response.</p>
|
|
5578
5578
|
* @public
|
|
5579
5579
|
*/
|
|
5580
|
-
maxResults?: number;
|
|
5580
|
+
maxResults?: number | undefined;
|
|
5581
5581
|
/**
|
|
5582
5582
|
* <p>A token that was provided by your prior <code>ListConnectorEntities</code> operation if
|
|
5583
5583
|
* the response was too big for the page size. You specify this token to get the next page of
|
|
5584
5584
|
* results in paginated response.</p>
|
|
5585
5585
|
* @public
|
|
5586
5586
|
*/
|
|
5587
|
-
nextToken?: string;
|
|
5587
|
+
nextToken?: string | undefined;
|
|
5588
5588
|
}
|
|
5589
5589
|
/**
|
|
5590
5590
|
* @public
|
|
@@ -5603,7 +5603,7 @@ export interface ListConnectorEntitiesResponse {
|
|
|
5603
5603
|
* operation provides this token if the response is too big for the page size.</p>
|
|
5604
5604
|
* @public
|
|
5605
5605
|
*/
|
|
5606
|
-
nextToken?: string;
|
|
5606
|
+
nextToken?: string | undefined;
|
|
5607
5607
|
}
|
|
5608
5608
|
/**
|
|
5609
5609
|
* @public
|
|
@@ -5614,12 +5614,12 @@ export interface ListConnectorsRequest {
|
|
|
5614
5614
|
* default for <code>maxResults</code> is 20 (for all paginated API operations).</p>
|
|
5615
5615
|
* @public
|
|
5616
5616
|
*/
|
|
5617
|
-
maxResults?: number;
|
|
5617
|
+
maxResults?: number | undefined;
|
|
5618
5618
|
/**
|
|
5619
5619
|
* <p>The pagination token for the next page of data.</p>
|
|
5620
5620
|
* @public
|
|
5621
5621
|
*/
|
|
5622
|
-
nextToken?: string;
|
|
5622
|
+
nextToken?: string | undefined;
|
|
5623
5623
|
}
|
|
5624
5624
|
/**
|
|
5625
5625
|
* @public
|
|
@@ -5629,13 +5629,13 @@ export interface ListConnectorsResponse {
|
|
|
5629
5629
|
* <p>Contains information about the connectors supported by Amazon AppFlow.</p>
|
|
5630
5630
|
* @public
|
|
5631
5631
|
*/
|
|
5632
|
-
connectors?: ConnectorDetail[];
|
|
5632
|
+
connectors?: ConnectorDetail[] | undefined;
|
|
5633
5633
|
/**
|
|
5634
5634
|
* <p>The pagination token for the next page of data. If nextToken=null, this means that all
|
|
5635
5635
|
* records have been fetched.</p>
|
|
5636
5636
|
* @public
|
|
5637
5637
|
*/
|
|
5638
|
-
nextToken?: string;
|
|
5638
|
+
nextToken?: string | undefined;
|
|
5639
5639
|
}
|
|
5640
5640
|
/**
|
|
5641
5641
|
* @public
|
|
@@ -5645,12 +5645,12 @@ export interface ListFlowsRequest {
|
|
|
5645
5645
|
* <p> Specifies the maximum number of items that should be returned in the result set. </p>
|
|
5646
5646
|
* @public
|
|
5647
5647
|
*/
|
|
5648
|
-
maxResults?: number;
|
|
5648
|
+
maxResults?: number | undefined;
|
|
5649
5649
|
/**
|
|
5650
5650
|
* <p> The pagination token for next page of data. </p>
|
|
5651
5651
|
* @public
|
|
5652
5652
|
*/
|
|
5653
|
-
nextToken?: string;
|
|
5653
|
+
nextToken?: string | undefined;
|
|
5654
5654
|
}
|
|
5655
5655
|
/**
|
|
5656
5656
|
* @public
|
|
@@ -5660,12 +5660,12 @@ export interface ListFlowsResponse {
|
|
|
5660
5660
|
* <p> The list of flows associated with your account. </p>
|
|
5661
5661
|
* @public
|
|
5662
5662
|
*/
|
|
5663
|
-
flows?: FlowDefinition[];
|
|
5663
|
+
flows?: FlowDefinition[] | undefined;
|
|
5664
5664
|
/**
|
|
5665
5665
|
* <p> The pagination token for next page of data. </p>
|
|
5666
5666
|
* @public
|
|
5667
5667
|
*/
|
|
5668
|
-
nextToken?: string;
|
|
5668
|
+
nextToken?: string | undefined;
|
|
5669
5669
|
}
|
|
5670
5670
|
/**
|
|
5671
5671
|
* @public
|
|
@@ -5685,7 +5685,7 @@ export interface ListTagsForResourceResponse {
|
|
|
5685
5685
|
* <p> The tags used to organize, track, or control access for your flow. </p>
|
|
5686
5686
|
* @public
|
|
5687
5687
|
*/
|
|
5688
|
-
tags?: Record<string, string
|
|
5688
|
+
tags?: Record<string, string> | undefined;
|
|
5689
5689
|
}
|
|
5690
5690
|
/**
|
|
5691
5691
|
* @public
|
|
@@ -5696,24 +5696,24 @@ export interface RegisterConnectorRequest {
|
|
|
5696
5696
|
* in your Amazon Web Services account.</p>
|
|
5697
5697
|
* @public
|
|
5698
5698
|
*/
|
|
5699
|
-
connectorLabel?: string;
|
|
5699
|
+
connectorLabel?: string | undefined;
|
|
5700
5700
|
/**
|
|
5701
5701
|
* <p>A description about the connector that's being registered.</p>
|
|
5702
5702
|
* @public
|
|
5703
5703
|
*/
|
|
5704
|
-
description?: string;
|
|
5704
|
+
description?: string | undefined;
|
|
5705
5705
|
/**
|
|
5706
5706
|
* <p>The provisioning type of the connector. Currently the only supported value is LAMBDA.
|
|
5707
5707
|
* </p>
|
|
5708
5708
|
* @public
|
|
5709
5709
|
*/
|
|
5710
|
-
connectorProvisioningType?: ConnectorProvisioningType;
|
|
5710
|
+
connectorProvisioningType?: ConnectorProvisioningType | undefined;
|
|
5711
5711
|
/**
|
|
5712
5712
|
* <p>The provisioning type of the connector. Currently the only supported value is
|
|
5713
5713
|
* LAMBDA.</p>
|
|
5714
5714
|
* @public
|
|
5715
5715
|
*/
|
|
5716
|
-
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
5716
|
+
connectorProvisioningConfig?: ConnectorProvisioningConfig | undefined;
|
|
5717
5717
|
/**
|
|
5718
5718
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
5719
5719
|
* <code>RegisterConnector</code> request completes only once. You choose the value to pass.
|
|
@@ -5727,7 +5727,7 @@ export interface RegisterConnectorRequest {
|
|
|
5727
5727
|
* call to <code>RegisterConnector</code>. The token is active for 8 hours.</p>
|
|
5728
5728
|
* @public
|
|
5729
5729
|
*/
|
|
5730
|
-
clientToken?: string;
|
|
5730
|
+
clientToken?: string | undefined;
|
|
5731
5731
|
}
|
|
5732
5732
|
/**
|
|
5733
5733
|
* @public
|
|
@@ -5737,7 +5737,7 @@ export interface RegisterConnectorResponse {
|
|
|
5737
5737
|
* <p>The ARN of the connector being registered.</p>
|
|
5738
5738
|
* @public
|
|
5739
5739
|
*/
|
|
5740
|
-
connectorArn?: string;
|
|
5740
|
+
connectorArn?: string | undefined;
|
|
5741
5741
|
}
|
|
5742
5742
|
/**
|
|
5743
5743
|
* @public
|
|
@@ -5750,7 +5750,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5750
5750
|
* parameter in your request.</p>
|
|
5751
5751
|
* @public
|
|
5752
5752
|
*/
|
|
5753
|
-
connectorProfileName?: string;
|
|
5753
|
+
connectorProfileName?: string | undefined;
|
|
5754
5754
|
/**
|
|
5755
5755
|
* <p>The type of connector to reset cached metadata for.</p>
|
|
5756
5756
|
* <p>You must include this parameter in your request if you're resetting the cache for any of
|
|
@@ -5759,7 +5759,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5759
5759
|
* can omit this parameter from your request. </p>
|
|
5760
5760
|
* @public
|
|
5761
5761
|
*/
|
|
5762
|
-
connectorType?: ConnectorType;
|
|
5762
|
+
connectorType?: ConnectorType | undefined;
|
|
5763
5763
|
/**
|
|
5764
5764
|
* <p>Use this parameter if you want to reset cached metadata about the details for an
|
|
5765
5765
|
* individual entity.</p>
|
|
@@ -5767,7 +5767,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5767
5767
|
* cached metadata about entity names, not entity details.</p>
|
|
5768
5768
|
* @public
|
|
5769
5769
|
*/
|
|
5770
|
-
connectorEntityName?: string;
|
|
5770
|
+
connectorEntityName?: string | undefined;
|
|
5771
5771
|
/**
|
|
5772
5772
|
* <p>Use this parameter only if you’re resetting the cached metadata about a nested entity.
|
|
5773
5773
|
* Only some connectors support nested entities. A nested entity is one that has another entity
|
|
@@ -5780,7 +5780,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5780
5780
|
* parent.</p>
|
|
5781
5781
|
* @public
|
|
5782
5782
|
*/
|
|
5783
|
-
entitiesPath?: string;
|
|
5783
|
+
entitiesPath?: string | undefined;
|
|
5784
5784
|
/**
|
|
5785
5785
|
* <p>The API version that you specified in the connector profile that you’re resetting cached
|
|
5786
5786
|
* metadata for. You must use this parameter only if the connector supports multiple API versions
|
|
@@ -5794,7 +5794,7 @@ export interface ResetConnectorMetadataCacheRequest {
|
|
|
5794
5794
|
* DescribeConnectorProfiles action.</p>
|
|
5795
5795
|
* @public
|
|
5796
5796
|
*/
|
|
5797
|
-
apiVersion?: string;
|
|
5797
|
+
apiVersion?: string | undefined;
|
|
5798
5798
|
}
|
|
5799
5799
|
/**
|
|
5800
5800
|
* @public
|
|
@@ -5827,7 +5827,7 @@ export interface StartFlowRequest {
|
|
|
5827
5827
|
* it a new call to <code>StartFlow</code>. The token is active for 8 hours.</p>
|
|
5828
5828
|
* @public
|
|
5829
5829
|
*/
|
|
5830
|
-
clientToken?: string;
|
|
5830
|
+
clientToken?: string | undefined;
|
|
5831
5831
|
}
|
|
5832
5832
|
/**
|
|
5833
5833
|
* @public
|
|
@@ -5837,18 +5837,18 @@ export interface StartFlowResponse {
|
|
|
5837
5837
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5838
5838
|
* @public
|
|
5839
5839
|
*/
|
|
5840
|
-
flowArn?: string;
|
|
5840
|
+
flowArn?: string | undefined;
|
|
5841
5841
|
/**
|
|
5842
5842
|
* <p> Indicates the current status of the flow. </p>
|
|
5843
5843
|
* @public
|
|
5844
5844
|
*/
|
|
5845
|
-
flowStatus?: FlowStatus;
|
|
5845
|
+
flowStatus?: FlowStatus | undefined;
|
|
5846
5846
|
/**
|
|
5847
5847
|
* <p> Returns the internal execution ID of an on-demand flow when the flow is started. For
|
|
5848
5848
|
* scheduled or event-triggered flows, this value is null. </p>
|
|
5849
5849
|
* @public
|
|
5850
5850
|
*/
|
|
5851
|
-
executionId?: string;
|
|
5851
|
+
executionId?: string | undefined;
|
|
5852
5852
|
}
|
|
5853
5853
|
/**
|
|
5854
5854
|
* @public
|
|
@@ -5869,12 +5869,12 @@ export interface StopFlowResponse {
|
|
|
5869
5869
|
* <p> The flow's Amazon Resource Name (ARN). </p>
|
|
5870
5870
|
* @public
|
|
5871
5871
|
*/
|
|
5872
|
-
flowArn?: string;
|
|
5872
|
+
flowArn?: string | undefined;
|
|
5873
5873
|
/**
|
|
5874
5874
|
* <p> Indicates the current status of the flow. </p>
|
|
5875
5875
|
* @public
|
|
5876
5876
|
*/
|
|
5877
|
-
flowStatus?: FlowStatus;
|
|
5877
|
+
flowStatus?: FlowStatus | undefined;
|
|
5878
5878
|
}
|
|
5879
5879
|
/**
|
|
5880
5880
|
* <p> The requested operation is not supported for the current flow. </p>
|
|
@@ -5923,7 +5923,7 @@ export interface UnregisterConnectorRequest {
|
|
|
5923
5923
|
* currently in use in one or more connector profiles. The default value is false.</p>
|
|
5924
5924
|
* @public
|
|
5925
5925
|
*/
|
|
5926
|
-
forceDelete?: boolean;
|
|
5926
|
+
forceDelete?: boolean | undefined;
|
|
5927
5927
|
}
|
|
5928
5928
|
/**
|
|
5929
5929
|
* @public
|
|
@@ -5983,7 +5983,7 @@ export interface UpdateConnectorProfileRequest {
|
|
|
5983
5983
|
* call to <code>UpdateConnectorProfile</code>. The token is active for 8 hours.</p>
|
|
5984
5984
|
* @public
|
|
5985
5985
|
*/
|
|
5986
|
-
clientToken?: string;
|
|
5986
|
+
clientToken?: string | undefined;
|
|
5987
5987
|
}
|
|
5988
5988
|
/**
|
|
5989
5989
|
* @public
|
|
@@ -5993,7 +5993,7 @@ export interface UpdateConnectorProfileResponse {
|
|
|
5993
5993
|
* <p> The Amazon Resource Name (ARN) of the connector profile. </p>
|
|
5994
5994
|
* @public
|
|
5995
5995
|
*/
|
|
5996
|
-
connectorProfileArn?: string;
|
|
5996
|
+
connectorProfileArn?: string | undefined;
|
|
5997
5997
|
}
|
|
5998
5998
|
/**
|
|
5999
5999
|
* @public
|
|
@@ -6009,12 +6009,12 @@ export interface UpdateConnectorRegistrationRequest {
|
|
|
6009
6009
|
* <p>A description about the update that you're applying to the connector.</p>
|
|
6010
6010
|
* @public
|
|
6011
6011
|
*/
|
|
6012
|
-
description?: string;
|
|
6012
|
+
description?: string | undefined;
|
|
6013
6013
|
/**
|
|
6014
6014
|
* <p>Contains information about the configuration of the connector being registered.</p>
|
|
6015
6015
|
* @public
|
|
6016
6016
|
*/
|
|
6017
|
-
connectorProvisioningConfig?: ConnectorProvisioningConfig;
|
|
6017
|
+
connectorProvisioningConfig?: ConnectorProvisioningConfig | undefined;
|
|
6018
6018
|
/**
|
|
6019
6019
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
6020
6020
|
* <code>UpdateConnectorRegistration</code> request completes only once. You choose the value
|
|
@@ -6028,7 +6028,7 @@ export interface UpdateConnectorRegistrationRequest {
|
|
|
6028
6028
|
* call to <code>UpdateConnectorRegistration</code>. The token is active for 8 hours.</p>
|
|
6029
6029
|
* @public
|
|
6030
6030
|
*/
|
|
6031
|
-
clientToken?: string;
|
|
6031
|
+
clientToken?: string | undefined;
|
|
6032
6032
|
}
|
|
6033
6033
|
/**
|
|
6034
6034
|
* @public
|
|
@@ -6038,7 +6038,7 @@ export interface UpdateConnectorRegistrationResponse {
|
|
|
6038
6038
|
* <p>The ARN of the connector being updated.</p>
|
|
6039
6039
|
* @public
|
|
6040
6040
|
*/
|
|
6041
|
-
connectorArn?: string;
|
|
6041
|
+
connectorArn?: string | undefined;
|
|
6042
6042
|
}
|
|
6043
6043
|
/**
|
|
6044
6044
|
* @public
|
|
@@ -6054,7 +6054,7 @@ export interface UpdateFlowRequest {
|
|
|
6054
6054
|
* <p> A description of the flow. </p>
|
|
6055
6055
|
* @public
|
|
6056
6056
|
*/
|
|
6057
|
-
description?: string;
|
|
6057
|
+
description?: string | undefined;
|
|
6058
6058
|
/**
|
|
6059
6059
|
* <p> The trigger settings that determine how and when the flow runs. </p>
|
|
6060
6060
|
* @public
|
|
@@ -6084,7 +6084,7 @@ export interface UpdateFlowRequest {
|
|
|
6084
6084
|
* stores metadata in a data catalog.</p>
|
|
6085
6085
|
* @public
|
|
6086
6086
|
*/
|
|
6087
|
-
metadataCatalogConfig?: MetadataCatalogConfig;
|
|
6087
|
+
metadataCatalogConfig?: MetadataCatalogConfig | undefined;
|
|
6088
6088
|
/**
|
|
6089
6089
|
* <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your
|
|
6090
6090
|
* <code>UpdateFlow</code> request completes only once. You choose the value to pass. For
|
|
@@ -6098,7 +6098,7 @@ export interface UpdateFlowRequest {
|
|
|
6098
6098
|
* call to <code>UpdateFlow</code>. The token is active for 8 hours.</p>
|
|
6099
6099
|
* @public
|
|
6100
6100
|
*/
|
|
6101
|
-
clientToken?: string;
|
|
6101
|
+
clientToken?: string | undefined;
|
|
6102
6102
|
}
|
|
6103
6103
|
/**
|
|
6104
6104
|
* @public
|
|
@@ -6108,7 +6108,7 @@ export interface UpdateFlowResponse {
|
|
|
6108
6108
|
* <p>Indicates the current status of the flow. </p>
|
|
6109
6109
|
* @public
|
|
6110
6110
|
*/
|
|
6111
|
-
flowStatus?: FlowStatus;
|
|
6111
|
+
flowStatus?: FlowStatus | undefined;
|
|
6112
6112
|
}
|
|
6113
6113
|
/**
|
|
6114
6114
|
* @internal
|