@aws-sdk/client-appflow 3.300.0 → 3.301.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/commands/CreateConnectorProfileCommand.d.ts +53 -65
- package/dist-types/commands/CreateFlowCommand.d.ts +61 -77
- package/dist-types/commands/DeleteConnectorProfileCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFlowCommand.d.ts +1 -1
- package/dist-types/commands/DescribeConnectorCommand.d.ts +1 -1
- package/dist-types/commands/DescribeConnectorEntityCommand.d.ts +1 -1
- package/dist-types/commands/DescribeConnectorProfilesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeConnectorsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeFlowCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFlowExecutionRecordsCommand.d.ts +1 -1
- package/dist-types/commands/ListConnectorEntitiesCommand.d.ts +1 -1
- package/dist-types/commands/ListConnectorsCommand.d.ts +1 -1
- package/dist-types/commands/ListFlowsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/RegisterConnectorCommand.d.ts +3 -3
- package/dist-types/commands/StartFlowCommand.d.ts +1 -1
- package/dist-types/commands/StopFlowCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UnregisterConnectorCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -2
- package/dist-types/commands/UpdateConnectorProfileCommand.d.ts +53 -65
- package/dist-types/commands/UpdateConnectorRegistrationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateFlowCommand.d.ts +60 -76
- package/package.json +3 -3
|
@@ -30,30 +30,30 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
30
30
|
* import { AppflowClient, CreateConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
31
31
|
* // const { AppflowClient, CreateConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
32
32
|
* const client = new AppflowClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // CreateConnectorProfileRequest
|
|
34
34
|
* connectorProfileName: "STRING_VALUE", // required
|
|
35
35
|
* kmsArn: "STRING_VALUE",
|
|
36
36
|
* connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot", // required
|
|
37
37
|
* connectorLabel: "STRING_VALUE",
|
|
38
38
|
* connectionMode: "Public" || "Private", // required
|
|
39
|
-
* connectorProfileConfig: {
|
|
40
|
-
* connectorProfileProperties: {
|
|
39
|
+
* connectorProfileConfig: { // ConnectorProfileConfig
|
|
40
|
+
* connectorProfileProperties: { // ConnectorProfileProperties
|
|
41
41
|
* Amplitude: {},
|
|
42
|
-
* Datadog: {
|
|
42
|
+
* Datadog: { // DatadogConnectorProfileProperties
|
|
43
43
|
* instanceUrl: "STRING_VALUE", // required
|
|
44
44
|
* },
|
|
45
|
-
* Dynatrace: {
|
|
45
|
+
* Dynatrace: { // DynatraceConnectorProfileProperties
|
|
46
46
|
* instanceUrl: "STRING_VALUE", // required
|
|
47
47
|
* },
|
|
48
48
|
* GoogleAnalytics: {},
|
|
49
49
|
* Honeycode: {},
|
|
50
|
-
* InforNexus: {
|
|
50
|
+
* InforNexus: { // InforNexusConnectorProfileProperties
|
|
51
51
|
* instanceUrl: "STRING_VALUE", // required
|
|
52
52
|
* },
|
|
53
|
-
* Marketo: {
|
|
53
|
+
* Marketo: { // MarketoConnectorProfileProperties
|
|
54
54
|
* instanceUrl: "STRING_VALUE", // required
|
|
55
55
|
* },
|
|
56
|
-
* Redshift: {
|
|
56
|
+
* Redshift: { // RedshiftConnectorProfileProperties
|
|
57
57
|
* databaseUrl: "STRING_VALUE",
|
|
58
58
|
* bucketName: "STRING_VALUE", // required
|
|
59
59
|
* bucketPrefix: "STRING_VALUE",
|
|
@@ -64,19 +64,19 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
64
64
|
* workgroupName: "STRING_VALUE",
|
|
65
65
|
* databaseName: "STRING_VALUE",
|
|
66
66
|
* },
|
|
67
|
-
* Salesforce: {
|
|
67
|
+
* Salesforce: { // SalesforceConnectorProfileProperties
|
|
68
68
|
* instanceUrl: "STRING_VALUE",
|
|
69
69
|
* isSandboxEnvironment: true || false,
|
|
70
70
|
* usePrivateLinkForMetadataAndAuthorization: true || false,
|
|
71
71
|
* },
|
|
72
|
-
* ServiceNow: {
|
|
72
|
+
* ServiceNow: { // ServiceNowConnectorProfileProperties
|
|
73
73
|
* instanceUrl: "STRING_VALUE", // required
|
|
74
74
|
* },
|
|
75
75
|
* Singular: {},
|
|
76
|
-
* Slack: {
|
|
76
|
+
* Slack: { // SlackConnectorProfileProperties
|
|
77
77
|
* instanceUrl: "STRING_VALUE", // required
|
|
78
78
|
* },
|
|
79
|
-
* Snowflake: {
|
|
79
|
+
* Snowflake: { // SnowflakeConnectorProfileProperties
|
|
80
80
|
* warehouse: "STRING_VALUE", // required
|
|
81
81
|
* stage: "STRING_VALUE", // required
|
|
82
82
|
* bucketName: "STRING_VALUE", // required
|
|
@@ -86,68 +86,68 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
86
86
|
* region: "STRING_VALUE",
|
|
87
87
|
* },
|
|
88
88
|
* Trendmicro: {},
|
|
89
|
-
* Veeva: {
|
|
89
|
+
* Veeva: { // VeevaConnectorProfileProperties
|
|
90
90
|
* instanceUrl: "STRING_VALUE", // required
|
|
91
91
|
* },
|
|
92
|
-
* Zendesk: {
|
|
92
|
+
* Zendesk: { // ZendeskConnectorProfileProperties
|
|
93
93
|
* instanceUrl: "STRING_VALUE", // required
|
|
94
94
|
* },
|
|
95
|
-
* SAPOData: {
|
|
95
|
+
* SAPOData: { // SAPODataConnectorProfileProperties
|
|
96
96
|
* applicationHostUrl: "STRING_VALUE", // required
|
|
97
97
|
* applicationServicePath: "STRING_VALUE", // required
|
|
98
98
|
* portNumber: Number("int"), // required
|
|
99
99
|
* clientNumber: "STRING_VALUE", // required
|
|
100
100
|
* logonLanguage: "STRING_VALUE",
|
|
101
101
|
* privateLinkServiceName: "STRING_VALUE",
|
|
102
|
-
* oAuthProperties: {
|
|
102
|
+
* oAuthProperties: { // OAuthProperties
|
|
103
103
|
* tokenUrl: "STRING_VALUE", // required
|
|
104
104
|
* authCodeUrl: "STRING_VALUE", // required
|
|
105
|
-
* oAuthScopes: [ // required
|
|
105
|
+
* oAuthScopes: [ // OAuthScopeList // required
|
|
106
106
|
* "STRING_VALUE",
|
|
107
107
|
* ],
|
|
108
108
|
* },
|
|
109
109
|
* },
|
|
110
|
-
* CustomConnector: {
|
|
111
|
-
* profileProperties: {
|
|
110
|
+
* CustomConnector: { // CustomConnectorProfileProperties
|
|
111
|
+
* profileProperties: { // ProfilePropertiesMap
|
|
112
112
|
* "<keys>": "STRING_VALUE",
|
|
113
113
|
* },
|
|
114
|
-
* oAuth2Properties: {
|
|
114
|
+
* oAuth2Properties: { // OAuth2Properties
|
|
115
115
|
* tokenUrl: "STRING_VALUE", // required
|
|
116
116
|
* oAuth2GrantType: "CLIENT_CREDENTIALS" || "AUTHORIZATION_CODE", // required
|
|
117
|
-
* tokenUrlCustomProperties: {
|
|
117
|
+
* tokenUrlCustomProperties: { // TokenUrlCustomProperties
|
|
118
118
|
* "<keys>": "STRING_VALUE",
|
|
119
119
|
* },
|
|
120
120
|
* },
|
|
121
121
|
* },
|
|
122
|
-
* Pardot: {
|
|
122
|
+
* Pardot: { // PardotConnectorProfileProperties
|
|
123
123
|
* instanceUrl: "STRING_VALUE",
|
|
124
124
|
* isSandboxEnvironment: true || false,
|
|
125
125
|
* businessUnitId: "STRING_VALUE",
|
|
126
126
|
* },
|
|
127
127
|
* },
|
|
128
|
-
* connectorProfileCredentials: {
|
|
129
|
-
* Amplitude: {
|
|
128
|
+
* connectorProfileCredentials: { // ConnectorProfileCredentials
|
|
129
|
+
* Amplitude: { // AmplitudeConnectorProfileCredentials
|
|
130
130
|
* apiKey: "STRING_VALUE", // required
|
|
131
131
|
* secretKey: "STRING_VALUE", // required
|
|
132
132
|
* },
|
|
133
|
-
* Datadog: {
|
|
133
|
+
* Datadog: { // DatadogConnectorProfileCredentials
|
|
134
134
|
* apiKey: "STRING_VALUE", // required
|
|
135
135
|
* applicationKey: "STRING_VALUE", // required
|
|
136
136
|
* },
|
|
137
|
-
* Dynatrace: {
|
|
137
|
+
* Dynatrace: { // DynatraceConnectorProfileCredentials
|
|
138
138
|
* apiToken: "STRING_VALUE", // required
|
|
139
139
|
* },
|
|
140
|
-
* GoogleAnalytics: {
|
|
140
|
+
* GoogleAnalytics: { // GoogleAnalyticsConnectorProfileCredentials
|
|
141
141
|
* clientId: "STRING_VALUE", // required
|
|
142
142
|
* clientSecret: "STRING_VALUE", // required
|
|
143
143
|
* accessToken: "STRING_VALUE",
|
|
144
144
|
* refreshToken: "STRING_VALUE",
|
|
145
|
-
* oAuthRequest: {
|
|
145
|
+
* oAuthRequest: { // ConnectorOAuthRequest
|
|
146
146
|
* authCode: "STRING_VALUE",
|
|
147
147
|
* redirectUri: "STRING_VALUE",
|
|
148
148
|
* },
|
|
149
149
|
* },
|
|
150
|
-
* Honeycode: {
|
|
150
|
+
* Honeycode: { // HoneycodeConnectorProfileCredentials
|
|
151
151
|
* accessToken: "STRING_VALUE",
|
|
152
152
|
* refreshToken: "STRING_VALUE",
|
|
153
153
|
* oAuthRequest: {
|
|
@@ -155,13 +155,13 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
155
155
|
* redirectUri: "STRING_VALUE",
|
|
156
156
|
* },
|
|
157
157
|
* },
|
|
158
|
-
* InforNexus: {
|
|
158
|
+
* InforNexus: { // InforNexusConnectorProfileCredentials
|
|
159
159
|
* accessKeyId: "STRING_VALUE", // required
|
|
160
160
|
* userId: "STRING_VALUE", // required
|
|
161
161
|
* secretAccessKey: "STRING_VALUE", // required
|
|
162
162
|
* datakey: "STRING_VALUE", // required
|
|
163
163
|
* },
|
|
164
|
-
* Marketo: {
|
|
164
|
+
* Marketo: { // MarketoConnectorProfileCredentials
|
|
165
165
|
* clientId: "STRING_VALUE", // required
|
|
166
166
|
* clientSecret: "STRING_VALUE", // required
|
|
167
167
|
* accessToken: "STRING_VALUE",
|
|
@@ -170,11 +170,11 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
170
170
|
* redirectUri: "STRING_VALUE",
|
|
171
171
|
* },
|
|
172
172
|
* },
|
|
173
|
-
* Redshift: {
|
|
173
|
+
* Redshift: { // RedshiftConnectorProfileCredentials
|
|
174
174
|
* username: "STRING_VALUE",
|
|
175
175
|
* password: "STRING_VALUE",
|
|
176
176
|
* },
|
|
177
|
-
* Salesforce: {
|
|
177
|
+
* Salesforce: { // SalesforceConnectorProfileCredentials
|
|
178
178
|
* accessToken: "STRING_VALUE",
|
|
179
179
|
* refreshToken: "STRING_VALUE",
|
|
180
180
|
* oAuthRequest: {
|
|
@@ -183,14 +183,14 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
183
183
|
* },
|
|
184
184
|
* clientCredentialsArn: "STRING_VALUE",
|
|
185
185
|
* },
|
|
186
|
-
* ServiceNow: {
|
|
186
|
+
* ServiceNow: { // ServiceNowConnectorProfileCredentials
|
|
187
187
|
* username: "STRING_VALUE", // required
|
|
188
188
|
* password: "STRING_VALUE", // required
|
|
189
189
|
* },
|
|
190
|
-
* Singular: {
|
|
190
|
+
* Singular: { // SingularConnectorProfileCredentials
|
|
191
191
|
* apiKey: "STRING_VALUE", // required
|
|
192
192
|
* },
|
|
193
|
-
* Slack: {
|
|
193
|
+
* Slack: { // SlackConnectorProfileCredentials
|
|
194
194
|
* clientId: "STRING_VALUE", // required
|
|
195
195
|
* clientSecret: "STRING_VALUE", // required
|
|
196
196
|
* accessToken: "STRING_VALUE",
|
|
@@ -199,76 +199,64 @@ export interface CreateConnectorProfileCommandOutput extends CreateConnectorProf
|
|
|
199
199
|
* redirectUri: "STRING_VALUE",
|
|
200
200
|
* },
|
|
201
201
|
* },
|
|
202
|
-
* Snowflake: {
|
|
202
|
+
* Snowflake: { // SnowflakeConnectorProfileCredentials
|
|
203
203
|
* username: "STRING_VALUE", // required
|
|
204
204
|
* password: "STRING_VALUE", // required
|
|
205
205
|
* },
|
|
206
|
-
* Trendmicro: {
|
|
206
|
+
* Trendmicro: { // TrendmicroConnectorProfileCredentials
|
|
207
207
|
* apiSecretKey: "STRING_VALUE", // required
|
|
208
208
|
* },
|
|
209
|
-
* Veeva: {
|
|
209
|
+
* Veeva: { // VeevaConnectorProfileCredentials
|
|
210
210
|
* username: "STRING_VALUE", // required
|
|
211
211
|
* password: "STRING_VALUE", // required
|
|
212
212
|
* },
|
|
213
|
-
* Zendesk: {
|
|
213
|
+
* Zendesk: { // ZendeskConnectorProfileCredentials
|
|
214
214
|
* clientId: "STRING_VALUE", // required
|
|
215
215
|
* clientSecret: "STRING_VALUE", // required
|
|
216
216
|
* accessToken: "STRING_VALUE",
|
|
217
|
-
* oAuthRequest:
|
|
218
|
-
* authCode: "STRING_VALUE",
|
|
219
|
-
* redirectUri: "STRING_VALUE",
|
|
220
|
-
* },
|
|
217
|
+
* oAuthRequest: "<ConnectorOAuthRequest>",
|
|
221
218
|
* },
|
|
222
|
-
* SAPOData: {
|
|
223
|
-
* basicAuthCredentials: {
|
|
219
|
+
* SAPOData: { // SAPODataConnectorProfileCredentials
|
|
220
|
+
* basicAuthCredentials: { // BasicAuthCredentials
|
|
224
221
|
* username: "STRING_VALUE", // required
|
|
225
222
|
* password: "STRING_VALUE", // required
|
|
226
223
|
* },
|
|
227
|
-
* oAuthCredentials: {
|
|
224
|
+
* oAuthCredentials: { // OAuthCredentials
|
|
228
225
|
* clientId: "STRING_VALUE", // required
|
|
229
226
|
* clientSecret: "STRING_VALUE", // required
|
|
230
227
|
* accessToken: "STRING_VALUE",
|
|
231
228
|
* refreshToken: "STRING_VALUE",
|
|
232
|
-
* oAuthRequest:
|
|
233
|
-
* authCode: "STRING_VALUE",
|
|
234
|
-
* redirectUri: "STRING_VALUE",
|
|
235
|
-
* },
|
|
229
|
+
* oAuthRequest: "<ConnectorOAuthRequest>",
|
|
236
230
|
* },
|
|
237
231
|
* },
|
|
238
|
-
* CustomConnector: {
|
|
232
|
+
* CustomConnector: { // CustomConnectorProfileCredentials
|
|
239
233
|
* authenticationType: "OAUTH2" || "APIKEY" || "BASIC" || "CUSTOM", // required
|
|
240
234
|
* basic: {
|
|
241
235
|
* username: "STRING_VALUE", // required
|
|
242
236
|
* password: "STRING_VALUE", // required
|
|
243
237
|
* },
|
|
244
|
-
* oauth2: {
|
|
238
|
+
* oauth2: { // OAuth2Credentials
|
|
245
239
|
* clientId: "STRING_VALUE",
|
|
246
240
|
* clientSecret: "STRING_VALUE",
|
|
247
241
|
* accessToken: "STRING_VALUE",
|
|
248
242
|
* refreshToken: "STRING_VALUE",
|
|
249
|
-
* oAuthRequest:
|
|
250
|
-
* authCode: "STRING_VALUE",
|
|
251
|
-
* redirectUri: "STRING_VALUE",
|
|
252
|
-
* },
|
|
243
|
+
* oAuthRequest: "<ConnectorOAuthRequest>",
|
|
253
244
|
* },
|
|
254
|
-
* apiKey: {
|
|
245
|
+
* apiKey: { // ApiKeyCredentials
|
|
255
246
|
* apiKey: "STRING_VALUE", // required
|
|
256
247
|
* apiSecretKey: "STRING_VALUE",
|
|
257
248
|
* },
|
|
258
|
-
* custom: {
|
|
249
|
+
* custom: { // CustomAuthCredentials
|
|
259
250
|
* customAuthenticationType: "STRING_VALUE", // required
|
|
260
|
-
* credentialsMap: {
|
|
251
|
+
* credentialsMap: { // CredentialsMap
|
|
261
252
|
* "<keys>": "STRING_VALUE",
|
|
262
253
|
* },
|
|
263
254
|
* },
|
|
264
255
|
* },
|
|
265
|
-
* Pardot: {
|
|
256
|
+
* Pardot: { // PardotConnectorProfileCredentials
|
|
266
257
|
* accessToken: "STRING_VALUE",
|
|
267
258
|
* refreshToken: "STRING_VALUE",
|
|
268
|
-
* oAuthRequest:
|
|
269
|
-
* authCode: "STRING_VALUE",
|
|
270
|
-
* redirectUri: "STRING_VALUE",
|
|
271
|
-
* },
|
|
259
|
+
* oAuthRequest: "<ConnectorOAuthRequest>",
|
|
272
260
|
* clientCredentialsArn: "STRING_VALUE",
|
|
273
261
|
* },
|
|
274
262
|
* },
|
|
@@ -30,14 +30,14 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
30
30
|
* import { AppflowClient, CreateFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
31
31
|
* // const { AppflowClient, CreateFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
32
32
|
* const client = new AppflowClient(config);
|
|
33
|
-
* const input = {
|
|
33
|
+
* const input = { // CreateFlowRequest
|
|
34
34
|
* flowName: "STRING_VALUE", // required
|
|
35
35
|
* description: "STRING_VALUE",
|
|
36
36
|
* kmsArn: "STRING_VALUE",
|
|
37
|
-
* triggerConfig: {
|
|
37
|
+
* triggerConfig: { // TriggerConfig
|
|
38
38
|
* triggerType: "Scheduled" || "Event" || "OnDemand", // required
|
|
39
|
-
* triggerProperties: {
|
|
40
|
-
* Scheduled: {
|
|
39
|
+
* triggerProperties: { // TriggerProperties
|
|
40
|
+
* Scheduled: { // ScheduledTriggerProperties
|
|
41
41
|
* scheduleExpression: "STRING_VALUE", // required
|
|
42
42
|
* dataPullMode: "Incremental" || "Complete",
|
|
43
43
|
* scheduleStartTime: new Date("TIMESTAMP"),
|
|
@@ -49,119 +49,119 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
49
49
|
* },
|
|
50
50
|
* },
|
|
51
51
|
* },
|
|
52
|
-
* sourceFlowConfig: {
|
|
52
|
+
* sourceFlowConfig: { // SourceFlowConfig
|
|
53
53
|
* connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot", // required
|
|
54
54
|
* apiVersion: "STRING_VALUE",
|
|
55
55
|
* connectorProfileName: "STRING_VALUE",
|
|
56
|
-
* sourceConnectorProperties: {
|
|
57
|
-
* Amplitude: {
|
|
56
|
+
* sourceConnectorProperties: { // SourceConnectorProperties
|
|
57
|
+
* Amplitude: { // AmplitudeSourceProperties
|
|
58
58
|
* object: "STRING_VALUE", // required
|
|
59
59
|
* },
|
|
60
|
-
* Datadog: {
|
|
60
|
+
* Datadog: { // DatadogSourceProperties
|
|
61
61
|
* object: "STRING_VALUE", // required
|
|
62
62
|
* },
|
|
63
|
-
* Dynatrace: {
|
|
63
|
+
* Dynatrace: { // DynatraceSourceProperties
|
|
64
64
|
* object: "STRING_VALUE", // required
|
|
65
65
|
* },
|
|
66
|
-
* GoogleAnalytics: {
|
|
66
|
+
* GoogleAnalytics: { // GoogleAnalyticsSourceProperties
|
|
67
67
|
* object: "STRING_VALUE", // required
|
|
68
68
|
* },
|
|
69
|
-
* InforNexus: {
|
|
69
|
+
* InforNexus: { // InforNexusSourceProperties
|
|
70
70
|
* object: "STRING_VALUE", // required
|
|
71
71
|
* },
|
|
72
|
-
* Marketo: {
|
|
72
|
+
* Marketo: { // MarketoSourceProperties
|
|
73
73
|
* object: "STRING_VALUE", // required
|
|
74
74
|
* },
|
|
75
|
-
* S3: {
|
|
75
|
+
* S3: { // S3SourceProperties
|
|
76
76
|
* bucketName: "STRING_VALUE", // required
|
|
77
77
|
* bucketPrefix: "STRING_VALUE",
|
|
78
|
-
* s3InputFormatConfig: {
|
|
78
|
+
* s3InputFormatConfig: { // S3InputFormatConfig
|
|
79
79
|
* s3InputFileType: "CSV" || "JSON",
|
|
80
80
|
* },
|
|
81
81
|
* },
|
|
82
|
-
* Salesforce: {
|
|
82
|
+
* Salesforce: { // SalesforceSourceProperties
|
|
83
83
|
* object: "STRING_VALUE", // required
|
|
84
84
|
* enableDynamicFieldUpdate: true || false,
|
|
85
85
|
* includeDeletedRecords: true || false,
|
|
86
86
|
* dataTransferApi: "AUTOMATIC" || "BULKV2" || "REST_SYNC",
|
|
87
87
|
* },
|
|
88
|
-
* ServiceNow: {
|
|
88
|
+
* ServiceNow: { // ServiceNowSourceProperties
|
|
89
89
|
* object: "STRING_VALUE", // required
|
|
90
90
|
* },
|
|
91
|
-
* Singular: {
|
|
91
|
+
* Singular: { // SingularSourceProperties
|
|
92
92
|
* object: "STRING_VALUE", // required
|
|
93
93
|
* },
|
|
94
|
-
* Slack: {
|
|
94
|
+
* Slack: { // SlackSourceProperties
|
|
95
95
|
* object: "STRING_VALUE", // required
|
|
96
96
|
* },
|
|
97
|
-
* Trendmicro: {
|
|
97
|
+
* Trendmicro: { // TrendmicroSourceProperties
|
|
98
98
|
* object: "STRING_VALUE", // required
|
|
99
99
|
* },
|
|
100
|
-
* Veeva: {
|
|
100
|
+
* Veeva: { // VeevaSourceProperties
|
|
101
101
|
* object: "STRING_VALUE", // required
|
|
102
102
|
* documentType: "STRING_VALUE",
|
|
103
103
|
* includeSourceFiles: true || false,
|
|
104
104
|
* includeRenditions: true || false,
|
|
105
105
|
* includeAllVersions: true || false,
|
|
106
106
|
* },
|
|
107
|
-
* Zendesk: {
|
|
107
|
+
* Zendesk: { // ZendeskSourceProperties
|
|
108
108
|
* object: "STRING_VALUE", // required
|
|
109
109
|
* },
|
|
110
|
-
* SAPOData: {
|
|
110
|
+
* SAPOData: { // SAPODataSourceProperties
|
|
111
111
|
* objectPath: "STRING_VALUE",
|
|
112
112
|
* },
|
|
113
|
-
* CustomConnector: {
|
|
113
|
+
* CustomConnector: { // CustomConnectorSourceProperties
|
|
114
114
|
* entityName: "STRING_VALUE", // required
|
|
115
|
-
* customProperties: {
|
|
115
|
+
* customProperties: { // CustomProperties
|
|
116
116
|
* "<keys>": "STRING_VALUE",
|
|
117
117
|
* },
|
|
118
118
|
* },
|
|
119
|
-
* Pardot: {
|
|
119
|
+
* Pardot: { // PardotSourceProperties
|
|
120
120
|
* object: "STRING_VALUE", // required
|
|
121
121
|
* },
|
|
122
122
|
* },
|
|
123
|
-
* incrementalPullConfig: {
|
|
123
|
+
* incrementalPullConfig: { // IncrementalPullConfig
|
|
124
124
|
* datetimeTypeFieldName: "STRING_VALUE",
|
|
125
125
|
* },
|
|
126
126
|
* },
|
|
127
|
-
* destinationFlowConfigList: [ // required
|
|
128
|
-
* {
|
|
127
|
+
* destinationFlowConfigList: [ // DestinationFlowConfigList // required
|
|
128
|
+
* { // DestinationFlowConfig
|
|
129
129
|
* connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot", // required
|
|
130
130
|
* apiVersion: "STRING_VALUE",
|
|
131
131
|
* connectorProfileName: "STRING_VALUE",
|
|
132
|
-
* destinationConnectorProperties: {
|
|
133
|
-
* Redshift: {
|
|
132
|
+
* destinationConnectorProperties: { // DestinationConnectorProperties
|
|
133
|
+
* Redshift: { // RedshiftDestinationProperties
|
|
134
134
|
* object: "STRING_VALUE", // required
|
|
135
135
|
* intermediateBucketName: "STRING_VALUE", // required
|
|
136
136
|
* bucketPrefix: "STRING_VALUE",
|
|
137
|
-
* errorHandlingConfig: {
|
|
137
|
+
* errorHandlingConfig: { // ErrorHandlingConfig
|
|
138
138
|
* failOnFirstDestinationError: true || false,
|
|
139
139
|
* bucketPrefix: "STRING_VALUE",
|
|
140
140
|
* bucketName: "STRING_VALUE",
|
|
141
141
|
* },
|
|
142
142
|
* },
|
|
143
|
-
* S3: {
|
|
143
|
+
* S3: { // S3DestinationProperties
|
|
144
144
|
* bucketName: "STRING_VALUE", // required
|
|
145
145
|
* bucketPrefix: "STRING_VALUE",
|
|
146
|
-
* s3OutputFormatConfig: {
|
|
146
|
+
* s3OutputFormatConfig: { // S3OutputFormatConfig
|
|
147
147
|
* fileType: "CSV" || "JSON" || "PARQUET",
|
|
148
|
-
* prefixConfig: {
|
|
148
|
+
* prefixConfig: { // PrefixConfig
|
|
149
149
|
* prefixType: "FILENAME" || "PATH" || "PATH_AND_FILENAME",
|
|
150
150
|
* prefixFormat: "YEAR" || "MONTH" || "DAY" || "HOUR" || "MINUTE",
|
|
151
|
-
* pathPrefixHierarchy: [
|
|
151
|
+
* pathPrefixHierarchy: [ // PathPrefixHierarchy
|
|
152
152
|
* "EXECUTION_ID" || "SCHEMA_VERSION",
|
|
153
153
|
* ],
|
|
154
154
|
* },
|
|
155
|
-
* aggregationConfig: {
|
|
155
|
+
* aggregationConfig: { // AggregationConfig
|
|
156
156
|
* aggregationType: "None" || "SingleFile",
|
|
157
157
|
* targetFileSize: Number("long"),
|
|
158
158
|
* },
|
|
159
159
|
* preserveSourceDataTyping: true || false,
|
|
160
160
|
* },
|
|
161
161
|
* },
|
|
162
|
-
* Salesforce: {
|
|
162
|
+
* Salesforce: { // SalesforceDestinationProperties
|
|
163
163
|
* object: "STRING_VALUE", // required
|
|
164
|
-
* idFieldNames: [
|
|
164
|
+
* idFieldNames: [ // IdFieldNameList
|
|
165
165
|
* "STRING_VALUE",
|
|
166
166
|
* ],
|
|
167
167
|
* errorHandlingConfig: {
|
|
@@ -172,7 +172,7 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
172
172
|
* writeOperationType: "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
|
|
173
173
|
* dataTransferApi: "AUTOMATIC" || "BULKV2" || "REST_SYNC",
|
|
174
174
|
* },
|
|
175
|
-
* Snowflake: {
|
|
175
|
+
* Snowflake: { // SnowflakeDestinationProperties
|
|
176
176
|
* object: "STRING_VALUE", // required
|
|
177
177
|
* intermediateBucketName: "STRING_VALUE", // required
|
|
178
178
|
* bucketPrefix: "STRING_VALUE",
|
|
@@ -182,7 +182,7 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
182
182
|
* bucketName: "STRING_VALUE",
|
|
183
183
|
* },
|
|
184
184
|
* },
|
|
185
|
-
* EventBridge: {
|
|
185
|
+
* EventBridge: { // EventBridgeDestinationProperties
|
|
186
186
|
* object: "STRING_VALUE", // required
|
|
187
187
|
* errorHandlingConfig: {
|
|
188
188
|
* failOnFirstDestinationError: true || false,
|
|
@@ -191,10 +191,10 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
191
191
|
* },
|
|
192
192
|
* },
|
|
193
193
|
* LookoutMetrics: {},
|
|
194
|
-
* Upsolver: {
|
|
194
|
+
* Upsolver: { // UpsolverDestinationProperties
|
|
195
195
|
* bucketName: "STRING_VALUE", // required
|
|
196
196
|
* bucketPrefix: "STRING_VALUE",
|
|
197
|
-
* s3OutputFormatConfig: {
|
|
197
|
+
* s3OutputFormatConfig: { // UpsolverS3OutputFormatConfig
|
|
198
198
|
* fileType: "CSV" || "JSON" || "PARQUET",
|
|
199
199
|
* prefixConfig: {
|
|
200
200
|
* prefixType: "FILENAME" || "PATH" || "PATH_AND_FILENAME",
|
|
@@ -209,7 +209,7 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
209
209
|
* },
|
|
210
210
|
* },
|
|
211
211
|
* },
|
|
212
|
-
* Honeycode: {
|
|
212
|
+
* Honeycode: { // HoneycodeDestinationProperties
|
|
213
213
|
* object: "STRING_VALUE", // required
|
|
214
214
|
* errorHandlingConfig: {
|
|
215
215
|
* failOnFirstDestinationError: true || false,
|
|
@@ -217,37 +217,25 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
217
217
|
* bucketName: "STRING_VALUE",
|
|
218
218
|
* },
|
|
219
219
|
* },
|
|
220
|
-
* CustomerProfiles: {
|
|
220
|
+
* CustomerProfiles: { // CustomerProfilesDestinationProperties
|
|
221
221
|
* domainName: "STRING_VALUE", // required
|
|
222
222
|
* objectTypeName: "STRING_VALUE",
|
|
223
223
|
* },
|
|
224
|
-
* Zendesk: {
|
|
224
|
+
* Zendesk: { // ZendeskDestinationProperties
|
|
225
225
|
* object: "STRING_VALUE", // required
|
|
226
226
|
* idFieldNames: [
|
|
227
227
|
* "STRING_VALUE",
|
|
228
228
|
* ],
|
|
229
|
-
* errorHandlingConfig:
|
|
230
|
-
* failOnFirstDestinationError: true || false,
|
|
231
|
-
* bucketPrefix: "STRING_VALUE",
|
|
232
|
-
* bucketName: "STRING_VALUE",
|
|
233
|
-
* },
|
|
229
|
+
* errorHandlingConfig: "<ErrorHandlingConfig>",
|
|
234
230
|
* writeOperationType: "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
|
|
235
231
|
* },
|
|
236
|
-
* Marketo: {
|
|
232
|
+
* Marketo: { // MarketoDestinationProperties
|
|
237
233
|
* object: "STRING_VALUE", // required
|
|
238
|
-
* errorHandlingConfig:
|
|
239
|
-
* failOnFirstDestinationError: true || false,
|
|
240
|
-
* bucketPrefix: "STRING_VALUE",
|
|
241
|
-
* bucketName: "STRING_VALUE",
|
|
242
|
-
* },
|
|
234
|
+
* errorHandlingConfig: "<ErrorHandlingConfig>",
|
|
243
235
|
* },
|
|
244
|
-
* CustomConnector: {
|
|
236
|
+
* CustomConnector: { // CustomConnectorDestinationProperties
|
|
245
237
|
* entityName: "STRING_VALUE", // required
|
|
246
|
-
* errorHandlingConfig:
|
|
247
|
-
* failOnFirstDestinationError: true || false,
|
|
248
|
-
* bucketPrefix: "STRING_VALUE",
|
|
249
|
-
* bucketName: "STRING_VALUE",
|
|
250
|
-
* },
|
|
238
|
+
* errorHandlingConfig: "<ErrorHandlingConfig>",
|
|
251
239
|
* writeOperationType: "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
|
|
252
240
|
* idFieldNames: [
|
|
253
241
|
* "STRING_VALUE",
|
|
@@ -256,31 +244,27 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
256
244
|
* "<keys>": "STRING_VALUE",
|
|
257
245
|
* },
|
|
258
246
|
* },
|
|
259
|
-
* SAPOData: {
|
|
247
|
+
* SAPOData: { // SAPODataDestinationProperties
|
|
260
248
|
* objectPath: "STRING_VALUE", // required
|
|
261
|
-
* successResponseHandlingConfig: {
|
|
249
|
+
* successResponseHandlingConfig: { // SuccessResponseHandlingConfig
|
|
262
250
|
* bucketPrefix: "STRING_VALUE",
|
|
263
251
|
* bucketName: "STRING_VALUE",
|
|
264
252
|
* },
|
|
265
253
|
* idFieldNames: [
|
|
266
254
|
* "STRING_VALUE",
|
|
267
255
|
* ],
|
|
268
|
-
* errorHandlingConfig:
|
|
269
|
-
* failOnFirstDestinationError: true || false,
|
|
270
|
-
* bucketPrefix: "STRING_VALUE",
|
|
271
|
-
* bucketName: "STRING_VALUE",
|
|
272
|
-
* },
|
|
256
|
+
* errorHandlingConfig: "<ErrorHandlingConfig>",
|
|
273
257
|
* writeOperationType: "INSERT" || "UPSERT" || "UPDATE" || "DELETE",
|
|
274
258
|
* },
|
|
275
259
|
* },
|
|
276
260
|
* },
|
|
277
261
|
* ],
|
|
278
|
-
* tasks: [ // required
|
|
279
|
-
* {
|
|
280
|
-
* sourceFields: [ // required
|
|
262
|
+
* tasks: [ // Tasks // required
|
|
263
|
+
* { // Task
|
|
264
|
+
* sourceFields: [ // SourceFields // required
|
|
281
265
|
* "STRING_VALUE",
|
|
282
266
|
* ],
|
|
283
|
-
* connectorOperator: {
|
|
267
|
+
* connectorOperator: { // ConnectorOperator
|
|
284
268
|
* Amplitude: "BETWEEN",
|
|
285
269
|
* Datadog: "PROJECTION" || "BETWEEN" || "EQUAL_TO" || "ADDITION" || "MULTIPLICATION" || "DIVISION" || "SUBTRACTION" || "MASK_ALL" || "MASK_FIRST_N" || "MASK_LAST_N" || "VALIDATE_NON_NULL" || "VALIDATE_NON_ZERO" || "VALIDATE_NON_NEGATIVE" || "VALIDATE_NUMERIC" || "NO_OP",
|
|
286
270
|
* Dynatrace: "PROJECTION" || "BETWEEN" || "EQUAL_TO" || "ADDITION" || "MULTIPLICATION" || "DIVISION" || "SUBTRACTION" || "MASK_ALL" || "MASK_FIRST_N" || "MASK_LAST_N" || "VALIDATE_NON_NULL" || "VALIDATE_NON_ZERO" || "VALIDATE_NON_NEGATIVE" || "VALIDATE_NUMERIC" || "NO_OP",
|
|
@@ -301,16 +285,16 @@ export interface CreateFlowCommandOutput extends CreateFlowResponse, __MetadataB
|
|
|
301
285
|
* },
|
|
302
286
|
* destinationField: "STRING_VALUE",
|
|
303
287
|
* taskType: "Arithmetic" || "Filter" || "Map" || "Map_all" || "Mask" || "Merge" || "Passthrough" || "Truncate" || "Validate" || "Partition", // required
|
|
304
|
-
* taskProperties: {
|
|
288
|
+
* taskProperties: { // TaskPropertiesMap
|
|
305
289
|
* "<keys>": "STRING_VALUE",
|
|
306
290
|
* },
|
|
307
291
|
* },
|
|
308
292
|
* ],
|
|
309
|
-
* tags: {
|
|
293
|
+
* tags: { // TagMap
|
|
310
294
|
* "<keys>": "STRING_VALUE",
|
|
311
295
|
* },
|
|
312
|
-
* metadataCatalogConfig: {
|
|
313
|
-
* glueDataCatalog: {
|
|
296
|
+
* metadataCatalogConfig: { // MetadataCatalogConfig
|
|
297
|
+
* glueDataCatalog: { // GlueDataCatalogConfig
|
|
314
298
|
* roleArn: "STRING_VALUE", // required
|
|
315
299
|
* databaseName: "STRING_VALUE", // required
|
|
316
300
|
* tablePrefix: "STRING_VALUE", // required
|
|
@@ -26,7 +26,7 @@ export interface DeleteConnectorProfileCommandOutput extends DeleteConnectorProf
|
|
|
26
26
|
* import { AppflowClient, DeleteConnectorProfileCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
27
27
|
* // const { AppflowClient, DeleteConnectorProfileCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
28
28
|
* const client = new AppflowClient(config);
|
|
29
|
-
* const input = {
|
|
29
|
+
* const input = { // DeleteConnectorProfileRequest
|
|
30
30
|
* connectorProfileName: "STRING_VALUE", // required
|
|
31
31
|
* forceDelete: true || false,
|
|
32
32
|
* };
|
|
@@ -27,7 +27,7 @@ export interface DeleteFlowCommandOutput extends DeleteFlowResponse, __MetadataB
|
|
|
27
27
|
* import { AppflowClient, DeleteFlowCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
28
28
|
* // const { AppflowClient, DeleteFlowCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
29
29
|
* const client = new AppflowClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // DeleteFlowRequest
|
|
31
31
|
* flowName: "STRING_VALUE", // required
|
|
32
32
|
* forceDelete: true || false,
|
|
33
33
|
* };
|
|
@@ -28,7 +28,7 @@ export interface DescribeConnectorCommandOutput extends DescribeConnectorRespons
|
|
|
28
28
|
* import { AppflowClient, DescribeConnectorCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
29
29
|
* // const { AppflowClient, DescribeConnectorCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
30
30
|
* const client = new AppflowClient(config);
|
|
31
|
-
* const input = {
|
|
31
|
+
* const input = { // DescribeConnectorRequest
|
|
32
32
|
* connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot", // required
|
|
33
33
|
* connectorLabel: "STRING_VALUE",
|
|
34
34
|
* };
|
|
@@ -27,7 +27,7 @@ export interface DescribeConnectorEntityCommandOutput extends DescribeConnectorE
|
|
|
27
27
|
* import { AppflowClient, DescribeConnectorEntityCommand } from "@aws-sdk/client-appflow"; // ES Modules import
|
|
28
28
|
* // const { AppflowClient, DescribeConnectorEntityCommand } = require("@aws-sdk/client-appflow"); // CommonJS import
|
|
29
29
|
* const client = new AppflowClient(config);
|
|
30
|
-
* const input = {
|
|
30
|
+
* const input = { // DescribeConnectorEntityRequest
|
|
31
31
|
* connectorEntityName: "STRING_VALUE", // required
|
|
32
32
|
* connectorType: "Salesforce" || "Singular" || "Slack" || "Redshift" || "S3" || "Marketo" || "Googleanalytics" || "Zendesk" || "Servicenow" || "Datadog" || "Trendmicro" || "Snowflake" || "Dynatrace" || "Infornexus" || "Amplitude" || "Veeva" || "EventBridge" || "LookoutMetrics" || "Upsolver" || "Honeycode" || "CustomerProfiles" || "SAPOData" || "CustomConnector" || "Pardot",
|
|
33
33
|
* connectorProfileName: "STRING_VALUE",
|