0% found this document useful (0 votes)

3 views524 pages

Amazon Appflow API

The AmazonAppFlow API Reference provides detailed information on the API version 2020-08-23, including actions such as creating, deleting, and managing connector profiles and flows. It includes sections on request syntax, URI parameters, response elements, and error handling for various API actions. The document serves as a comprehensive guide for developers using Amazon AppFlow services.

Uploaded by

thach.le

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

3 views524 pages

Amazon Appflow API

Uploaded by

thach.le

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

API Reference

AmazonAppFlow

API Version 2020-08-23

AmazonAppFlow: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service
that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any
manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are
the property of their respective owners, who may or may not be aﬃliated with, connected to, or
sponsored by Amazon.
AmazonAppFlow API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Actions .............................................................................................................................................. 2
CancelFlowExecutions .................................................................................................................................. 3
Request Syntax ........................................................................................................................................ 3
URI Request Parameters ........................................................................................................................ 3
Request Body ........................................................................................................................................... 4
Response Syntax ...................................................................................................................................... 4
Response Elements ................................................................................................................................. 5
Errors .......................................................................................................................................................... 5
See Also ..................................................................................................................................................... 6
CreateConnectorProﬁle ............................................................................................................................... 7
Request Syntax ........................................................................................................................................ 7
URI Request Parameters ...................................................................................................................... 13
Request Body ......................................................................................................................................... 13
Response Syntax ................................................................................................................................... 15
Response Elements ............................................................................................................................... 16
Errors ....................................................................................................................................................... 16
Examples ................................................................................................................................................. 17
See Also .................................................................................................................................................. 22
CreateFlow ................................................................................................................................................... 24
Request Syntax ...................................................................................................................................... 24
URI Request Parameters ...................................................................................................................... 30
Request Body ......................................................................................................................................... 30
Response Syntax ................................................................................................................................... 33
Response Elements ............................................................................................................................... 34
Errors ....................................................................................................................................................... 34
Examples ................................................................................................................................................. 35
See Also .................................................................................................................................................. 44
DeleteConnectorProﬁle ............................................................................................................................. 45
Request Syntax ...................................................................................................................................... 45
URI Request Parameters ...................................................................................................................... 45
Request Body ......................................................................................................................................... 45
Response Syntax ................................................................................................................................... 46
Response Elements ............................................................................................................................... 46

API Version 2020-08-23 iii

AmazonAppFlow API Reference

Errors ....................................................................................................................................................... 46
Examples ................................................................................................................................................. 46
See Also .................................................................................................................................................. 47
DeleteFlow ................................................................................................................................................... 48
Request Syntax ...................................................................................................................................... 48
URI Request Parameters ...................................................................................................................... 48
Request Body ......................................................................................................................................... 48
Response Syntax ................................................................................................................................... 49
Response Elements ............................................................................................................................... 49
Errors ....................................................................................................................................................... 49
Examples ................................................................................................................................................. 49
See Also .................................................................................................................................................. 50
DescribeConnector ..................................................................................................................................... 52
Request Syntax ...................................................................................................................................... 52
URI Request Parameters ...................................................................................................................... 52
Request Body ......................................................................................................................................... 52
Response Syntax ................................................................................................................................... 53
Response Elements ............................................................................................................................... 56
Errors ....................................................................................................................................................... 56
Examples ................................................................................................................................................. 57
See Also .................................................................................................................................................. 60
DescribeConnectorEntity .......................................................................................................................... 61
Request Syntax ...................................................................................................................................... 61
URI Request Parameters ...................................................................................................................... 61
Request Body ......................................................................................................................................... 61
Response Syntax ................................................................................................................................... 62
Response Elements ............................................................................................................................... 63
Errors ....................................................................................................................................................... 64
Examples ................................................................................................................................................. 65
See Also ................................................................................................................................................ 106
DescribeConnectorProﬁles ..................................................................................................................... 107
Request Syntax .................................................................................................................................... 107
URI Request Parameters ................................................................................................................... 107
Request Body ....................................................................................................................................... 107
Response Syntax ................................................................................................................................. 109
Response Elements ............................................................................................................................ 111

API Version 2020-08-23 iv

AmazonAppFlow API Reference

Errors ..................................................................................................................................................... 112

Examples ............................................................................................................................................... 112
See Also ................................................................................................................................................ 115
DescribeConnectors ................................................................................................................................. 116
Request Syntax .................................................................................................................................... 116
URI Request Parameters ................................................................................................................... 116
Request Body ....................................................................................................................................... 116
Response Syntax ................................................................................................................................. 117
Response Elements ............................................................................................................................ 121
Errors ..................................................................................................................................................... 122
Examples ............................................................................................................................................... 122
See Also ................................................................................................................................................ 126
DescribeFlow ............................................................................................................................................. 128
Request Syntax .................................................................................................................................... 128
URI Request Parameters ................................................................................................................... 128
Request Body ....................................................................................................................................... 128
Response Syntax ................................................................................................................................. 128
Response Elements ............................................................................................................................ 136
Errors ..................................................................................................................................................... 139
Examples ............................................................................................................................................... 140
See Also ................................................................................................................................................ 142
DescribeFlowExecutionRecords ............................................................................................................. 144
Request Syntax .................................................................................................................................... 144
URI Request Parameters ................................................................................................................... 144
Request Body ....................................................................................................................................... 144
Response Syntax ................................................................................................................................. 145
Response Elements ............................................................................................................................ 146
Errors ..................................................................................................................................................... 146
Examples ............................................................................................................................................... 147
See Also ................................................................................................................................................ 150
ListConnectorEntities .............................................................................................................................. 152
Request Syntax .................................................................................................................................... 152
URI Request Parameters ................................................................................................................... 152
Request Body ....................................................................................................................................... 152
Response Syntax ................................................................................................................................. 154
Response Elements ............................................................................................................................ 154

API Version 2020-08-23 v

AmazonAppFlow API Reference

Errors ..................................................................................................................................................... 155

Examples ............................................................................................................................................... 156
See Also ................................................................................................................................................ 160
ListConnectors .......................................................................................................................................... 161
Request Syntax .................................................................................................................................... 161
URI Request Parameters ................................................................................................................... 161
Request Body ....................................................................................................................................... 161
Response Syntax ................................................................................................................................. 162
Response Elements ............................................................................................................................ 162
Errors ..................................................................................................................................................... 163
Examples ............................................................................................................................................... 163
See Also ................................................................................................................................................ 164
ListFlows .................................................................................................................................................... 166
Request Syntax .................................................................................................................................... 166
URI Request Parameters ................................................................................................................... 166
Request Body ....................................................................................................................................... 166
Response Syntax ................................................................................................................................. 167
Response Elements ............................................................................................................................ 167
Errors ..................................................................................................................................................... 168
Examples ............................................................................................................................................... 168
See Also ................................................................................................................................................ 169
ListTagsForResource ................................................................................................................................ 171
Request Syntax .................................................................................................................................... 171
URI Request Parameters ................................................................................................................... 171
Request Body ....................................................................................................................................... 171
Response Syntax ................................................................................................................................. 171
Response Elements ............................................................................................................................ 171
Errors ..................................................................................................................................................... 172
See Also ................................................................................................................................................ 173
RegisterConnector .................................................................................................................................... 174
Request Syntax .................................................................................................................................... 174
URI Request Parameters ................................................................................................................... 174
Request Body ....................................................................................................................................... 174
Response Syntax ................................................................................................................................. 176
Response Elements ............................................................................................................................ 176
Errors ..................................................................................................................................................... 176

API Version 2020-08-23 vi

AmazonAppFlow API Reference

Examples ............................................................................................................................................... 178

See Also ................................................................................................................................................ 178
ResetConnectorMetadataCache ............................................................................................................ 180
Request Syntax .................................................................................................................................... 180
URI Request Parameters ................................................................................................................... 180
Request Body ....................................................................................................................................... 180
Response Syntax ................................................................................................................................. 183
Response Elements ............................................................................................................................ 183
Errors ..................................................................................................................................................... 183
Examples ............................................................................................................................................... 183
See Also ................................................................................................................................................ 184
StartFlow ................................................................................................................................................... 186
Request Syntax .................................................................................................................................... 186
URI Request Parameters ................................................................................................................... 186
Request Body ....................................................................................................................................... 186
Response Syntax ................................................................................................................................. 187
Response Elements ............................................................................................................................ 187
Errors ..................................................................................................................................................... 188
Examples ............................................................................................................................................... 189
See Also ................................................................................................................................................ 189
StopFlow .................................................................................................................................................... 191
Request Syntax .................................................................................................................................... 191
URI Request Parameters ................................................................................................................... 191
Request Body ....................................................................................................................................... 191
Response Syntax ................................................................................................................................. 191
Response Elements ............................................................................................................................ 192
Errors ..................................................................................................................................................... 192
Examples ............................................................................................................................................... 193
See Also ................................................................................................................................................ 193
TagResource .............................................................................................................................................. 195
Request Syntax .................................................................................................................................... 195
URI Request Parameters ................................................................................................................... 195
Request Body ....................................................................................................................................... 195
Response Syntax ................................................................................................................................. 196
Response Elements ............................................................................................................................ 196
Errors ..................................................................................................................................................... 196

API Version 2020-08-23 vii

AmazonAppFlow API Reference

API Version 2020-08-23 viii

AmazonAppFlow API Reference

Request Syntax .................................................................................................................................... 220

URI Request Parameters ................................................................................................................... 226
Request Body ....................................................................................................................................... 226
Response Syntax ................................................................................................................................. 228
Response Elements ............................................................................................................................ 229
Errors ..................................................................................................................................................... 229
Examples ............................................................................................................................................... 230
See Also ................................................................................................................................................ 235
Data Types ................................................................................................................................... 236
AggregationConfig ................................................................................................................................... 242
Contents ............................................................................................................................................... 242
See Also ................................................................................................................................................ 242
AmplitudeConnectorProfileCredentials ............................................................................................... 243
Contents ............................................................................................................................................... 243
See Also ................................................................................................................................................ 243
AmplitudeConnectorProfileProperties ................................................................................................. 244
Contents ............................................................................................................................................... 244
See Also ................................................................................................................................................ 244
AmplitudeMetadata ................................................................................................................................. 245
Contents ............................................................................................................................................... 245
See Also ................................................................................................................................................ 245
AmplitudeSourceProperties ................................................................................................................... 246
Contents ............................................................................................................................................... 246
See Also ................................................................................................................................................ 246
ApiKeyCredentials .................................................................................................................................... 247
Contents ............................................................................................................................................... 247
See Also ................................................................................................................................................ 247
AuthenticationConfig .............................................................................................................................. 248
Contents ............................................................................................................................................... 248
See Also ................................................................................................................................................ 249
AuthParameter ......................................................................................................................................... 250
Contents ............................................................................................................................................... 250
See Also ................................................................................................................................................ 251
BasicAuthCredentials ............................................................................................................................... 252
Contents ............................................................................................................................................... 252
See Also ................................................................................................................................................ 252

API Version 2020-08-23 ix

AmazonAppFlow API Reference

ConnectorConﬁguration ......................................................................................................................... 253

Contents ............................................................................................................................................... 253
See Also ................................................................................................................................................ 259
ConnectorDetail ........................................................................................................................................ 260
Contents ............................................................................................................................................... 260
See Also ................................................................................................................................................ 263
ConnectorEntity ........................................................................................................................................ 264
Contents ............................................................................................................................................... 264
See Also ................................................................................................................................................ 265
ConnectorEntityField ............................................................................................................................... 266
Contents ............................................................................................................................................... 266
See Also ................................................................................................................................................ 268
ConnectorMetadata ................................................................................................................................. 269
Contents ............................................................................................................................................... 269
See Also ................................................................................................................................................ 272
ConnectorOAuthRequest ........................................................................................................................ 274
Contents ............................................................................................................................................... 274
See Also ................................................................................................................................................ 274
ConnectorOperator .................................................................................................................................. 275
Contents ............................................................................................................................................... 275
See Also ................................................................................................................................................ 280
ConnectorProfile ...................................................................................................................................... 281
Contents ............................................................................................................................................... 281
See Also ................................................................................................................................................ 283
ConnectorProfileConfig ........................................................................................................................... 284
Contents ............................................................................................................................................... 284
See Also ................................................................................................................................................ 284
ConnectorProfileCredentials .................................................................................................................. 285
Contents ............................................................................................................................................... 285
See Also ................................................................................................................................................ 288
ConnectorProfileProperties .................................................................................................................... 289
Contents ............................................................................................................................................... 289
See Also ................................................................................................................................................ 292
ConnectorProvisioningConfig ................................................................................................................ 293
Contents ............................................................................................................................................... 293
See Also ................................................................................................................................................ 293

API Version 2020-08-23 x

AmazonAppFlow API Reference

ConnectorRuntimeSetting ...................................................................................................................... 294

Contents ............................................................................................................................................... 294
See Also ................................................................................................................................................ 295
CustomAuthConfig ................................................................................................................................... 297
Contents ............................................................................................................................................... 297
See Also ................................................................................................................................................ 297
CustomAuthCredentials .......................................................................................................................... 298
Contents ............................................................................................................................................... 298
See Also ................................................................................................................................................ 298
CustomConnectorDestinationProperties ............................................................................................. 300
Contents ............................................................................................................................................... 300
See Also ................................................................................................................................................ 301
CustomConnectorProfileCredentials .................................................................................................... 302
Contents ............................................................................................................................................... 302
See Also ................................................................................................................................................ 303
CustomConnectorProfileProperties ...................................................................................................... 304
Contents ............................................................................................................................................... 304
See Also ................................................................................................................................................ 304
CustomConnectorSourceProperties ...................................................................................................... 305
Contents ............................................................................................................................................... 305
See Also ................................................................................................................................................ 306
CustomerProfilesDestinationProperties ............................................................................................... 307
Contents ............................................................................................................................................... 307
See Also ................................................................................................................................................ 307
CustomerProfilesMetadata ..................................................................................................................... 308
Contents ............................................................................................................................................... 308
See Also ................................................................................................................................................ 308
DatadogConnectorProfileCredentials ................................................................................................... 309
Contents ............................................................................................................................................... 309
See Also ................................................................................................................................................ 309
DatadogConnectorProfileProperties .................................................................................................... 311
Contents ............................................................................................................................................... 311
See Also ................................................................................................................................................ 311
DatadogMetadata .................................................................................................................................... 312
Contents ............................................................................................................................................... 312
See Also ................................................................................................................................................ 312

API Version 2020-08-23 xi

AmazonAppFlow API Reference

DatadogSourceProperties ....................................................................................................................... 313

Contents ............................................................................................................................................... 313
See Also ................................................................................................................................................ 313
DataTransferApi ........................................................................................................................................ 314
Contents ............................................................................................................................................... 314
See Also ................................................................................................................................................ 315
DestinationConnectorProperties ........................................................................................................... 316
Contents ............................................................................................................................................... 316
See Also ................................................................................................................................................ 318
DestinationFieldProperties ..................................................................................................................... 319
Contents ............................................................................................................................................... 319
See Also ................................................................................................................................................ 320
DestinationFlowConfig ............................................................................................................................ 321
Contents ............................................................................................................................................... 321
See Also ................................................................................................................................................ 322
DynatraceConnectorProfileCredentials ................................................................................................ 323
Contents ............................................................................................................................................... 323
See Also ................................................................................................................................................ 323
DynatraceConnectorProfileProperties ................................................................................................. 324
Contents ............................................................................................................................................... 324
See Also ................................................................................................................................................ 324
DynatraceMetadata .................................................................................................................................. 325
Contents ............................................................................................................................................... 325
See Also ................................................................................................................................................ 325
DynatraceSourceProperties .................................................................................................................... 326
Contents ............................................................................................................................................... 326
See Also ................................................................................................................................................ 326
ErrorHandlingConfig ................................................................................................................................ 327
Contents ............................................................................................................................................... 327
See Also ................................................................................................................................................ 328
ErrorInfo ..................................................................................................................................................... 329
Contents ............................................................................................................................................... 329
See Also ................................................................................................................................................ 329
EventBridgeDestinationProperties ........................................................................................................ 330
Contents ............................................................................................................................................... 330
See Also ................................................................................................................................................ 330

API Version 2020-08-23 xii

AmazonAppFlow API Reference

EventBridgeMetadata .............................................................................................................................. 331

Contents ............................................................................................................................................... 331
See Also ................................................................................................................................................ 331
ExecutionDetails ....................................................................................................................................... 332
Contents ............................................................................................................................................... 332
See Also ................................................................................................................................................ 332
ExecutionRecord ....................................................................................................................................... 334
Contents ............................................................................................................................................... 334
See Also ................................................................................................................................................ 335
ExecutionResult ........................................................................................................................................ 336
Contents ............................................................................................................................................... 336
See Also ................................................................................................................................................ 337
FieldTypeDetails ....................................................................................................................................... 338
Contents ............................................................................................................................................... 338
See Also ................................................................................................................................................ 339
FlowDefinition ........................................................................................................................................... 341
Contents ............................................................................................................................................... 341
See Also ................................................................................................................................................ 344
GlueDataCatalogConfig .......................................................................................................................... 346
Contents ............................................................................................................................................... 346
See Also ................................................................................................................................................ 347
GoogleAnalyticsConnectorProfileCredentials ..................................................................................... 348
Contents ............................................................................................................................................... 348
See Also ................................................................................................................................................ 349
GoogleAnalyticsConnectorProfileProperties ...................................................................................... 350
Contents ............................................................................................................................................... 350
See Also ................................................................................................................................................ 350
GoogleAnalyticsMetadata ...................................................................................................................... 351
Contents ............................................................................................................................................... 351
See Also ................................................................................................................................................ 351
GoogleAnalyticsSourceProperties ......................................................................................................... 352
Contents ............................................................................................................................................... 352
See Also ................................................................................................................................................ 352
HoneycodeConnectorProfileCredentials .............................................................................................. 353
Contents ............................................................................................................................................... 353
See Also ................................................................................................................................................ 353

API Version 2020-08-23 xiii

AmazonAppFlow API Reference

HoneycodeConnectorProﬁleProperties ................................................................................................ 355

Contents ............................................................................................................................................... 355
See Also ................................................................................................................................................ 355
HoneycodeDestinationProperties ......................................................................................................... 356
Contents ............................................................................................................................................... 356
See Also ................................................................................................................................................ 356
HoneycodeMetadata ................................................................................................................................ 357
Contents ............................................................................................................................................... 357
See Also ................................................................................................................................................ 357
IncrementalPullConfig ............................................................................................................................. 358
Contents ............................................................................................................................................... 358
See Also ................................................................................................................................................ 358
InforNexusConnectorProfileCredentials .............................................................................................. 359
Contents ............................................................................................................................................... 359
See Also ................................................................................................................................................ 360
InforNexusConnectorProfileProperties ................................................................................................ 361
Contents ............................................................................................................................................... 361
See Also ................................................................................................................................................ 361
InforNexusMetadata ................................................................................................................................ 362
Contents ............................................................................................................................................... 362
See Also ................................................................................................................................................ 362
InforNexusSourceProperties ................................................................................................................... 363
Contents ............................................................................................................................................... 363
See Also ................................................................................................................................................ 363
LambdaConnectorProvisioningConfig .................................................................................................. 364
Contents ............................................................................................................................................... 364
See Also ................................................................................................................................................ 364
LookoutMetricsDestinationProperties .................................................................................................. 365
Contents ............................................................................................................................................... 365
See Also ................................................................................................................................................ 365
MarketoConnectorProfileCredentials ................................................................................................... 366
Contents ............................................................................................................................................... 366
See Also ................................................................................................................................................ 367
MarketoConnectorProfileProperties ..................................................................................................... 368
Contents ............................................................................................................................................... 368
See Also ................................................................................................................................................ 368

API Version 2020-08-23 xiv

AmazonAppFlow API Reference

MarketoDestinationProperties ............................................................................................................... 369

Contents ............................................................................................................................................... 369
See Also ................................................................................................................................................ 369
MarketoMetadata ..................................................................................................................................... 370
Contents ............................................................................................................................................... 370
See Also ................................................................................................................................................ 370
MarketoSourceProperties ....................................................................................................................... 371
Contents ............................................................................................................................................... 371
See Also ................................................................................................................................................ 371
MetadataCatalogConﬁg .......................................................................................................................... 372
Contents ............................................................................................................................................... 372
See Also ................................................................................................................................................ 372
MetadataCatalogDetail ........................................................................................................................... 373
Contents ............................................................................................................................................... 373
See Also ................................................................................................................................................ 374
OAuth2Credentials ................................................................................................................................... 375
Contents ............................................................................................................................................... 375
See Also ................................................................................................................................................ 376
OAuth2CustomParameter ...................................................................................................................... 377
Contents ............................................................................................................................................... 377
See Also ................................................................................................................................................ 378
OAuth2Defaults ........................................................................................................................................ 379
Contents ............................................................................................................................................... 379
See Also ................................................................................................................................................ 380
OAuth2Properties .................................................................................................................................... 381
Contents ............................................................................................................................................... 381
See Also ................................................................................................................................................ 382
OAuthCredentials ..................................................................................................................................... 383
Contents ............................................................................................................................................... 383
See Also ................................................................................................................................................ 384
OAuthProperties ....................................................................................................................................... 385
Contents ............................................................................................................................................... 385
See Also ................................................................................................................................................ 386
PardotConnectorProﬁleCredentials ...................................................................................................... 387
Contents ............................................................................................................................................... 387
See Also ................................................................................................................................................ 388

API Version 2020-08-23 xv

AmazonAppFlow API Reference

PardotConnectorProﬁleProperties ........................................................................................................ 389

Contents ............................................................................................................................................... 389
See Also ................................................................................................................................................ 389
PardotMetadata ........................................................................................................................................ 391
Contents ............................................................................................................................................... 391
See Also ................................................................................................................................................ 391
PardotSourceProperties .......................................................................................................................... 392
Contents ............................................................................................................................................... 392
See Also ................................................................................................................................................ 392
PrefixConfig ............................................................................................................................................... 393
Contents ............................................................................................................................................... 393
See Also ................................................................................................................................................ 394
PrivateConnectionProvisioningState .................................................................................................... 395
Contents ............................................................................................................................................... 395
See Also ................................................................................................................................................ 395
Range .......................................................................................................................................................... 397
Contents ............................................................................................................................................... 397
See Also ................................................................................................................................................ 397
RedshiftConnectorProfileCredentials ................................................................................................... 398
Contents ............................................................................................................................................... 398
See Also ................................................................................................................................................ 398
RedshiftConnectorProfileProperties ..................................................................................................... 399
Contents ............................................................................................................................................... 399
See Also ................................................................................................................................................ 401
RedshiftDestinationProperties ............................................................................................................... 402
Contents ............................................................................................................................................... 402
See Also ................................................................................................................................................ 403
RedshiftMetadata ..................................................................................................................................... 404
Contents ............................................................................................................................................... 404
See Also ................................................................................................................................................ 404
RegistrationOutput .................................................................................................................................. 405
Contents ............................................................................................................................................... 405
See Also ................................................................................................................................................ 406
S3DestinationProperties ......................................................................................................................... 407
Contents ............................................................................................................................................... 407
See Also ................................................................................................................................................ 407

API Version 2020-08-23 xvi

AmazonAppFlow API Reference

S3InputFormatConﬁg .............................................................................................................................. 409

Contents ............................................................................................................................................... 409
See Also ................................................................................................................................................ 409
S3Metadata ............................................................................................................................................... 410
Contents ............................................................................................................................................... 410
See Also ................................................................................................................................................ 410
S3OutputFormatConfig .......................................................................................................................... 411
Contents ............................................................................................................................................... 411
See Also ................................................................................................................................................ 412
S3SourceProperties .................................................................................................................................. 413
Contents ............................................................................................................................................... 413
See Also ................................................................................................................................................ 413
SalesforceConnectorProfileCredentials ................................................................................................ 415
Contents ............................................................................................................................................... 415
See Also ................................................................................................................................................ 417
SalesforceConnectorProfileProperties ................................................................................................. 418
Contents ............................................................................................................................................... 418
See Also ................................................................................................................................................ 419
SalesforceDestinationProperties ........................................................................................................... 420
Contents ............................................................................................................................................... 420
See Also ................................................................................................................................................ 422
SalesforceMetadata ................................................................................................................................. 423
Contents ............................................................................................................................................... 423
See Also ................................................................................................................................................ 424
SalesforceSourceProperties .................................................................................................................... 425
Contents ............................................................................................................................................... 425
See Also ................................................................................................................................................ 426
SAPODataConnectorProfileCredentials ............................................................................................... 428
Contents ............................................................................................................................................... 428
See Also ................................................................................................................................................ 428
SAPODataConnectorProfileProperties ................................................................................................. 429
Contents ............................................................................................................................................... 429
See Also ................................................................................................................................................ 431
SAPODataDestinationProperties ........................................................................................................... 432
Contents ............................................................................................................................................... 432
See Also ................................................................................................................................................ 433

API Version 2020-08-23 xvii

AmazonAppFlow API Reference

SAPODataMetadata ................................................................................................................................. 434

Contents ............................................................................................................................................... 434
See Also ................................................................................................................................................ 434
SAPODataPaginationConfig ................................................................................................................... 435
Contents ............................................................................................................................................... 435
See Also ................................................................................................................................................ 435
SAPODataParallelismConfig .................................................................................................................. 436
Contents ............................................................................................................................................... 436
See Also ................................................................................................................................................ 436
SAPODataSourceProperties ................................................................................................................... 437
Contents ............................................................................................................................................... 437
See Also ................................................................................................................................................ 437
ScheduledTriggerProperties ................................................................................................................... 439
Contents ............................................................................................................................................... 439
See Also ................................................................................................................................................ 441
ServiceNowConnectorProfileCredentials ............................................................................................. 442
Contents ............................................................................................................................................... 442
See Also ................................................................................................................................................ 442
ServiceNowConnectorProfileProperties ............................................................................................... 444
Contents ............................................................................................................................................... 444
See Also ................................................................................................................................................ 444
ServiceNowMetadata ............................................................................................................................... 445
Contents ............................................................................................................................................... 445
See Also ................................................................................................................................................ 445
ServiceNowSourceProperties ................................................................................................................. 446
Contents ............................................................................................................................................... 446
See Also ................................................................................................................................................ 446
SingularConnectorProfileCredentials ................................................................................................... 447
Contents ............................................................................................................................................... 447
See Also ................................................................................................................................................ 447
SingularConnectorProfileProperties ..................................................................................................... 448
Contents ............................................................................................................................................... 448
See Also ................................................................................................................................................ 448
SingularMetadata ..................................................................................................................................... 449
Contents ............................................................................................................................................... 449
See Also ................................................................................................................................................ 449

API Version 2020-08-23 xviii

AmazonAppFlow API Reference

SingularSourceProperties ....................................................................................................................... 450

Contents ............................................................................................................................................... 450
See Also ................................................................................................................................................ 450
SlackConnectorProfileCredentials ......................................................................................................... 451
Contents ............................................................................................................................................... 451
See Also ................................................................................................................................................ 452
SlackConnectorProfileProperties .......................................................................................................... 453
Contents ............................................................................................................................................... 453
See Also ................................................................................................................................................ 453
SlackMetadata .......................................................................................................................................... 454
Contents ............................................................................................................................................... 454
See Also ................................................................................................................................................ 454
SlackSourceProperties ............................................................................................................................. 455
Contents ............................................................................................................................................... 455
See Also ................................................................................................................................................ 455
SnowflakeConnectorProfileCredentials ............................................................................................... 456
Contents ............................................................................................................................................... 456
See Also ................................................................................................................................................ 456
SnowflakeConnectorProfileProperties ................................................................................................. 457
Contents ............................................................................................................................................... 457
See Also ................................................................................................................................................ 459
SnowflakeDestinationProperties ........................................................................................................... 460
Contents ............................................................................................................................................... 460
See Also ................................................................................................................................................ 461
SnowflakeMetadata ................................................................................................................................. 462
Contents ............................................................................................................................................... 462
See Also ................................................................................................................................................ 462
SourceConnectorProperties ................................................................................................................... 463
Contents ............................................................................................................................................... 463
See Also ................................................................................................................................................ 466
SourceFieldProperties ............................................................................................................................. 467
Contents ............................................................................................................................................... 467
See Also ................................................................................................................................................ 467
SourceFlowConfig .................................................................................................................................... 468
Contents ............................................................................................................................................... 468
See Also ................................................................................................................................................ 469

API Version 2020-08-23 xix

AmazonAppFlow API Reference

SuccessResponseHandlingConﬁg .......................................................................................................... 470

Contents ............................................................................................................................................... 470
See Also ................................................................................................................................................ 470
SupportedFieldTypeDetails .................................................................................................................... 472
Contents ............................................................................................................................................... 472
See Also ................................................................................................................................................ 472
Task ............................................................................................................................................................. 473
Contents ............................................................................................................................................... 473
See Also ................................................................................................................................................ 474
TrendmicroConnectorProfileCredentials .............................................................................................. 475
Contents ............................................................................................................................................... 475
See Also ................................................................................................................................................ 475
TrendmicroConnectorProfileProperties ............................................................................................... 476
Contents ............................................................................................................................................... 476
See Also ................................................................................................................................................ 476
TrendmicroMetadata ............................................................................................................................... 477
Contents ............................................................................................................................................... 477
See Also ................................................................................................................................................ 477
TrendmicroSourceProperties .................................................................................................................. 478
Contents ............................................................................................................................................... 478
See Also ................................................................................................................................................ 478
TriggerConfig ............................................................................................................................................ 479
Contents ............................................................................................................................................... 479
See Also ................................................................................................................................................ 479
TriggerProperties ...................................................................................................................................... 480
Contents ............................................................................................................................................... 480
See Also ................................................................................................................................................ 480
UpsolverDestinationProperties .............................................................................................................. 481
Contents ............................................................................................................................................... 481
See Also ................................................................................................................................................ 481
UpsolverMetadata .................................................................................................................................... 483
Contents ............................................................................................................................................... 483
See Also ................................................................................................................................................ 483
UpsolverS3OutputFormatConfig .......................................................................................................... 484
Contents ............................................................................................................................................... 484
See Also ................................................................................................................................................ 484

API Version 2020-08-23 xx

AmazonAppFlow API Reference

VeevaConnectorProﬁleCredentials ....................................................................................................... 486

Contents ............................................................................................................................................... 486
See Also ................................................................................................................................................ 486
VeevaConnectorProfileProperties ......................................................................................................... 487
Contents ............................................................................................................................................... 487
See Also ................................................................................................................................................ 487
VeevaMetadata ......................................................................................................................................... 488
Contents ............................................................................................................................................... 488
See Also ................................................................................................................................................ 488
VeevaSourceProperties ........................................................................................................................... 489
Contents ............................................................................................................................................... 489
See Also ................................................................................................................................................ 490
ZendeskConnectorProfileCredentials ................................................................................................... 491
Contents ............................................................................................................................................... 491
See Also ................................................................................................................................................ 492
ZendeskConnectorProfileProperties ..................................................................................................... 493
Contents ............................................................................................................................................... 493
See Also ................................................................................................................................................ 493
ZendeskDestinationProperties ............................................................................................................... 494
Contents ............................................................................................................................................... 494
See Also ................................................................................................................................................ 495
ZendeskMetadata ..................................................................................................................................... 496
Contents ............................................................................................................................................... 496
See Also ................................................................................................................................................ 496
ZendeskSourceProperties ....................................................................................................................... 497
Contents ............................................................................................................................................... 497
See Also ................................................................................................................................................ 497
Common Parameters ................................................................................................................... 498
Common Error Types ................................................................................................................... 501

API Version 2020-08-23 xxi

AmazonAppFlow API Reference

Welcome
Welcome to the Amazon AppFlow API reference. This guide is for developers who need detailed
information about the Amazon AppFlow API operations, data types, and errors.

Amazon AppFlow is a fully managed integration service that enables you to securely transfer data
between software as a service (SaaS) applications like Salesforce, Marketo, Slack, and ServiceNow,
and Amazon Web Services like Amazon S3 and Amazon Redshift.

Use the following links to get started on the Amazon AppFlow API:

• Actions: An alphabetical list of all Amazon AppFlow API operations.

• Data types: An alphabetical list of all Amazon AppFlow data types.
• Common parameters: Parameters that all Query operations can use.
• Common errors: Client and server errors that all operations can return.

If you're new to Amazon AppFlow, we recommend that you review the Amazon AppFlow User
Guide.

Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include
applicable OAuth attributes (such as auth-code and redirecturi) with the connector-
specific ConnectorProfileProperties when creating a new connector profile using Amazon
AppFlow API operations. For example, Salesforce users can refer to the Authorize Apps with OAuth
documentation.

This document was last published on April 3, 2026.

API Version 2020-08-23 1

AmazonAppFlow API Reference

Actions
The following actions are supported:

• CancelFlowExecutions
• CreateConnectorProfile
• CreateFlow
• DeleteConnectorProfile
• DeleteFlow
• DescribeConnector
• DescribeConnectorEntity
• DescribeConnectorProfiles
• DescribeConnectors
• DescribeFlow
• DescribeFlowExecutionRecords
• ListConnectorEntities
• ListConnectors
• ListFlows
• ListTagsForResource
• RegisterConnector
• ResetConnectorMetadataCache
• StartFlow
• StopFlow
• TagResource
• UnregisterConnector
• UntagResource
• UpdateConnectorProfile
• UpdateConnectorRegistration
• UpdateFlow

API Version 2020-08-23 2

AmazonAppFlow API Reference

CancelFlowExecutions
Cancels active runs for a ﬂow.

You can cancel all of the active runs for a ﬂow, or you can cancel speciﬁc runs by providing their
IDs.

You can cancel a ﬂow run only when the run is in progress. You can't cancel a run that has already
completed or failed. You also can't cancel a run that's scheduled to occur but hasn't started yet. To
prevent a scheduled run, you can deactivate the ﬂow with the StopFlow action.

You cannot resume a run after you cancel it.

When you send your request, the status for each run becomes CancelStarted. When the
cancellation completes, the status becomes Canceled.

Note
When you cancel a run, you still incur charges for any data that the run already processed
before the cancellation. If the run had already written some data to the flow destination,
then that data remains in the destination. If you configured the flow to use a batch API
(such as the Salesforce Bulk API 2.0), then the run will finish reading or writing its entire
batch of data after the cancellation. For these operations, the data processing charges for
Amazon AppFlow apply. For the pricing information, see Amazon AppFlow pricing.

Request Syntax

POST /cancel-flow-executions HTTP/1.1

Content-type: application/json

{
"executionIds": [ "string" ],
"flowName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

CancelFlowExecutions API Version 2020-08-23 3

AmazonAppFlow API Reference

Request Body

The request accepts the following data in JSON format.

executionIds

The ID of each active run to cancel. These runs must belong to the ﬂow you specify in your
request.

If you omit this parameter, your request ends all active runs that belong to the ﬂow.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
ﬂowName

The name of a ﬂow with active runs that you want to cancel.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"invalidExecutions": [ "string" ]
}

Request Body API Version 2020-08-23 4

AmazonAppFlow API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

invalidExecutions

The IDs of runs that Amazon AppFlow couldn't cancel. These runs might be ineligible for
canceling because they haven't started yet or have already completed.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

Pattern: \S+

Errors
For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ThrottlingException

API calls have exceeded the maximum allowed API request rate per account and per Region.

Response Elements API Version 2020-08-23 5

AmazonAppFlow API Reference

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /create-connector-profile HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"connectionMode": "string",
"connectorLabel": "string",
"connectorProfileConfig": {
"connectorProfileCredentials": {
"Amplitude": {
"apiKey": "string",
"secretKey": "string"
},
"CustomConnector": {
"apiKey": {
"apiKey": "string",
"apiSecretKey": "string"
},
"authenticationType": "string",
"basic": {
"password": "string",
"username": "string"
},
"custom": {
"credentialsMap": {
"string" : "string"
},
"customAuthenticationType": "string"
},
"oauth2": {
"accessToken": "string",
"clientId": "string",

CreateConnectorProﬁle API Version 2020-08-23 7

AmazonAppFlow API Reference

"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
}
},
"Datadog": {
"apiKey": "string",
"applicationKey": "string"
},
"Dynatrace": {
"apiToken": "string"
},
"GoogleAnalytics": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Honeycode": {
"accessToken": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"InforNexus": {
"accessKeyId": "string",
"datakey": "string",
"secretAccessKey": "string",
"userId": "string"
},
"Marketo": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {

Request Syntax API Version 2020-08-23 8

AmazonAppFlow API Reference

"authCode": "string",
"redirectUri": "string"
}
},
"Pardot": {
"accessToken": "string",
"clientCredentialsArn": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Redshift": {
"password": "string",
"username": "string"
},
"Salesforce": {
"accessToken": "string",
"clientCredentialsArn": "string",
"jwtToken": "string",
"oAuth2GrantType": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"SAPOData": {
"basicAuthCredentials": {
"password": "string",
"username": "string"
},
"oAuthCredentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
}
},

Request Syntax API Version 2020-08-23 9

AmazonAppFlow API Reference

"ServiceNow": {
"oAuth2Credentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"password": "string",
"username": "string"
},
"Singular": {
"apiKey": "string"
},
"Slack": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Snowflake": {
"password": "string",
"username": "string"
},
"Trendmicro": {
"apiSecretKey": "string"
},
"Veeva": {
"password": "string",
"username": "string"
},
"Zendesk": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"

Request Syntax API Version 2020-08-23 10

AmazonAppFlow API Reference

}
}
},
"connectorProfileProperties": {
"Amplitude": {
},
"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"
},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",

Request Syntax API Version 2020-08-23 11

AmazonAppFlow API Reference

"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},
"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"ServiceNow": {
"instanceUrl": "string"
},
"Singular": {
},
"Slack": {
"instanceUrl": "string"
},
"Snowflake": {
"accountName": "string",
"bucketName": "string",
"bucketPrefix": "string",
"privateLinkServiceName": "string",
"region": "string",
"stage": "string",
"warehouse": "string"
},
"Trendmicro": {
},

Request Syntax API Version 2020-08-23 12

AmazonAppFlow API Reference

"Veeva": {
"instanceUrl": "string"
},
"Zendesk": {
"instanceUrl": "string"
}
}
},
"connectorProfileName": "string",
"connectorType": "string",
"kmsArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your

CreateConnectorProfile request completes only once. You choose the value to pass. For
example, if you don't receive a response from your request, you can safely retry the request with
the same clientToken parameter value.

If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This
way, the SDK can safely retry requests multiple times after a network error. You must provide
your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If
you use a different value for clientToken, Amazon AppFlow considers it a new call to
CreateConnectorProfile. The token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

URI Request Parameters API Version 2020-08-23 13

AmazonAppFlow API Reference

Required: No
connectionMode

Indicates the connection mode and speciﬁes whether it is public or private. Private ﬂows
use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public
internet.

Type: String

Valid Values: Public | Private

Required: Yes
connectorLabel

The label of the connector. The label is unique for each ConnectorRegistration in your AWS
account. Only needed if calling for CUSTOMCONNECTOR connector type/.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorProﬁleConﬁg

Defines the connector-specific configuration and credentials.

Type: ConnectorProﬁleConﬁg object

Required: Yes
connectorProﬁleName

The name of the connector proﬁle. The name is unique for each ConnectorProfile in your
AWS account.

Type: String

Length Constraints: Maximum length of 256.

Request Body API Version 2020-08-23 14

AmazonAppFlow API Reference

Pattern: [\w/!@#+=.-]+

Required: Yes
connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: Yes
kmsArn

The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for
encryption. This is required if you do not want to use the Amazon AppFlow-managed KMS key.
If you don't provide anything here, Amazon AppFlow uses the Amazon AppFlow-managed KMS
key.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:.*:[0-9]+:.*

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorProfileArn": "string"
}

Response Syntax API Version 2020-08-23 15

AmazonAppFlow API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorProﬁleArn

The Amazon Resource Name (ARN) of the connector proﬁle.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

Response Elements API Version 2020-08-23 16

AmazonAppFlow API Reference

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

CustomConnector

This example shows a sample request for the CreateConnectorProfile API (without OAuth)
and a sample response.

Sample Request

{
"connectorProfileName": "Connector_Profile_Name_Value",
"kmsArn": null,
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"connectionMode": "Public",
"connectorProfileConfig":
{
"connectorProfileProperties":
{
"salesforce":
{
"instanceUrl": "InstanceUrl_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials":
{
"salesforce":
{
"accessToken": "<AccessToken>",
"refreshToken": "<RefreshToken>",
"oauthRequest":
{
"authCode": null,
"redirectUri": null
}

Examples API Version 2020-08-23 17

AmazonAppFlow API Reference

}
}
}
}

Sample Response

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
Connector_Profile_Name"
}

Salesforce without OAuth

This example shows a sample request for the CreateConnectorProfile API (without OAuth)
and a sample response.

Sample Request

{
"connectorProfileName": "Connector_Profile_Name_Value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectorLabel": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"salesforce": {
"instanceUrl": "InstanceUrl_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials": {
"salesforce": {
"accessToken": "<AccessToken>",
"refreshToken": "<RefreshToken>",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}

Examples API Version 2020-08-23 18

AmazonAppFlow API Reference

}
}

Sample Response

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
Connector_Profile_Name"
}

Salesforce with OAuth

These examples show a request with OAuth and a sample response.

Sample Request

{
"connectorProfileName": "connector-profile-name_value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"salesforce": {
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials": {
"salesforce": {
"oauthRequest": {
"authCode": "<AuthCode>",
"redirectUri": "redirectUri"
}
}
}
}
}

Sample Response

Examples API Version 2020-08-23 19

AmazonAppFlow API Reference

"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
connector-profile-name"
}

Zendesk

This example shows a sample request and response for the CreateConnectorProfile API using
Zendesk.

Sample Request

{
"connectorProfileName": "connector-profile-name",
"connectorType": "Zendesk",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"zendesk": {
"instanceUrl": "Zendesk_Url"
}
},
"connectorProfileCredentials": {
"zendesk": {
"clientId": "aws_integration_to_zendesk",
"clientSecret": "<ClientSecret>",
"accessToken": "<AccessToken>",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}

Sample Response

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
connector-profile-name"
}

Examples API Version 2020-08-23 20

AmazonAppFlow API Reference

Google Analytics

This example shows a sample request and response for the CreateConnectorProfile API using
Google Analytics.

Sample Request

{
"connectorProfileName": "connector-profile-name",
"connectorType": "Googleanalytics",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"googleAnalytics": {}
},
"connectorProfileCredentials": {
"googleAnalytics": {
"clientId": "<ClientId>",
"clientSecret": "<ClientSecret>",
"accessToken": "<AccessToken>",
"refreshToken": "<RefreshToken>",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
connector-profile-name"
}

Marketo

This example shows a sample request and response for the CreateConnectorProfile API using
Marketo.

Examples API Version 2020-08-23 21

AmazonAppFlow API Reference

Sample Request

{
"connectorProfileName": "Connector-profile-new",
"connectorType": "Marketo",
"connectionMode": "Public",
"connectorProfileConfig": {
"connectorProfileProperties": {
"marketo": {
"instanceUrl": "Marketo_Url"
}
},
"connectorProfileCredentials": {
"marketo": {
"clientId": "<ClientId>>",
"clientSecret": "<ClientSecret>",
"accessToken": "<AccessToken>",
"oauthRequest": {
"authCode": null,
"redirectUri": null
}
}
}
}
}

Sample Response

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
Connector-profile-new"
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /create-flow HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"description": "string",
"destinationFlowConfigList": [
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"destinationConnectorProperties": {
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"entityName": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"writeOperationType": "string"
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"EventBridge": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",

CreateFlow API Version 2020-08-23 24

AmazonAppFlow API Reference

"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",

Request Syntax API Version 2020-08-23 25

AmazonAppFlow API Reference

"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}
},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {

Request Syntax API Version 2020-08-23 26

AmazonAppFlow API Reference

"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowName": "string",
"kmsArn": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"

Request Syntax API Version 2020-08-23 27

AmazonAppFlow API Reference

},
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"entityName": "string"
},
"Datadog": {
"object": "string"
},
"Dynatrace": {
"object": "string"
},
"GoogleAnalytics": {
"object": "string"
},
"InforNexus": {
"object": "string"
},
"Marketo": {
"object": "string"
},
"Pardot": {
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3InputFormatConfig": {
"s3InputFileType": "string"
}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",

Request Syntax API Version 2020-08-23 28

AmazonAppFlow API Reference

"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number
}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tags": {
"string" : "string"
},
"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",

Request Syntax API Version 2020-08-23 29

AmazonAppFlow API Reference

"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",
"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

URI Request Parameters API Version 2020-08-23 30

AmazonAppFlow API Reference

clientToken

The clientToken parameter is an idempotency token. It ensures that your CreateFlow

request completes only once. You choose the value to pass. For example, if you don't receive
a response from your request, you can safely retry the request with the same clientToken
parameter value.

If you specify input parameters that differ from your first request, an error occurs. If you use a
different value for clientToken, Amazon AppFlow considers it a new call to CreateFlow. The
token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
description

A description of the ﬂow you want to create.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
destinationFlowConﬁgList

The conﬁguration that controls how Amazon AppFlow places data in the destination connector.

Type: Array of DestinationFlowConﬁg objects

Required: Yes

Request Body API Version 2020-08-23 31

AmazonAppFlow API Reference

ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes
kmsArn

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:.*:[0-9]+:.*

Required: No
metadataCatalogConﬁg

Specifies the configuration that Amazon AppFlow uses when it catalogs the data that's
transferred by the associated flow. When Amazon AppFlow catalogs the data from a flow, it
stores metadata in a data catalog.

Type: MetadataCatalogConﬁg object

Required: No
sourceFlowConﬁg

The conﬁguration that controls how Amazon AppFlow retrieves data from the source connector.

Type: SourceFlowConﬁg object

Required: Yes

Request Body API Version 2020-08-23 32

AmazonAppFlow API Reference

tags

The tags used to organize, track, or control access for your ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\w+-=\.:/@]*

Required: No
tasks

A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run.

Type: Array of Task objects

Required: Yes
triggerConﬁg

The trigger settings that determine how and when the ﬂow runs.

Type: TriggerConﬁg object

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"flowArn": "string",
"flowStatus": "string"

Response Syntax API Version 2020-08-23 33

AmazonAppFlow API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ﬂowArn

The ﬂow's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*
ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

Response Elements API Version 2020-08-23 34

AmazonAppFlow API Reference

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Salesforce

This example shows a sample request for the CreateFlow API using Salesforce. If you see the
error shown in the second sample, it is because of an expired access or refresh token. Retrieve a
new access or refresh token to proceed.

Examples API Version 2020-08-23 35

AmazonAppFlow API Reference

Sample Request

{
"flowName": "testFlowSaleforce",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Salesforce",
"connectorLabel":"MyCustomConnector",
"connectorProfileName": "Connector_Profile_Name",
"sourceConnectorProperties": {
"salesforce": {
"object": "account"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorLabel":"MyCustomConnector",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"sourceFields": [
"CreatedDate"
],
"taskProperties": {

},
"destinationField": "CreatedDate",

Examples API Version 2020-08-23 36

AmazonAppFlow API Reference

"taskType": "Map"
},
{
"destinationField": "LastActivityDate",
"sourceFields": [
"LastActivityDate"
],
"taskProperties": {

},
"taskType": "Map"
}
]
}

{
"message": "Error while authenticating to connector"
}

Zendesk

This example shows a sample request for the CreateFlow API using Zendesk.

Sample Request

{
"useDefaultEncryption": false,
"flowName": "testFlowZendesk",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Zendesk",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"zendesk": {
"object": "tickets"

Examples API Version 2020-08-23 37

AmazonAppFlow API Reference

}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": [
"url"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}

Google Analytics

This example shows a sample request for the CreateFlow API using Google Analytics.

Sample Request

{
"useDefaultEncryption": false,
"flowName": "testFlowGAnalytics",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {

Examples API Version 2020-08-23 38

AmazonAppFlow API Reference

"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Googleanalytics",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"googleanalytics": {
"object": "ObjectID"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": [
"url"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}

Marketo

This example shows a sample request for the CreateFlow API using Marketo.

Examples API Version 2020-08-23 39

AmazonAppFlow API Reference

Sample Request

{
"flowName": "testMarketo",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "Scheduled",
"triggerProperties": {
"scheduledTriggerProperties" : {
"scheduleExpression" : "rate(1minutes)"
}
}
},
"sourceFlowConfig": {
"connectorType": "Marketo",
"connectorProfileName": "Connector-profile-new",
"sourceConnectorProperties": {
"marketo": {
"object": "leads"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "BucketName",
"bucketKey": "BucketKey"
}
}
}
],
"tasks": [
{
"connectorOperator": {
"marketo":"BETWEEN"
},
"sourceFields": [
"updatedAt"
],
"taskProperties": {
"DATA_TYPE": "datetime",

Examples API Version 2020-08-23 40

AmazonAppFlow API Reference

"LOWER_BOUND": "Lower_Bound_value",
"UPPER_BOUND": "Upper_Bound_value"
},
"taskType": "Filter"
},
{
"destinationField": "company",
"sourceFields": [
"company"
],
"taskProperties": {
"SOURCE_DATA_TYPE": "string"
},
"taskType": "Map"
}
]
}

Connection credentials

This Java example shows credentials associated with a connection. In this case, the example uses
OAuth. These credentials are stored in secrets manager after the proﬁle is created.

ConnectorProfileCredentials credentials = new

ConnectorProfileCredentials().withSalesforce(
new SalesforceConnectorProfileCredentials().withAccessToken(accessToken)
.withRefreshToken(refreshToken));

Connection properties

This Java example shows other properties associated with a connection to Salesforce.

ConnectorProfileProperties properties = new

ConnectorProfileProperties().withSalesforce(
new
SalesforceConnectorProfileProperties().withInstanceUrl(instanceUrl));

Connector proﬁle creation

To create a flow, you must first create a connector profile. This Java example shows information
about connecting to Salesforce.

Examples API Version 2020-08-23 41

AmazonAppFlow API Reference

[Link](new
CreateConnectorProfileRequest().withConnectorProfileConfig(
new
ConnectorProfileConfig().withConnectorProfileCredentials(credentials)
.withConnectorProfileProperties(properties))
.withConnectorProfileName(salesforceProfileName)
.withConnectorType([Link])
.withConnectionMode([Link]));

Source connection properties

This Java example shows properties for a source connection. Account is the object in
Salesforce that we want to retrieve. You can ﬁnd a list of all supported objects by using the
listConnectorEntity API. The ConnectorProfileName is the connector proﬁle, the creation
of which is seen in the previous example.

SourceFlowConfig sourceFlowConfig = new

SourceFlowConfig().withSourceConnectorProperties(
new SourceConnectorProperties().withSalesforce(new
SalesforceSourceProperties().withObject("Account")))
.withConnectorType([Link])
.withConnectorProfileName(salesforceProfileName);

Destination connection properties

This Java example shows properties for a destination connection. Note that many AWS connectors
such as Amazon S3 don't require a connector proﬁle. Amazon AppFlow accesses S3 buckets
through a bucket resource policy, therefore a connector proﬁle isn't needed.

DestinationFlowConfig destinationFlowConfig = new

DestinationFlowConfig().withConnectorType(ConnectorType.S3)
.withDestinationConnectorProperties(new
DestinationConnectorProperties().withS3(
new
S3DestinationProperties().withBucketName(bucketName).withBucketPrefix("testPrefix")));

Tasks

Tasks describe what to do with the data once it has been retrieved, but before it is sent to the
destination. Most connectors require a projection task. A projection task describes what ﬁelds

Examples API Version 2020-08-23 42

AmazonAppFlow API Reference

should be retrieved from the source object. Fields that can be retrieved can be discovered by
making a call to the DescribeConnectorEntity API.

Task projectionTask = new Task().withTaskType([Link])

.withConnectorOperator(new
ConnectorOperator().withSalesforce([Link]))
.withSourceFields("Id", "Name");

Mapping task

Most flows also require at least one mapping task. Mapping tasks map a source field to a
destination field. This Java example shows the mapping between the retrieved field, Id, to a new
field, AccountId.

Task createdMappingTask = new Task().withTaskType([Link])

.withConnectorOperator(new
ConnectorOperator().withSalesforce(SalesforceConnectorOperator.NO_OP))
.withSourceFields("Id")
.withDestinationField("AccountId");

[Link](new
CreateFlowRequest().withFlowName(salesforceFlowName)
.withTriggerConfig(new
TriggerConfig().withTriggerType([Link]))
.withSourceFlowConfig(sourceFlowConfig)
.withDestinationFlowConfigList(destinationFlowConfig)
.withTasks(projectionTask, idMappingTask, createdMappingTask));

Sample imports

This Java example shows sample imports.

import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

Examples API Version 2020-08-23 43

AmazonAppFlow API Reference

import [Link];
import [Link];
import [Link];
import [Link];
import [Link].S3DestinationProperties;
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];
import [Link];

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /delete-connector-profile HTTP/1.1

Content-type: application/json

{
"connectorProfileName": "string",
"forceDelete": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

connectorProﬁleName

The name of the connector proﬁle. The name is unique for each ConnectorProfile in your
account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: Yes
forceDelete

Indicates whether Amazon AppFlow should delete the proﬁle, even if it is currently in use in one
or more ﬂows.

Type: Boolean

DeleteConnectorProﬁle API Version 2020-08-23 45

AmazonAppFlow API Reference

Required: No

Response Syntax

HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

Examples

Marketo

This example shows a sample request and response for the CreateConnectorProfile API using
Marketo. If forceDelete is false, and there are ﬂows associated, you will see a message similar to
that shown in the third sample.

Response Syntax API Version 2020-08-23 46

AmazonAppFlow API Reference

Sample Request

{
"connectorProfileName": "testMarketoProfile",
"forceDelete": "true"
}

Sample Response

{
"deleted": true,
"flowNames": null
}

{
"message": "Conflict executing request: Connector profile: testMarketoProfile is
associated with one or more flows. If you still want to *delete* it, *then* make
*delete* request *with* forceDelete flag *as* true. *Some* of the associated flows
are: [myTestFlow1]"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /delete-flow HTTP/1.1

Content-type: application/json

{
"flowName": "string",
"forceDelete": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes
forceDelete

Indicates whether Amazon AppFlow should delete the ﬂow, even if it is currently in use.

Type: Boolean

DeleteFlow API Version 2020-08-23 48

AmazonAppFlow API Reference

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

Examples

An active scheduled ﬂow with forceDelete false

This example shows an active scheduled ﬂow with forceDelete false. The result is that a conﬂict
exception is thrown.

Response Syntax API Version 2020-08-23 49

AmazonAppFlow API Reference

Sample Request

{
"flowName": "flowName_value"
}

Sample Response

{
"message": "Conflict executing request: Flow is in active state, please set
forceDelete to true or deactivate the flow: flowName_value"
}

An active scheduled ﬂow with forceDelete true

This example shows an active scheduled ﬂow with forceDelete true. The result is that the ﬂow is
deleted successfully.

Sample Request

{
"flowName": "flowName_value",
"forceDelete": true
}

Sample Response

{}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /describe-connector HTTP/1.1

Content-type: application/json

{
"connectorLabel": "string",
"connectorType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

connectorLabel

The label of the connector. The label is unique for each ConnectorRegistration in your AWS
account. Only needed if calling for CUSTOMCONNECTOR connector type/.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorType

The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose

CUSTOMCONNECTOR for Lambda based custom connectors.

Type: String

DescribeConnector API Version 2020-08-23 52

AmazonAppFlow API Reference

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorConfiguration": {
"authenticationConfig": {
"customAuthConfigs": [
{
"authParameters": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string"
}
],
"customAuthenticationType": "string"
}
],
"isApiKeyAuthSupported": boolean,
"isBasicAuthSupported": boolean,
"isCustomAuthSupported": boolean,
"isOAuth2Supported": boolean,
"oAuth2Defaults": {
"authCodeUrls": [ "string" ],
"oauth2CustomProperties": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,

Response Syntax API Version 2020-08-23 53

AmazonAppFlow API Reference

"isSensitiveField": boolean,
"key": "string",
"label": "string",
"type": "string"
}
],
"oauth2GrantTypesSupported": [ "string" ],
"oauthScopes": [ "string" ],
"tokenUrls": [ "string" ]
}
},
"canUseAsDestination": boolean,
"canUseAsSource": boolean,
"connectorArn": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorMetadata": {
"Amplitude": {
},
"CustomerProfiles": {
},
"Datadog": {
},
"Dynatrace": {
},
"EventBridge": {
},
"GoogleAnalytics": {
"oAuthScopes": [ "string" ]
},
"Honeycode": {
"oAuthScopes": [ "string" ]
},
"InforNexus": {
},
"Marketo": {
},
"Pardot": {
},
"Redshift": {
},
"S3": {
},
"Salesforce": {

Response Syntax API Version 2020-08-23 54

AmazonAppFlow API Reference

"dataTransferApis": [ "string" ],
"oauth2GrantTypesSupported": [ "string" ],
"oAuthScopes": [ "string" ]
},
"SAPOData": {
},
"ServiceNow": {
},
"Singular": {
},
"Slack": {
"oAuthScopes": [ "string" ]
},
"Snowflake": {
"supportedRegions": [ "string" ]
},
"Trendmicro": {
},
"Upsolver": {
},
"Veeva": {
},
"Zendesk": {
"oAuthScopes": [ "string" ]
}
},
"connectorModes": [ "string" ],
"connectorName": "string",
"connectorOwner": "string",
"connectorProvisioningConfig": {
"lambda": {
"lambdaArn": "string"
}
},
"connectorProvisioningType": "string",
"connectorRuntimeSettings": [
{
"connectorSuppliedValueOptions": [ "string" ],
"dataType": "string",
"description": "string",
"isRequired": boolean,
"key": "string",
"label": "string",
"scope": "string"

Response Syntax API Version 2020-08-23 55

AmazonAppFlow API Reference

}
],
"connectorType": "string",
"connectorVersion": "string",
"isPrivateLinkEnabled": boolean,
"isPrivateLinkEndpointUrlRequired": boolean,
"logoURL": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedApiVersions": [ "string" ],
"supportedDataTransferApis": [
{
"Name": "string",
"Type": "string"
}
],
"supportedDataTransferTypes": [ "string" ],
"supportedDestinationConnectors": [ "string" ],
"supportedOperators": [ "string" ],
"supportedSchedulingFrequencies": [ "string" ],
"supportedTriggerTypes": [ "string" ],
"supportedWriteOperations": [ "string" ]
}
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorConﬁguration

Conﬁguration info of all the connectors that the user requested.

Type: ConnectorConﬁguration object

Errors

For information about the errors that are common to all actions, see Common Error Types.

Response Elements API Version 2020-08-23 56

AmazonAppFlow API Reference

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Describing the given connector

This example shows a sample request for the DescribeConnector API and a sample response.

Sample Request

{
"connectorType": "connectorType",
"connectorLabel": "connectorLabel"
}

Sample Response

{
"connectorConfiguration":
{
"authenticationConfig": null,
"canUseAsDestination": true,
"canUseAsSource": true,
"connectorArn": null,
"connectorDescription": "Salesforce",
"connectorLabel": null,
"connectorMetadata":

Examples API Version 2020-08-23 57

AmazonAppFlow API Reference

{
"Amplitude": null,
"AppIntegrations": null,
"CustomerProfiles": null,
"Datadog": null,
"Dynatrace": null,
"EventBridge": null,
"GoogleAnalytics": null,
"Honeycode": null,
"InforNexus": null,
"Locke": null,
"Marketo": null,
"Pardot": null,
"Redshift": null,
"S3": null,
"SAPOData": null,
"Salesforce":
{
"oAuthScopes":
[
"api",
"refresh_token",
"id"
]
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Upsolver": null,
"Veeva": null,
"Zendesk": null
},
"connectorModes": null,
"connectorName": null,
"connectorOwner": null,
"connectorProvisioningConfig": null,
"connectorProvisioningType": null,
"connectorRuntimeSettings": null,
"connectorType": "SALESFORCE",
"connectorVersion": null,
"isPrivateLinkEnabled": true,
"isPrivateLinkEndpointUrlRequired": false,

Examples API Version 2020-08-23 58

AmazonAppFlow API Reference

"logoURL": "insert-logo-here",
"registeredAt": null,
"registeredBy": null,
"supportedApiVersions": null,
"supportedDestinationConnectors":
[
"S3",
"Snowflake",
"Redshift",
"Salesforce",
"EventBridge",
"LookoutMetrics",
"Locke",
"Honeycode",
"Upsolver",
"CustomerProfiles",
"Zendesk",
"Marketo",
"CustomConnector"
],
"supportedOperators": null,
"supportedSchedulingFrequencies":
[
"BYMINUTE",
"HOURLY",
"DAILY",
"WEEKLY",
"MONTHLY",
"ONCE"
],
"supportedTriggerTypes":
[
"Scheduled",
"OnDemand",
"Event"
],
"supportedWriteOperations": null
}
}

Examples API Version 2020-08-23 59

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /describe-connector-entity HTTP/1.1

Content-type: application/json

{
"apiVersion": "string",
"connectorEntityName": "string",
"connectorProfileName": "string",
"connectorType": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

apiVersion

The version of the API that's used by the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorEntityName

The entity name for that connector.

Type: String

Length Constraints: Maximum length of 1024.

DescribeConnectorEntity API Version 2020-08-23 61

AmazonAppFlow API Reference

Pattern: \S+

Required: Yes
connectorProﬁleName

The name of the connector proﬁle. The name is unique for each ConnectorProfile in the
AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No
connectorType

The type of connector application, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorEntityFields": [
{
"customProperties": {
"string" : "string"
},
"defaultValue": "string",

Response Syntax API Version 2020-08-23 62

AmazonAppFlow API Reference

"description": "string",
"destinationProperties": {
"isCreatable": boolean,
"isDefaultedOnCreate": boolean,
"isNullable": boolean,
"isUpdatable": boolean,
"isUpsertable": boolean,
"supportedWriteOperations": [ "string" ]
},
"identifier": "string",
"isDeprecated": boolean,
"isPrimaryKey": boolean,
"label": "string",
"parentIdentifier": "string",
"sourceProperties": {
"isQueryable": boolean,
"isRetrievable": boolean,
"isTimestampFieldForIncrementalQueries": boolean
},
"supportedFieldTypeDetails": {
"v1": {
"fieldLengthRange": {
"maximum": number,
"minimum": number
},
"fieldType": "string",
"fieldValueRange": {
"maximum": number,
"minimum": number
},
"filterOperators": [ "string" ],
"supportedDateFormat": "string",
"supportedValues": [ "string" ],
"valueRegexPattern": "string"
}
}
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

Response Elements API Version 2020-08-23 63

AmazonAppFlow API Reference

The following data is returned in JSON format by the service.

connectorEntityFields

Describes the ﬁelds for that connector entity. For example, for an account entity, the ﬁelds
would be account name, account ID, and so on.

Type: Array of ConnectorEntityField objects

Errors

For information about the errors that are common to all actions, see Common Error Types.

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Errors API Version 2020-08-23 64

AmazonAppFlow API Reference

Examples

DescribeConnectorEntity example

This example shows a sample request and response for the DescribeConnectorEntity API

Sample Request

{
"connectorEntityName": "tickets",
"connectorProfileName": "connector_profile_name",
"connectorType": "Zendesk"
}

Sample Response

{
"connectorEntityFields": [
{
"description": "Account ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": [
"UPDATE",
"UPSERT"
]
},
"identifier": "Id",
"label": "Account ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "id",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []

Examples API Version 2020-08-23 65

AmazonAppFlow API Reference

}
}
},
{
"description": "Deleted",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "IsDeleted",
"label": "Deleted",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "boolean",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": [
"true",
"false"
]
}
}
},
{
"description": "Master Record ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "MasterRecordId",
"label": "Master Record ID",
"sourceProperties": {
"isQueryable": true,

Examples API Version 2020-08-23 66

AmazonAppFlow API Reference

"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Name",
"destinationProperties": {
"isCreatable": true,
"isNullable": false,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Name",
"label": "Account Name",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Type",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,

Examples API Version 2020-08-23 67

AmazonAppFlow API Reference

"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Type",
"label": "Account Type",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Parent Account ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ParentId",
"label": "Parent Account ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}

Examples API Version 2020-08-23 68

AmazonAppFlow API Reference

},
{
"description": "Billing Street",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingStreet",
"label": "Billing Street",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing City",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingCity",
"label": "Billing City",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",

Examples API Version 2020-08-23 69

AmazonAppFlow API Reference

"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing State/Province",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingState",
"label": "Billing State/Province",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Zip/Postal Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []

Examples API Version 2020-08-23 70

AmazonAppFlow API Reference

},
"identifier": "BillingPostalCode",
"label": "Billing Zip/Postal Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Country",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingCountry",
"label": "Billing Country",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}

Examples API Version 2020-08-23 71

AmazonAppFlow API Reference

}
},
{
"description": "Billing Latitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingLatitude",
"label": "Billing Latitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Longitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingLongitude",
"label": "Billing Longitude",
"sourceProperties": {

Examples API Version 2020-08-23 72

AmazonAppFlow API Reference

"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Billing Geocode Accuracy",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "BillingGeocodeAccuracy",
"label": "Billing Geocode Accuracy",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{

Examples API Version 2020-08-23 73

AmazonAppFlow API Reference

"description": "Billing Address",

"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "BillingAddress",
"label": "Billing Address",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "address",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Street",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingStreet",
"label": "Shipping Street",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [
"EQUAL_TO"

Examples API Version 2020-08-23 74

AmazonAppFlow API Reference

],
"supportedValues": []
}
}
},
{
"description": "Shipping City",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingCity",
"label": "Shipping City",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping State/Province",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingState",
"label": "Shipping State/Province",
"sourceProperties": {

Examples API Version 2020-08-23 75

AmazonAppFlow API Reference

"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Zip/Postal Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingPostalCode",
"label": "Shipping Zip/Postal Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Country",

Examples API Version 2020-08-23 76

AmazonAppFlow API Reference

"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingCountry",
"label": "Shipping Country",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Latitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingLatitude",
"label": "Shipping Latitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [

Examples API Version 2020-08-23 77

AmazonAppFlow API Reference

"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Longitude",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingLongitude",
"label": "Shipping Longitude",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Geocode Accuracy",
"destinationProperties": {

Examples API Version 2020-08-23 78

AmazonAppFlow API Reference

"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "ShippingGeocodeAccuracy",
"label": "Shipping Geocode Accuracy",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Shipping Address",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "ShippingAddress",
"label": "Shipping Address",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "address",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []

Examples API Version 2020-08-23 79

AmazonAppFlow API Reference

}
}
},
{
"description": "Account Phone",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Phone",
"label": "Account Phone",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "phone",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Fax",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Fax",
"label": "Account Fax",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {

Examples API Version 2020-08-23 80

AmazonAppFlow API Reference

"v1": {
"fieldType": "phone",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AccountNumber",
"label": "Account Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Website",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []

Examples API Version 2020-08-23 81

AmazonAppFlow API Reference

},
"identifier": "Website",
"label": "Website",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "url",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Photo URL",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "PhotoUrl",
"label": "Photo URL",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "url",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SIC Code",

Examples API Version 2020-08-23 82

AmazonAppFlow API Reference

"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Sic",
"label": "SIC Code",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Industry",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Industry",
"label": "Industry",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [

Examples API Version 2020-08-23 83

AmazonAppFlow API Reference

"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Annual Revenue",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AnnualRevenue",
"label": "Annual Revenue",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "currency",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Employees",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NumberOfEmployees",
"label": "Employees",
"sourceProperties": {
"isQueryable": true,

Examples API Version 2020-08-23 84

AmazonAppFlow API Reference

"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "int",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Ownership",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Ownership",
"label": "Ownership",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Ticker Symbol",

Examples API Version 2020-08-23 85

AmazonAppFlow API Reference

"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "TickerSymbol",
"label": "Ticker Symbol",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Description",
"label": "Account Description",
"sourceProperties": {
"isQueryable": false,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "textarea",
"filterOperators": [

Examples API Version 2020-08-23 86

AmazonAppFlow API Reference

"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Rating",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Rating",
"label": "Account Rating",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Site",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Site",
"label": "Account Site",
"sourceProperties": {
"isQueryable": true,

Examples API Version 2020-08-23 87

AmazonAppFlow API Reference

"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Owner ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": false,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "OwnerId",
"label": "Owner ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Created Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,

Examples API Version 2020-08-23 88

AmazonAppFlow API Reference

"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "CreatedDate",
"label": "Created Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Created By ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "CreatedById",
"label": "Created By ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [

Examples API Version 2020-08-23 89

AmazonAppFlow API Reference

"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Last Modified Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastModifiedDate",
"label": "Last Modified Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Modified By ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []

Examples API Version 2020-08-23 90

AmazonAppFlow API Reference

},
"identifier": "LastModifiedById",
"label": "Last Modified By ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "System Modstamp",
"destinationProperties": {
"isCreatable": false,
"isNullable": false,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "SystemModstamp",
"label": "System Modstamp",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []

Examples API Version 2020-08-23 91

AmazonAppFlow API Reference

}
}
},
{
"description": "Last Activity",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastActivityDate",
"label": "Last Activity",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "date",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Viewed Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastViewedDate",
"label": "Last Viewed Date",

Examples API Version 2020-08-23 92

AmazonAppFlow API Reference

"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "Last Referenced Date",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "LastReferencedDate",
"label": "Last Referenced Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "datetime",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"

Examples API Version 2020-08-23 93

AmazonAppFlow API Reference

],
"supportedValues": []
}
}
},
{
"description": "[Link] Key",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Jigsaw",
"label": "[Link] Key",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Jigsaw Company ID",
"destinationProperties": {
"isCreatable": false,
"isNullable": true,
"isUpdatable": false,
"isUpsertable": false,
"supportedWriteOperations": []
},
"identifier": "JigsawCompanyId",
"label": "Jigsaw Company ID",
"sourceProperties": {

Examples API Version 2020-08-23 94

AmazonAppFlow API Reference

"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Clean Status",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "CleanStatus",
"label": "Clean Status",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Account Source",
"destinationProperties": {
"isCreatable": true,

Examples API Version 2020-08-23 95

AmazonAppFlow API Reference

"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "AccountSource",
"label": "Account Source",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "D-U-N-S Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "DunsNumber",
"label": "D-U-N-S Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],

Examples API Version 2020-08-23 96

AmazonAppFlow API Reference

"supportedValues": []
}
}
},
{
"description": "Tradestyle",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Tradestyle",
"label": "Tradestyle",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "NAICS Code",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NaicsCode",
"label": "NAICS Code",
"sourceProperties": {
"isQueryable": true,

Examples API Version 2020-08-23 97

AmazonAppFlow API Reference

"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "NAICS Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NaicsDesc",
"label": "NAICS Description",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Year Started",
"destinationProperties": {

Examples API Version 2020-08-23 98

AmazonAppFlow API Reference

"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "YearStarted",
"label": "Year Started",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SIC Description",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SicDesc",
"label": "SIC Description",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",

Examples API Version 2020-08-23 99

AmazonAppFlow API Reference

"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "D&B Company ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "DandbCompanyId",
"label": "D&B Company ID",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Operating Hour ID",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "OperatingHoursId",
"label": "Operating Hour ID",
"sourceProperties": {

Examples API Version 2020-08-23 100

AmazonAppFlow API Reference

"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "reference",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Customer Priority",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "CustomerPriority__c",
"label": "Customer Priority",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,

Examples API Version 2020-08-23 101

AmazonAppFlow API Reference

"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLA__c",
"label": "SLA",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Active",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "Active__c",
"label": "Active",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},

Examples API Version 2020-08-23 102

AmazonAppFlow API Reference

{
"description": "Number of Locations",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "NumberofLocations__c",
"label": "Number of Locations",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "double",
"filterOperators": [
"NOT_EQUAL_TO",
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "Upsell Opportunity",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "UpsellOpportunity__c",
"label": "Upsell Opportunity",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true

Examples API Version 2020-08-23 103

AmazonAppFlow API Reference

},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "picklist",
"filterOperators": [
"EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA Serial Number",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLASerialNumber__c",
"label": "SLA Serial Number",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",
"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
},
{
"description": "SLA Expiration Date",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,

Examples API Version 2020-08-23 104

AmazonAppFlow API Reference

"isUpsertable": true,
"supportedWriteOperations": []
},
"identifier": "SLAExpirationDate__c",
"label": "SLA Expiration Date",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "date",
"filterOperators": [
"EQUAL_TO",
"LESS_THAN",
"LESS_THAN_OR_EQUAL_TO",
"GREATER_THAN",
"GREATER_THAN_OR_EQUAL_TO",
"BETWEEN"
],
"supportedValues": []
}
}
},
{
"description": "extId",
"destinationProperties": {
"isCreatable": true,
"isNullable": true,
"isUpdatable": true,
"isUpsertable": true,
"supportedWriteOperations": [
"UPSERT"
]
},
"identifier": "extId__c",
"label": "extId",
"sourceProperties": {
"isQueryable": true,
"isRetrievable": true
},
"supportedFieldTypeDetails": {
"v1": {
"fieldType": "string",

Examples API Version 2020-08-23 105

AmazonAppFlow API Reference

"filterOperators": [
"CONTAINS",
"EQUAL_TO",
"NOT_EQUAL_TO"
],
"supportedValues": []
}
}
}
]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /describe-connector-profiles HTTP/1.1

Content-type: application/json

{
"connectorLabel": "string",
"connectorProfileNames": [ "string" ],
"connectorType": "string",
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

connectorLabel

The name of the connector. The name is unique for each ConnectorRegistration in your
AWS account. Only needed if calling for CUSTOMCONNECTOR connector type/.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No

DescribeConnectorProﬁles API Version 2020-08-23 107

AmazonAppFlow API Reference

connectorProﬁleNames

The name of the connector proﬁle. The name is unique for each ConnectorProfile in the
AWS account.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No
connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
maxResults

Speciﬁes the maximum number of items that should be returned in the result set. The default
for maxResults is 20 (for all paginated API operations).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Request Body API Version 2020-08-23 108

AmazonAppFlow API Reference

Pattern: \S+

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorProfileDetails": [
{
"connectionMode": "string",
"connectorLabel": "string",
"connectorProfileArn": "string",
"connectorProfileName": "string",
"connectorProfileProperties": {
"Amplitude": {
},
"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"

Response Syntax API Version 2020-08-23 109

AmazonAppFlow API Reference

},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",
"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},
"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"ServiceNow": {
"instanceUrl": "string"
},
"Singular": {
},

Response Syntax API Version 2020-08-23 110

AmazonAppFlow API Reference

"Slack": {
"instanceUrl": "string"
},
"Snowflake": {
"accountName": "string",
"bucketName": "string",
"bucketPrefix": "string",
"privateLinkServiceName": "string",
"region": "string",
"stage": "string",
"warehouse": "string"
},
"Trendmicro": {
},
"Veeva": {
"instanceUrl": "string"
},
"Zendesk": {
"instanceUrl": "string"
}
},
"connectorType": "string",
"createdAt": number,
"credentialsArn": "string",
"lastUpdatedAt": number,
"privateConnectionProvisioningState": {
"failureCause": "string",
"failureMessage": "string",
"status": "string"
}
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorProﬁleDetails

Returns information about the connector proﬁles associated with the ﬂow.

Response Elements API Version 2020-08-23 111

AmazonAppFlow API Reference

Type: Array of ConnectorProﬁle objects

nextToken

The pagination token for the next page of data. If nextToken=null, this means that all
records have been fetched.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

DescribeConnectorProﬁles example

This example shows a sample request and response for the DescribeConnectorProfiles API.

Sample Request

{
"connectorProfileNames": ["OldMarketoProfile","non-existing-name"],
"connectorTypes": ["Marketo","Salesforce"]
}

Errors API Version 2020-08-23 112

AmazonAppFlow API Reference

Sample Response

{
"connectorProfileDetails": [
{
"arn": "arn:aws:appflow:region:<AccountId>:connectorprofile/OldMarketoProfile",
"configuration": {
"api_version": "v1",
"connection_mode": "Public",
"credentials_arn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
"instanceUrl": "MarketoUrl"
},
"connectionMode": "Public",
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
OldMarketoProfile",
"connectorProfileName": "OldMarketoProfile",
"connectorProfileProps": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": {
"apiVersion": "v1",
"instanceUrl": "MarketoUrl"
},
"Redshift": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorType": "Marketo",
"createdAt": "created_at_value",
"credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
"label": "OldMarketoProfile",
"lastUpdated": "lastupdated_value",
"lastUpdatedAt": "lastupdated_at_value"
}
],

Examples API Version 2020-08-23 113

AmazonAppFlow API Reference

"nextToken": null
}

DescribeConnectorProﬁles example

This example shows a sample request and response for the DescribeConnectorProfiles API.

Sample Request

{
"connectorProfileNames": ["OldMarketoProfile", "non-existing-name"],
"connectorTypes": ["Marketo", "Salesforce", "CustomConnector"],
"connectorLabel": "MyCustomConnectorLabel"
}

Sample Response

Examples API Version 2020-08-23 114

AmazonAppFlow API Reference

},
"Redshift": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorType": "Marketo",
"createdAt": "2022-02-22T15:31:41.467000-08:00",
"credentialsArn": "arn:aws:secretsmanager:region:<AccountId>:secret:<secret>",
"label": "OldMarketoProfile",
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00"
}
],
"nextToken": null
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /describe-connectors HTTP/1.1

Content-type: application/json

{
"connectorTypes": [ "string" ],
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

connectorTypes

The type of connector, such as Salesforce, Amplitude, and so on.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

DescribeConnectors API Version 2020-08-23 116

AmazonAppFlow API Reference

Required: No
maxResults

The maximum number of items that should be returned in the result set. The default is 20.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorConfigurations": {
"string" : {
"authenticationConfig": {
"customAuthConfigs": [
{
"authParameters": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string"
}
],

Response Syntax API Version 2020-08-23 117

AmazonAppFlow API Reference

"customAuthenticationType": "string"
}
],
"isApiKeyAuthSupported": boolean,
"isBasicAuthSupported": boolean,
"isCustomAuthSupported": boolean,
"isOAuth2Supported": boolean,
"oAuth2Defaults": {
"authCodeUrls": [ "string" ],
"oauth2CustomProperties": [
{
"connectorSuppliedValues": [ "string" ],
"description": "string",
"isRequired": boolean,
"isSensitiveField": boolean,
"key": "string",
"label": "string",
"type": "string"
}
],
"oauth2GrantTypesSupported": [ "string" ],
"oauthScopes": [ "string" ],
"tokenUrls": [ "string" ]
}
},
"canUseAsDestination": boolean,
"canUseAsSource": boolean,
"connectorArn": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorMetadata": {
"Amplitude": {
},
"CustomerProfiles": {
},
"Datadog": {
},
"Dynatrace": {
},
"EventBridge": {
},
"GoogleAnalytics": {
"oAuthScopes": [ "string" ]
},

Response Syntax API Version 2020-08-23 118

AmazonAppFlow API Reference

"Honeycode": {
"oAuthScopes": [ "string" ]
},
"InforNexus": {
},
"Marketo": {
},
"Pardot": {
},
"Redshift": {
},
"S3": {
},
"Salesforce": {
"dataTransferApis": [ "string" ],
"oauth2GrantTypesSupported": [ "string" ],
"oAuthScopes": [ "string" ]
},
"SAPOData": {
},
"ServiceNow": {
},
"Singular": {
},
"Slack": {
"oAuthScopes": [ "string" ]
},
"Snowflake": {
"supportedRegions": [ "string" ]
},
"Trendmicro": {
},
"Upsolver": {
},
"Veeva": {
},
"Zendesk": {
"oAuthScopes": [ "string" ]
}
},
"connectorModes": [ "string" ],
"connectorName": "string",
"connectorOwner": "string",
"connectorProvisioningConfig": {

Response Syntax API Version 2020-08-23 119

AmazonAppFlow API Reference

"lambda": {
"lambdaArn": "string"
}
},
"connectorProvisioningType": "string",
"connectorRuntimeSettings": [
{
"connectorSuppliedValueOptions": [ "string" ],
"dataType": "string",
"description": "string",
"isRequired": boolean,
"key": "string",
"label": "string",
"scope": "string"
}
],
"connectorType": "string",
"connectorVersion": "string",
"isPrivateLinkEnabled": boolean,
"isPrivateLinkEndpointUrlRequired": boolean,
"logoURL": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedApiVersions": [ "string" ],
"supportedDataTransferApis": [
{
"Name": "string",
"Type": "string"
}
],
"supportedDataTransferTypes": [ "string" ],
"supportedDestinationConnectors": [ "string" ],
"supportedOperators": [ "string" ],
"supportedSchedulingFrequencies": [ "string" ],
"supportedTriggerTypes": [ "string" ],
"supportedWriteOperations": [ "string" ]
}
},
"connectors": [
{
"applicationType": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorModes": [ "string" ],

Response Syntax API Version 2020-08-23 120

AmazonAppFlow API Reference

"connectorName": "string",
"connectorOwner": "string",
"connectorProvisioningType": "string",
"connectorType": "string",
"connectorVersion": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedDataTransferTypes": [ "string" ]
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorConﬁgurations

The conﬁguration that is applied to the connectors used in the ﬂow.

Type: String to ConnectorConﬁguration object map

Valid Keys: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Information about the connectors supported in Amazon AppFlow.

Type: Array of ConnectorDetail objects

nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Response Elements API Version 2020-08-23 121

AmazonAppFlow API Reference

Pattern: \S+

Errors
For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

DescribeConnectors example

This example shows a sample request and response for the DescribeConnectors API using
Marketo and Salesforce. The second sample shows how to proceed if you receive nextToken.

Sample Request

{
"connectorTypes": ["Marketo","Salesforce"]
}

{
"connectorTypes": ["Marketo","Salesforce"],
"nextToken": "nextToken_value"
}

Sample Response

{
"connectorConfigurations": {
"Marketo": {

Errors API Version 2020-08-23 122

AmazonAppFlow API Reference

"canUseAsDestination": false,
"canUseAsSource": true,
"compatibleConnectors": [
"S3",
"Snowflake",
"Salesforce",
"Redshift"
],
"connectorMetadata": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": {},
"Redshift": null,
"S3": null,
"Salesforce": null,
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorSpecificConfiguration": {
"api_version": "v1"
},
"credentialKeys": [
"accessToken",
"clientId",
"clientSecret"
],
"displayName": "Marketo",
"hasLogoImage": false,
"isPrivateLinkEnabled": false,
"isPrivateLinkEndpointUrlRequired": false,
"privateLinkEndpointServiceUrl": null,
"supportedDestinationConnectors": [
"S3",
"Snowflake",
"Salesforce",
"Redshift"

Examples API Version 2020-08-23 123

AmazonAppFlow API Reference

],
"supportedFrequencies": [
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedRegions": null,
"supportedSchedulingFrequencies": [
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedTriggerTypes": [
"Scheduled",
"OnDemand"
],
"supportedTriggers": [
"Scheduled",
"OnDemand"
]
},
"Salesforce": {
"canUseAsDestination": true,
"canUseAsSource": true,
"compatibleConnectors": [
"S3",
"Snowflake",
"Redshift",
"Salesforce"
],
"connectorMetadata": {
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": null,
"Redshift": null,
"S3": null,
"Salesforce": {

Examples API Version 2020-08-23 124

AmazonAppFlow API Reference

"authScopes": [
"api",
"refresh_token",
"id"
]
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
},
"connectorSpecificConfiguration": {
"api_version": "v47.0",
"auth_scopes": "[api, refresh_token, id]",
"bulk_api_path": "services/data",
"query_api_path": "query",
"sobject_api_path": "sobjects"
},
"credentialKeys": [
"accessToken",
"refreshToken",
"clientId",
"clientSecret"
],
"displayName": "Salesforce",
"hasLogoImage": false,
"isPrivateLinkEnabled": false,
"isPrivateLinkEndpointUrlRequired": false,
"privateLinkEndpointServiceUrl": null,
"supportedDestinationConnectors": [
"S3",
"Snowflake",
"Redshift",
"Salesforce"
],
"supportedFrequencies": [
"Minute",
"Hour",
"Day",
"Week",
"Month",

Examples API Version 2020-08-23 125

AmazonAppFlow API Reference

"Once"
],
"supportedRegions": null,
"supportedSchedulingFrequencies": [
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Once"
],
"supportedTriggerTypes": [
"Scheduled",
"OnDemand",
"Event"
],
"supportedTriggers": [
"Scheduled",
"OnDemand",
"Event"
]
}
},
"nextToken": null,
"pageToken": null
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

POST /describe-flow HTTP/1.1

Content-type: application/json

{
"flowName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"createdAt": number,
"createdBy": "string",
"description": "string",

DescribeFlow API Version 2020-08-23 128

AmazonAppFlow API Reference

"destinationFlowConfigList": [
{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"destinationConnectorProperties": {
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"entityName": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"writeOperationType": "string"
},
"CustomerProfiles": {
"domainName": "string",
"objectTypeName": "string"
},
"EventBridge": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",

Response Syntax API Version 2020-08-23 129

AmazonAppFlow API Reference

"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}
},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {

Response Syntax API Version 2020-08-23 130

AmazonAppFlow API Reference

"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean

Response Syntax API Version 2020-08-23 131

AmazonAppFlow API Reference

},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowArn": "string",
"flowName": "string",
"flowStatus": "string",
"flowStatusMessage": "string",
"kmsArn": "string",
"lastRunExecutionDetails": {
"mostRecentExecutionMessage": "string",
"mostRecentExecutionStatus": "string",
"mostRecentExecutionTime": number
},
"lastRunMetadataCatalogDetails": [
{
"catalogType": "string",
"partitionRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
},
"tableName": "string",
"tableRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
}
}
],
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"schemaVersion": number,

Response Syntax API Version 2020-08-23 132

AmazonAppFlow API Reference

"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"CustomConnector": {
"customProperties": {
"string" : "string"
},
"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"entityName": "string"
},
"Datadog": {
"object": "string"
},
"Dynatrace": {
"object": "string"
},
"GoogleAnalytics": {
"object": "string"
},
"InforNexus": {
"object": "string"
},
"Marketo": {
"object": "string"
},
"Pardot": {
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3InputFormatConfig": {
"s3InputFileType": "string"

Response Syntax API Version 2020-08-23 133

AmazonAppFlow API Reference

}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number
}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tags": {
"string" : "string"
},

Response Syntax API Version 2020-08-23 134

AmazonAppFlow API Reference

"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",
"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",
"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}

Response Syntax API Version 2020-08-23 135

AmazonAppFlow API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

createdAt

Speciﬁes when the ﬂow was created.

Type: Timestamp
createdBy

The ARN of the user who created the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+
description

A description of the ﬂow.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*
destinationFlowConﬁgList

The conﬁguration that controls how Amazon AppFlow transfers data to the destination
connector.

Type: Array of DestinationFlowConﬁg objects

ﬂowArn

The ﬂow's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 512.

Response Elements API Version 2020-08-23 136

AmazonAppFlow API Reference

Pattern: arn:aws:appflow:.*:[0-9]+:.*
ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+
ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

ﬂowStatusMessage

Contains an error message if the ﬂow status is in a suspended or error state. This applies only to
scheduled or event-triggered ﬂows.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\s\w/!@#+=.-]*
kmsArn

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:kms:.*:[0-9]+:.*
lastRunExecutionDetails

Describes the details of the most recent ﬂow run.

Response Elements API Version 2020-08-23 137

AmazonAppFlow API Reference

Type: ExecutionDetails object

lastRunMetadataCatalogDetails

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow
used for the associated ﬂow run.

Type: Array of MetadataCatalogDetail objects

lastUpdatedAt

Speciﬁes when the ﬂow was last updated.

Type: Timestamp
lastUpdatedBy

Speciﬁes the user name of the account that performed the most recent update.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+
metadataCatalogConﬁg

Type: MetadataCatalogConﬁg object

schemaVersion

The version number of your data schema. Amazon AppFlow assigns this version number. The
version number increases by one when you change any of the following settings in your flow
configuration:
• Source-to-destination field mappings
• Field data types
• Partition keys

Type: Long
sourceFlowConﬁg

The conﬁguration that controls how Amazon AppFlow retrieves data from the source connector.

Response Elements API Version 2020-08-23 138

AmazonAppFlow API Reference

Type: SourceFlowConﬁg object

tags

The tags used to organize, track, or control access for your ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\w+-=\.:/@]*

tasks

A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run.

Type: Array of Task objects

triggerConﬁg

The trigger settings that determine how and when the ﬂow runs.

Type: TriggerConﬁg object

Errors
For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

Errors API Version 2020-08-23 139

AmazonAppFlow API Reference

Examples

DescribeFlow example

This example shows a sample request and response for the DescribeFlow API.

Sample Request

{
"flowName": "name"
}

Sample Response

{
"createdAt": "2022-02-22T15:31:41.467000-08:00",
"createdBy": "user",
"description": null,
"destinationFlowConfigList": [
{
"aggregationConfig": null,
"connectorProfileName": "connector_profile_name",
"connectorType": "S3",
"destinationConnectorProps":
{
"Redshift": null,
"S3":
{
"bucketKey": null,
"bucketName": "salesforceaccountflowbucket"
},
"Salesforce": null,
"Snowflake": null
}
}
],
"flowArn": "flow_arn_value",
"flowName": "test_flow_ondemand_10",
"flowStatus": "Active",
"flowStatusMessage": null,
"kmsArn": null,
"lastRunExecutionDetails": null,
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00",

Examples API Version 2020-08-23 140

AmazonAppFlow API Reference

"lastUpdatedBy": "user",
"sourceFlowConfig":
{
"connectorProfileName": "connectorProfileName",
"connectorType": "Salesforce",
"sourceConnectorProps":
{
"Amplitude": null,
"Datadog": null,
"Dynatrace": null,
"GoogleAnalytics": null,
"InforNexus": null,
"Marketo": null,
"Redshift": null,
"S3": null,
"Salesforce":
{
"object": "Account"
},
"ServiceNow": null,
"Singular": null,
"Slack": null,
"Snowflake": null,
"Trendmicro": null,
"Veeva": null,
"Zendesk": null
}
},
"tags":
{
"internalId": "Internal_Id_value",
"resourceArn": "resource_arn_value"
},
"tasks": [
{
"connectorOperator": null,
"destinationField": "Id",
"operator": "NO_OP",
"sourceFields": ["Id"],
"taskProperties":
{
"DESTINATION_DATA_TYPE": "id",
"SOURCE_DATA_TYPE": "id"
},

Examples API Version 2020-08-23 141

AmazonAppFlow API Reference

"taskType": "Mapping"
},
{
"connectorOperator": null,
"destinationField": "Name",
"operator": "NO_OP",
"sourceFields": ["Name"],
"taskProperties":
{
"DESTINATION_DATA_TYPE": "string",
"SOURCE_DATA_TYPE": "string"
},
"taskType": "Mapping"
},
{
"connectorOperator": null,
"destinationField": null,
"operator": "PROJECTION",
"sourceFields": ["Id","Name"],
"taskProperties":
{},
"taskType": "Filtering"
}
],
"triggerConfig":
{
"triggerProps":
{
"ScheduledTriggerProps": null
},
"triggerType": "OnDemand"
}
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /describe-flow-execution-records HTTP/1.1

Content-type: application/json

{
"flowName": "string",
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes
maxResults

Speciﬁes the maximum number of items that should be returned in the result set. The default
for maxResults is 20 (for all paginated API operations).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

DescribeFlowExecutionRecords API Version 2020-08-23 144

AmazonAppFlow API Reference

Required: No
nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"flowExecutions": [
{
"dataPullEndTime": number,
"dataPullStartTime": number,
"executionId": "string",
"executionResult": {
"bytesProcessed": number,
"bytesWritten": number,
"errorInfo": {
"executionMessage": "string",
"putFailuresCount": number
},
"maxPageSize": number,
"numParallelProcesses": number,
"recordsProcessed": number
},
"executionStatus": "string",
"lastUpdatedAt": number,
"metadataCatalogDetails": [
{
"catalogType": "string",
"partitionRegistrationOutput": {
"message": "string",

Response Syntax API Version 2020-08-23 145

AmazonAppFlow API Reference

"result": "string",
"status": "string"
},
"tableName": "string",
"tableRegistrationOutput": {
"message": "string",
"result": "string",
"status": "string"
}
}
],
"startedAt": number
}
],
"nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ﬂowExecutions

Returns a list of all instances when this ﬂow was run.

Type: Array of ExecutionRecord objects

nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Error Types.

Response Elements API Version 2020-08-23 146

AmazonAppFlow API Reference

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

DescribeFlowExecutionRecords examples

This example shows sample requests and responses for the DescribeFlowExecutionRecords
API.

Sample Request

{
"flowName": "name",
"maxResults": 1
}

Sample Response

{
"flowExecutionList": [
{
"executionId": "Execution_ID",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId:
RequestId_value",
"executionMetadata":

Examples API Version 2020-08-23 147

AmazonAppFlow API Reference

{
"bytesProcessed": 234,
"bytesWritten": 0,
"numFailures": 878,
"numFilteredRecords": 0,
"numPutFailures": 978978,
"reason": null,
"recordsProcessed": 23342,
"terminateFlow": false
},
"executionResult":
{
"bytesProcessed": 234,
"bytesWritten": 0,
"errorInfo":
{
"executionMessage": "Request failed with Trendmicro Status Code 404: ,
RequestId: RequestId_value",
"putFailuresCount": 978978
},
"recordsProcessed": 23342
},
"executionStartTime": "2022-02-22T15:31:41.467000-08:00",
"executionStatus": "Error",
"lastUpdatedAt": "2022-02-22T15:31:41.467000-08:00",
"startedAt": "2022-02-22T15:31:41.467000-08:00"
}
],
"nextToken": "next_token_value"
}

Sample Request

{
"flowName": "test-new-create",
"maxResults": 1,
"nextToken": "next_token_value"
}

Sample Response

{
"flowExecutionList": [

Examples API Version 2020-08-23 148

AmazonAppFlow API Reference

{
"executionId": "execution_id_value",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId:
RequestId_value",
"executionMetadata": {
"bytesProcessed": 234,
"bytesWritten": 0,
"numFailures": 0,
"numFilteredRecords": 0,
"numPutFailures": 0,
"reason": null,
"recordsProcessed": 23342,
"terminateFlow": false
},
"executionResult": {
"bytesProcessed": 234,
"bytesWritten": 0,
"errorInfo": null,
"recordsProcessed": 23342
},
"executionStartTime": "execution_start_time_value",
"executionStatus": "Successful",
"lastUpdatedAt": "lastupdated_at_value",
"lastUpdatedTime": "lastupdated_time_value",
"startedAt": "started_at_value"
}
],
"nextToken": "next_token_value"
}

Sample Request

{
"flowName": "name",
"maxResults": 1,
"nextToken": "next_token_value"
}

Sample Response

{
"flowExecutionList": [
{

Examples API Version 2020-08-23 149

AmazonAppFlow API Reference

"executionId": "execution_id_value-delete",
"executionMessage": "Request failed with Trendmicro Status Code 404: , RequestId:
RequestId_value",
"executionMetadata": {
"bytesProcessed": 0,
"bytesWritten": 0,
"numFailures": 0,
"numFilteredRecords": 0,
"numPutFailures": 0,
"reason": null,
"recordsProcessed": 0,
"terminateFlow": false
},
"executionResult": {
"bytesProcessed": 0,
"bytesWritten": 0,
"errorInfo": {
"executionMessage": "Request failed with Trendmicro Status Code 404: ,
RequestId: RequestId_value",
"putFailuresCount": 0
},
"recordsProcessed": 0
},
"executionStartTime": "execution_start_time_value",
"executionStatus": "Error",
"lastUpdatedAt": "lastupdated_at_value",
"lastUpdatedTime": "lastupdated_time_value",
"startedAt": "started_at_value"
}
],
"nextToken": "next_token_value"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /list-connector-entities HTTP/1.1

Content-type: application/json

{
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"entitiesPath": "string",
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

apiVersion

The version of the API that's used by the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No

ListConnectorEntities API Version 2020-08-23 152

AmazonAppFlow API Reference

connectorProﬁleName

The name of the connector proﬁle. The name is unique for each ConnectorProfile in the
AWS account, and is used to query the downstream connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No
connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
entitiesPath

This optional parameter is speciﬁc to connector implementation. Some connectors support

multiple levels or categories of entities. You can ﬁnd out the list of roots for such providers by
sending a request without the entitiesPath parameter. If the connector supports entities at
diﬀerent roots, this initial request returns the list of roots. Otherwise, this request returns all
entities supported by the provider.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\s\w/!@#+=,.-]*

Required: No
maxResults

The maximum number of items that the operation returns in the response.

Request Body API Version 2020-08-23 153

AmazonAppFlow API Reference

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No
nextToken

A token that was provided by your prior ListConnectorEntities operation if the response
was too big for the page size. You specify this token to get the next page of results in paginated
response.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorEntityMap": {
"string" : [
{
"hasNestedEntities": boolean,
"label": "string",
"name": "string"
}
]
},
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Response Syntax API Version 2020-08-23 154

AmazonAppFlow API Reference

connectorEntityMap

The response of ListConnectorEntities lists entities grouped by category. This map's key
represents the group name, and its value contains the list of entities belonging to that group.

Type: String to array of ConnectorEntity objects map

Key Length Constraints: Maximum length of 128.

Key Pattern: \S+

nextToken

A token that you specify in your next ListConnectorEntities operation to get the next
page of results in paginated response. The ListConnectorEntities operation provides this
token if the response is too big for the page size.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

Errors API Version 2020-08-23 155

AmazonAppFlow API Reference

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

ListConnectorEntities example

This example shows sample requests and a sample response for the ListConnectorEntities
API. The second sample request shows a request without the optional connectorType).

Sample Request

{
"connectorType": "Slack",
"connectorProfileName": "vmSlackProfile"
}

Sample Request

{
"connectorProfileName": "vmSlackProfile"
}

Sample Response

{
"connectorEntityMap":
{
"Objects":
[
{"hasNestedEntities": true,
"label": "Conversations","name": "conversations"}

Examples API Version 2020-08-23 156

AmazonAppFlow API Reference

]
}
}

Sample Request

{
"connectorProfileName": "vmSlackProfile",
"connectorType": "Slack",
"entitiesPath": "conversations"
}

Sample Response

{
"connectorEntityMap":
{
"Channels": [
{
"hasNestedEntities": false,
"label": "new-to-slack",
"name": "conversations/CQCFDC534"
},
{
"hasNestedEntities": false,
"label": "advising",
"name": "conversations/CQDSNS2AX"
},
{
"hasNestedEntities": false,
"label": "general",
"name": "conversations/CQTFBK48N"
},
{
"hasNestedEntities": false,
"label": "random",
"name": "conversations/CQTFBK6CE"
},
{
"hasNestedEntities": false,
"label": "investing",
"name": "conversations/CQTFBKDT8"
},

Examples API Version 2020-08-23 157

AmazonAppFlow API Reference

{
"hasNestedEntities": false,
"label": "memories",
"name": "conversations/CS44VCEC9"
},
{
"hasNestedEntities": false,
"label": "home-of-nyc",
"name": "conversations/CV84P3D7A"
},
{
"hasNestedEntities": false,
"label": "marketing",
"name": "conversations/C012DDQRU95"
},
{
"hasNestedEntities": false,
"label": "home-of-phi",
"name": "conversations/C012DTFRBL7"
},
{
"hasNestedEntities": false,
"label": "home-of-philadelphia",
"name": "conversations/C012N003VU6"
},
{
"hasNestedEntities": false,
"label": "lol",
"name": "conversations/C012NJTMZEJ"
},
{
"hasNestedEntities": false,
"label": "home-of-atlanta",
"name": "conversations/C012P2739BQ"
},
{
"hasNestedEntities": false,
"label": "it-support",
"name": "conversations/C012SRQMLRH"
},
{
"hasNestedEntities": false,
"label": "home-of-nashville",
"name": "conversations/C012U9TM5DZ"

Examples API Version 2020-08-23 158

AmazonAppFlow API Reference

},
{
"hasNestedEntities": false,
"label": "home-of-texas",
"name": "conversations/C012VHLB63X"
},
{
"hasNestedEntities": false,
"label": "data",
"name": "conversations/C012Z3VMA7N"
},
{
"hasNestedEntities": false,
"label": "home-of-san-francisco",
"name": "conversations/C01308U07HA"
},
{
"hasNestedEntities": false,
"label": "slack-feedback",
"name": "conversations/C0131PCV93N"
},
{
"hasNestedEntities": false,
"label": "home-of-seattle",
"name": "conversations/C0136MRRQHX"
},
{
"hasNestedEntities": false,
"label": "operations",
"name": "conversations/C0136QPJ1KK"
},
{
"hasNestedEntities": false,
"label": "product",
"name": "conversations/C0137S730KT"
},
{
"hasNestedEntities": false,
"label": "dev",
"name": "conversations/C013HUHSRGQ"
},
{
"hasNestedEntities": false,
"label": "infra",

Examples API Version 2020-08-23 159

AmazonAppFlow API Reference

"name": "conversations/C013KP5TQ2J"
},
{
"hasNestedEntities": false,
"label": "pets",
"name": "conversations/C013NTC2L0G"
},
{
"hasNestedEntities": false,
"label": "founders",
"name": "conversations/C014M9JBWCU"
}
]
}
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /list-connectors HTTP/1.1

Content-type: application/json

{
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

maxResults

Speciﬁes the maximum number of items that should be returned in the result set. The default
for maxResults is 20 (for all paginated API operations).

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The pagination token for the next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

ListConnectors API Version 2020-08-23 161

AmazonAppFlow API Reference

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectors": [
{
"applicationType": "string",
"connectorDescription": "string",
"connectorLabel": "string",
"connectorModes": [ "string" ],
"connectorName": "string",
"connectorOwner": "string",
"connectorProvisioningType": "string",
"connectorType": "string",
"connectorVersion": "string",
"registeredAt": number,
"registeredBy": "string",
"supportedDataTransferTypes": [ "string" ]
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectors

Contains information about the connectors supported by Amazon AppFlow.

Type: Array of ConnectorDetail objects

nextToken

The pagination token for the next page of data. If nextToken=null, this means that all records
have been fetched.

Response Syntax API Version 2020-08-23 162

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors
For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples
Listing connectors

This example shows a sample request for the ListConnector API and a sample response.

Sample Request

{
"maxResults": 1,
"nextToken": "nextToken_value"
}

Sample Response

{
"connectors":
[
{
"connectorArn": "Arn of connector1",
"connectorDescription": "Some Sample Connector1",

Errors API Version 2020-08-23 163

AmazonAppFlow API Reference

"connectorName": "Salesforce custom connector1",

"connectorOwner": "AppFlow",
"connectorVersion": "1.0",
"applicationType": "Salesforce",
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"registeredAt": 1628732168.132,
"registeredBy": "CUSTOM",
"tags": null,
"connectorModes":
[
"SOURCE",
"DESTINATION"
],
"connectorProvisioningType": "LAMBDA"
},
{
"connectorArn": "Arn of connector2",
"connectorDescription": "Some Sample Connector2",
"connectorName": "Salesforce custom connector2",
"connectorOwner": "AppFlow",
"connectorVersion": "1.0",
"applicationType": "Salesforce",
"connectorType": "CUSTOMCONNECTOR",
"connectorLabel": "MyCustomConnector",
"registeredAt": 1628732168.132,
"registeredBy": "CUSTOM",
"tags": null,
"connectorModes":
[
"SOURCE",
"DESTINATION"
],
"connectorProvisioningType": "LAMBDA"
}
],
"nextToken": null
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /list-flows HTTP/1.1

Content-type: application/json

{
"maxResults": number,
"nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

maxResults

Speciﬁes the maximum number of items that should be returned in the result set.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The pagination token for next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

ListFlows API Version 2020-08-23 166

AmazonAppFlow API Reference

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"flows": [
{
"createdAt": number,
"createdBy": "string",
"description": "string",
"destinationConnectorLabel": "string",
"destinationConnectorType": "string",
"flowArn": "string",
"flowName": "string",
"flowStatus": "string",
"lastRunExecutionDetails": {
"mostRecentExecutionMessage": "string",
"mostRecentExecutionStatus": "string",
"mostRecentExecutionTime": number
},
"lastUpdatedAt": number,
"lastUpdatedBy": "string",
"sourceConnectorLabel": "string",
"sourceConnectorType": "string",
"tags": {
"string" : "string"
},
"triggerType": "string"
}
],
"nextToken": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ﬂows

The list of ﬂows associated with your account.

Response Syntax API Version 2020-08-23 167

AmazonAppFlow API Reference

Type: Array of FlowDeﬁnition objects

nextToken

The pagination token for next page of data.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

ListFlows examples

This example shows a sample request for the ListFlows API. In the second sample, note that
MaxResults will show a number between 1 and 100.

Sample Request

{
"flowList": [
{
"createdAt": "created_time_value",

Errors API Version 2020-08-23 168

AmazonAppFlow API Reference

"createdBy": "arn:aws:iam::<AccountId>:user/BetaTestUser",
"description": "test flow 1 description",
"destinationConnectorType": "S3",
"destinationConnectorLabel": "MyCustomDestinationConnector",
"flowArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1",
"flowName": "test-flow-1",
"flowStatus": "Active",
"lastRunExecutionDetails":
{
"mostRecentExecutionMessage": "Successfully ran the flow",
"mostRecentExecutionStatus": "Successful",
"mostRecentExecutionTime": "execution_time_value"
},
"lastUpdatedAt": "lastupdated_time_value",
"lastUpdatedBy": "arn:aws:iam::<AccountId>:user/BetaTestUser",
"sourceConnectorType": "Salesforce",
"sourceConnectorLabel": "MyCustomSourceConnector",
"tags":
{
"internalId": "<InternalId>",
"resourceArn": "arn:aws:appflow:region:<AccountId>:flow/test-flow-1"
},
"triggerType": "OnDemand"
}
],
"nextToken": "next_token_value"
}

{
"maxResults": 1
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

GET /tags/resourceArn HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the speciﬁed ﬂow.

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: Yes

Request Body
The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"tags": {
"string" : "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

ListTagsForResource API Version 2020-08-23 171

AmazonAppFlow API Reference

The following data is returned in JSON format by the service.

tags

The tags used to organize, track, or control access for your ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\w+-=\.:/@]*

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Errors API Version 2020-08-23 172

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /register-connector HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"connectorLabel": "string",
"connectorProvisioningConfig": {
"lambda": {
"lambdaArn": "string"
}
},
"connectorProvisioningType": "string",
"description": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your

RegisterConnector request completes only once. You choose the value to pass. For example,
if you don't receive a response from your request, you can safely retry the request with the
same clientToken parameter value.

RegisterConnector API Version 2020-08-23 174

AmazonAppFlow API Reference

If you specify input parameters that differ from your first request, an error occurs. If
you use a different value for clientToken, Amazon AppFlow considers it a new call to
RegisterConnector. The token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
connectorLabel

The name of the connector. The name is unique for each ConnectorRegistration in your
AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorProvisioningConﬁg

The provisioning type of the connector. Currently the only supported value is LAMBDA.

Type: ConnectorProvisioningConﬁg object

Required: No
connectorProvisioningType

The provisioning type of the connector. Currently the only supported value is LAMBDA.

Type: String

Valid Values: LAMBDA

Required: No
description

A description about the connector that's being registered.

Request Body API Version 2020-08-23 175

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorArn

The ARN of the connector being registered.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

Response Syntax API Version 2020-08-23 176

AmazonAppFlow API Reference

HTTP Status Code: 403

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

ThrottlingException

API calls have exceeded the maximum allowed API request rate per account and per Region.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

Errors API Version 2020-08-23 177

AmazonAppFlow API Reference

HTTP Status Code: 400

Examples

Registering a connector

This example shows a sample request for the RegisterConnector API and a sample response.

Sample Request

{
"connectorLabel": "Connector_Label_Value",
"connectorProvisioningType": "LAMBDA",
"connectorProvisioningConfig":
{
"lambda":
{
"lambdaArn": "lambda arn"
}
}
}

Sample Response

{
"connectorArn": "arn:aws:appflow:region:<AccountId>:connector/Connector_Label"
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

Examples API Version 2020-08-23 178

AmazonAppFlow API Reference

• AWS SDK for JavaScript V3

• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /reset-connector-metadata-cache HTTP/1.1

Content-type: application/json

{
"apiVersion": "string",
"connectorEntityName": "string",
"connectorProfileName": "string",
"connectorType": "string",
"entitiesPath": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

apiVersion

The API version that you speciﬁed in the connector proﬁle that you’re resetting cached
metadata for. You must use this parameter only if the connector supports multiple API versions
or if the connector type is CustomConnector.

To look up how many versions a connector supports, use the DescribeConnectors action. In the
response, ﬁnd the value that Amazon AppFlow returns for the connectorVersion parameter.

ResetConnectorMetadataCache API Version 2020-08-23 180

AmazonAppFlow API Reference

To look up the connector type, use the DescribeConnectorProﬁles action. In the response, ﬁnd
the value that Amazon AppFlow returns for the connectorType parameter.

To look up the API version that you specified in a connector profile, use the
DescribeConnectorProfiles action.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorEntityName

Use this parameter if you want to reset cached metadata about the details for an individual
entity.

If you don't include this parameter in your request, Amazon AppFlow only resets cached
metadata about entity names, not entity details.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: \S+

Required: No
connectorProﬁleName

The name of the connector proﬁle that you want to reset cached metadata for.

You can omit this parameter if you're resetting the cache for any of the following connectors:
Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics, Amazon S3, or Upsolver.
If you're resetting the cache for any other connector, you must include this parameter in your
request.

Type: String

Length Constraints: Maximum length of 256.

Request Body API Version 2020-08-23 181

AmazonAppFlow API Reference

Pattern: [\w/!@#+=.-]+

Required: No
connectorType

The type of connector to reset cached metadata for.

You must include this parameter in your request if you're resetting the cache for any of the
following connectors: Amazon Connect, Amazon EventBridge, Amazon Lookout for Metrics,
Amazon S3, or Upsolver. If you're resetting the cache for any other connector, you can omit this
parameter from your request.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
entitiesPath

Use this parameter only if you’re resetting the cached metadata about a nested entity. Only
some connectors support nested entities. A nested entity is one that has another entity as a
parent. To use this parameter, specify the name of the parent entity.

To look up the parent-child relationship of entities, you can send a ListConnectorEntities

request that omits the entitiesPath parameter. Amazon AppFlow will return a list of top-level
entities. For each one, it indicates whether the entity has nested entities. Then, in a subsequent
ListConnectorEntities request, you can specify a parent entity name for the entitiesPath
parameter. Amazon AppFlow will return a list of the child entities for that parent.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\s\w/!@#+=,.-]*

Required: No

Request Body API Version 2020-08-23 182

AmazonAppFlow API Reference

Response Syntax

HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples
Reset cache of entity names

The following example shows the request body for a call to reset the cached metadata for entity
names.

Response Syntax API Version 2020-08-23 183

AmazonAppFlow API Reference

Sample Request

{
"apiVersion": "v1.0",
"connectorProfileName": "MyCustomConnector"
}

Sample Response

{}

Reset cache of entity details

The following example shows the request body for a call to reset the cached metadata about the
details for a speciﬁc entity.

Sample Request

{
"apiVersion": "v1.0",
"connectorProfileName": "MyCustomConnector",
"connectorEntityName": "EntityName"
}

Sample Response

{}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /start-flow HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"flowName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your StartFlow

request completes only once. You choose the value to pass. For example, if you don't receive
a response from your request, you can safely retry the request with the same clientToken
parameter value.

If you specify input parameters that differ from your first request, an error occurs for flows that
run on a schedule or based on an event. However, the error doesn't occur for flows that run on
demand. You set the conditions that initiate your flow for the triggerConfig parameter.

If you use a diﬀerent value for clientToken, Amazon AppFlow considers it a new call to
StartFlow. The token is active for 8 hours.

StartFlow API Version 2020-08-23 186

AmazonAppFlow API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"executionId": "string",
"flowArn": "string",
"flowStatus": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

executionId

Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled
or event-triggered flows, this value is null.

Type: String

Response Syntax API Version 2020-08-23 187

AmazonAppFlow API Reference

Length Constraints: Maximum length of 256.

Pattern: \S+
ﬂowArn

The ﬂow's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*
ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

Errors API Version 2020-08-23 188

AmazonAppFlow API Reference

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

Examples

StartFlow example

This example shows a sample request and response for the StartFlow API.

Sample Request

{
"flowName": "name"
}

Sample Response

{
"flowArn": "arn:aws:appflow:region:<AccountId>:flow/test_flow_ondemand_1",
"flowStatus": "Active"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3

Examples API Version 2020-08-23 189

AmazonAppFlow API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

POST /stop-flow HTTP/1.1

Content-type: application/json

{
"flowName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

StopFlow API Version 2020-08-23 191

AmazonAppFlow API Reference

{
"flowArn": "string",
"flowStatus": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ﬂowArn

The ﬂow's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*
ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

Errors

For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

Response Elements API Version 2020-08-23 192

AmazonAppFlow API Reference

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

UnsupportedOperationException

The requested operation is not supported for the current ﬂow.

HTTP Status Code: 400

Examples

StopFlow example

This example shows a sample request and response for the StopFlow API.

Sample Request

{
"flowName": "name"
}

Sample Response

{
"flowArn": "arn:aws:appflow:region:<AccountId>:flow/test_flow_ondemand_1",
"flowStatus": "Suspended"
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4

Examples API Version 2020-08-23 193

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

POST /tags/resourceArn HTTP/1.1

Content-type: application/json

{
"tags": {
"string" : "string"
}
}

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the ﬂow that you want to tag.

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

tags

The tags used to organize, track, or control access for your ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

TagResource API Version 2020-08-23 195

AmazonAppFlow API Reference

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\w+-=\.:/@]*

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Response Syntax API Version 2020-08-23 196

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /unregister-connector HTTP/1.1

Content-type: application/json

{
"connectorLabel": "string",
"forceDelete": boolean
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

connectorLabel

The label of the connector. The label is unique for each ConnectorRegistration in your AWS
account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes
forceDelete

Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in
use in one or more connector proﬁles. The default value is false.

UnregisterConnector API Version 2020-08-23 198

AmazonAppFlow API Reference

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

Examples

Unregister connectors

This example shows a sample request for the UnregisterConnector API and a sample response.

Response Syntax API Version 2020-08-23 199

AmazonAppFlow API Reference

Sample Request

{
"connectorLabel": "MySampleCustomConnector",
"forceDelete": true
}

{
"message": "Conflict executing request: Connector: MySampleCustomConnector is
associated with one or more connector profiles. If you still want to *delete*
it, *then* make *delete* request *with* forceDelete flag *as* true. *Some* of the
associated connector profiles are: [myTestProfile1, myTestProfile2]"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

resourceArn

The Amazon Resource Name (ARN) of the ﬂow that you want to untag.

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: Yes
tagKeys

The tag keys associated with the tag that you want to remove from your ﬂow.

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Required: Yes

Request Body
The request does not have a request body.

Response Syntax

HTTP/1.1 200

UntagResource API Version 2020-08-23 201

AmazonAppFlow API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• AWS SDK for .NET V4
• AWS SDK for C++
• AWS SDK for Go v2
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for Kotlin
• AWS SDK for PHP V3

Response Elements API Version 2020-08-23 202

AmazonAppFlow API Reference

• AWS SDK for Python

• AWS SDK for Ruby V3

POST /update-connector-profile HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"connectionMode": "string",
"connectorProfileConfig": {
"connectorProfileCredentials": {
"Amplitude": {
"apiKey": "string",
"secretKey": "string"
},
"CustomConnector": {
"apiKey": {
"apiKey": "string",
"apiSecretKey": "string"
},
"authenticationType": "string",
"basic": {
"password": "string",
"username": "string"
},
"custom": {
"credentialsMap": {
"string" : "string"
},
"customAuthenticationType": "string"
},
"oauth2": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"

UpdateConnectorProﬁle API Version 2020-08-23 204

AmazonAppFlow API Reference

}
},
"Datadog": {
"apiKey": "string",
"applicationKey": "string"
},
"Dynatrace": {
"apiToken": "string"
},
"GoogleAnalytics": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Honeycode": {
"accessToken": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"InforNexus": {
"accessKeyId": "string",
"datakey": "string",
"secretAccessKey": "string",
"userId": "string"
},
"Marketo": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Pardot": {
"accessToken": "string",

Request Syntax API Version 2020-08-23 205

AmazonAppFlow API Reference

"clientCredentialsArn": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"Redshift": {
"password": "string",
"username": "string"
},
"Salesforce": {
"accessToken": "string",
"clientCredentialsArn": "string",
"jwtToken": "string",
"oAuth2GrantType": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"SAPOData": {
"basicAuthCredentials": {
"password": "string",
"username": "string"
},
"oAuthCredentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
}
},
"ServiceNow": {
"oAuth2Credentials": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {

Request Syntax API Version 2020-08-23 206

AmazonAppFlow API Reference

"authCode": "string",
"redirectUri": "string"
},
"refreshToken": "string"
},
"password": "string",
"username": "string"
},
"Singular": {
"apiKey": "string"
},
"Slack": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
},
"Snowflake": {
"password": "string",
"username": "string"
},
"Trendmicro": {
"apiSecretKey": "string"
},
"Veeva": {
"password": "string",
"username": "string"
},
"Zendesk": {
"accessToken": "string",
"clientId": "string",
"clientSecret": "string",
"oAuthRequest": {
"authCode": "string",
"redirectUri": "string"
}
}
},
"connectorProfileProperties": {
"Amplitude": {
},

Request Syntax API Version 2020-08-23 207

AmazonAppFlow API Reference

"CustomConnector": {
"oAuth2Properties": {
"oAuth2GrantType": "string",
"tokenUrl": "string",
"tokenUrlCustomProperties": {
"string" : "string"
}
},
"profileProperties": {
"string" : "string"
}
},
"Datadog": {
"instanceUrl": "string"
},
"Dynatrace": {
"instanceUrl": "string"
},
"GoogleAnalytics": {
},
"Honeycode": {
},
"InforNexus": {
"instanceUrl": "string"
},
"Marketo": {
"instanceUrl": "string"
},
"Pardot": {
"businessUnitId": "string",
"instanceUrl": "string",
"isSandboxEnvironment": boolean
},
"Redshift": {
"bucketName": "string",
"bucketPrefix": "string",
"clusterIdentifier": "string",
"dataApiRoleArn": "string",
"databaseName": "string",
"databaseUrl": "string",
"isRedshiftServerless": boolean,
"roleArn": "string",
"workgroupName": "string"
},

Request Syntax API Version 2020-08-23 208

AmazonAppFlow API Reference

"Salesforce": {
"instanceUrl": "string",
"isSandboxEnvironment": boolean,
"usePrivateLinkForMetadataAndAuthorization": boolean
},
"SAPOData": {
"applicationHostUrl": "string",
"applicationServicePath": "string",
"clientNumber": "string",
"disableSSO": boolean,
"logonLanguage": "string",
"oAuthProperties": {
"authCodeUrl": "string",
"oAuthScopes": [ "string" ],
"tokenUrl": "string"
},
"portNumber": number,
"privateLinkServiceName": "string"
},
"ServiceNow": {
"instanceUrl": "string"
},
"Singular": {
},
"Slack": {
"instanceUrl": "string"
},
"Snowflake": {
"accountName": "string",
"bucketName": "string",
"bucketPrefix": "string",
"privateLinkServiceName": "string",
"region": "string",
"stage": "string",
"warehouse": "string"
},
"Trendmicro": {
},
"Veeva": {
"instanceUrl": "string"
},
"Zendesk": {
"instanceUrl": "string"
}

Request Syntax API Version 2020-08-23 209

AmazonAppFlow API Reference

}
},
"connectorProfileName": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body
The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your

UpdateConnectorProfile request completes only once. You choose the value to pass. For
example, if you don't receive a response from your request, you can safely retry the request with
the same clientToken parameter value.

If you specify input parameters that differ from your first request, an error occurs. If
you use a different value for clientToken, Amazon AppFlow considers it a new call to
UpdateConnectorProfile. The token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
connectionMode

Indicates the connection mode and if it is public or private.

Type: String

Valid Values: Public | Private

URI Request Parameters API Version 2020-08-23 210

AmazonAppFlow API Reference

Required: Yes
connectorProﬁleConﬁg

Defines the connector-specific profile configuration and credentials.

Type: ConnectorProﬁleConﬁg object

Required: Yes
connectorProﬁleName

The name of the connector proﬁle and is unique for each ConnectorProfile in the AWS
account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorProfileArn": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorProﬁleArn

The Amazon Resource Name (ARN) of the connector proﬁle.

Type: String

Length Constraints: Maximum length of 512.

Response Syntax API Version 2020-08-23 211

AmazonAppFlow API Reference

Pattern: arn:aws:appflow:.*:[0-9]+:.*

Errors
For information about the errors that are common to all actions, see Common Error Types.

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

UpdateConnectorProﬁle example using Salesforce

This example shows a sample request and response for the UpdateConnectorProfile API using
Salesforce.

Errors API Version 2020-08-23 212

AmazonAppFlow API Reference

Sample Request

{
"connectorProfileName": "Connector_Profile_Name_value",
"kmsArn": null,
"connectorType": "Salesforce",
"connectionMode": "Public",
"connectorProfileConfig":
{
"connectorProfileProperties":
{
"salesforce":
{
"instanceUrl": "Instance_url_value",
"isSandboxEnvironment": false
}
},
"connectorProfileCredentials":
{
"salesforce":
{
"accessToken": "<AccessToken>",
"refreshToken": "<RefreshToken>",
"oauthRequest":
{
"authCode": null,
"redirectUri": null
}
}
}
}
}

Sample Response

{
"connectorProfileArn": "arn:aws:appflow:region:<AccountId>:connectorprofile/
Connector_Profile_Name"
}

Examples API Version 2020-08-23 213

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

• A new AWS Lambda function that you specify

Request Syntax

POST /update-connector-registration HTTP/1.1

Content-type: application/json

{
"clientToken": "string",
"connectorLabel": "string",
"connectorProvisioningConfig": {
"lambda": {
"lambdaArn": "string"
}
},
"description": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your

UpdateConnectorRegistration request completes only once. You choose the value to pass.
For example, if you don't receive a response from your request, you can safely retry the request
with the same clientToken parameter value.

UpdateConnectorRegistration API Version 2020-08-23 215

AmazonAppFlow API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
connectorLabel

The name of the connector. The name is unique for each connector registration in your AWS
account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: Yes
connectorProvisioningConﬁg

Contains information about the conﬁguration of the connector being registered.

Type: ConnectorProvisioningConﬁg object

Required: No
description

A description about the update that you're applying to the connector.

Type: String

Request Body API Version 2020-08-23 216

AmazonAppFlow API Reference

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"connectorArn": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorArn

The ARN of the connector being updated.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

Response Syntax API Version 2020-08-23 217

AmazonAppFlow API Reference

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

ThrottlingException

API calls have exceeded the maximum allowed API request rate per account and per Region.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

Errors API Version 2020-08-23 218

AmazonAppFlow API Reference

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

POST /update-flow HTTP/1.1

Content-type: application/json

UpdateFlow API Version 2020-08-23 220

AmazonAppFlow API Reference

"Honeycode": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"LookoutMetrics": {
},
"Marketo": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"object": "string"
},
"Redshift": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},
"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
},
"preserveSourceDataTyping": boolean
}

Request Syntax API Version 2020-08-23 221

AmazonAppFlow API Reference

},
"Salesforce": {
"dataTransferApi": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
},
"SAPOData": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"objectPath": "string",
"successResponseHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string"
},
"writeOperationType": "string"
},
"Snowflake": {
"bucketPrefix": "string",
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"intermediateBucketName": "string",
"object": "string"
},
"Upsolver": {
"bucketName": "string",
"bucketPrefix": "string",
"s3OutputFormatConfig": {
"aggregationConfig": {
"aggregationType": "string",
"targetFileSize": number
},

Request Syntax API Version 2020-08-23 222

AmazonAppFlow API Reference

"fileType": "string",
"prefixConfig": {
"pathPrefixHierarchy": [ "string" ],
"prefixFormat": "string",
"prefixType": "string"
}
}
},
"Zendesk": {
"errorHandlingConfig": {
"bucketName": "string",
"bucketPrefix": "string",
"failOnFirstDestinationError": boolean
},
"idFieldNames": [ "string" ],
"object": "string",
"writeOperationType": "string"
}
}
}
],
"flowName": "string",
"metadataCatalogConfig": {
"glueDataCatalog": {
"databaseName": "string",
"roleArn": "string",
"tablePrefix": "string"
}
},
"sourceFlowConfig": {
"apiVersion": "string",
"connectorProfileName": "string",
"connectorType": "string",
"incrementalPullConfig": {
"datetimeTypeFieldName": "string"
},
"sourceConnectorProperties": {
"Amplitude": {
"object": "string"
},
"CustomConnector": {
"customProperties": {
"string" : "string"
},

Request Syntax API Version 2020-08-23 223

AmazonAppFlow API Reference

"dataTransferApi": {
"Name": "string",
"Type": "string"
},
"entityName": "string"
},
"Datadog": {
"object": "string"
},
"Dynatrace": {
"object": "string"
},
"GoogleAnalytics": {
"object": "string"
},
"InforNexus": {
"object": "string"
},
"Marketo": {
"object": "string"
},
"Pardot": {
"object": "string"
},
"S3": {
"bucketName": "string",
"bucketPrefix": "string",
"s3InputFormatConfig": {
"s3InputFileType": "string"
}
},
"Salesforce": {
"dataTransferApi": "string",
"enableDynamicFieldUpdate": boolean,
"includeDeletedRecords": boolean,
"object": "string"
},
"SAPOData": {
"objectPath": "string",
"paginationConfig": {
"maxPageSize": number
},
"parallelismConfig": {
"maxParallelism": number

Request Syntax API Version 2020-08-23 224

AmazonAppFlow API Reference

}
},
"ServiceNow": {
"object": "string"
},
"Singular": {
"object": "string"
},
"Slack": {
"object": "string"
},
"Trendmicro": {
"object": "string"
},
"Veeva": {
"documentType": "string",
"includeAllVersions": boolean,
"includeRenditions": boolean,
"includeSourceFiles": boolean,
"object": "string"
},
"Zendesk": {
"object": "string"
}
}
},
"tasks": [
{
"connectorOperator": {
"Amplitude": "string",
"CustomConnector": "string",
"Datadog": "string",
"Dynatrace": "string",
"GoogleAnalytics": "string",
"InforNexus": "string",
"Marketo": "string",
"Pardot": "string",
"S3": "string",
"Salesforce": "string",
"SAPOData": "string",
"ServiceNow": "string",
"Singular": "string",
"Slack": "string",
"Trendmicro": "string",

Request Syntax API Version 2020-08-23 225

AmazonAppFlow API Reference

"Veeva": "string",
"Zendesk": "string"
},
"destinationField": "string",
"sourceFields": [ "string" ],
"taskProperties": {
"string" : "string"
},
"taskType": "string"
}
],
"triggerConfig": {
"triggerProperties": {
"Scheduled": {
"dataPullMode": "string",
"firstExecutionFrom": number,
"flowErrorDeactivationThreshold": number,
"scheduleEndTime": number,
"scheduleExpression": "string",
"scheduleOffset": number,
"scheduleStartTime": number,
"timezone": "string"
}
},
"triggerType": "string"
}
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your UpdateFlow

request completes only once. You choose the value to pass. For example, if you don't receive
a response from your request, you can safely retry the request with the same clientToken
parameter value.

URI Request Parameters API Version 2020-08-23 226

AmazonAppFlow API Reference

If you specify input parameters that differ from your first request, an error occurs. If you use a
different value for clientToken, Amazon AppFlow considers it a new call to UpdateFlow. The
token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No
description

A description of the ﬂow.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
destinationFlowConﬁgList

The conﬁguration that controls how Amazon AppFlow transfers data to the destination
connector.

Type: Array of DestinationFlowConﬁg objects

Required: Yes
ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Request Body API Version 2020-08-23 227

AmazonAppFlow API Reference

Required: Yes
metadataCatalogConﬁg

Type: MetadataCatalogConﬁg object

Required: No
sourceFlowConﬁg

Contains information about the conﬁguration of the source connector used in the ﬂow.

Type: SourceFlowConﬁg object

Required: Yes
tasks

A list of tasks that Amazon AppFlow performs while transferring the data in the ﬂow run.

Type: Array of Task objects

Required: Yes
triggerConﬁg

The trigger settings that determine how and when the ﬂow runs.

Type: TriggerConﬁg object

Required: Yes

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
"flowStatus": "string"
}

Response Syntax API Version 2020-08-23 228

AmazonAppFlow API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

Errors
For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

ConﬂictException

There was a conflict when processing the request (for example, a flow with the given name
already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

Response Elements API Version 2020-08-23 229

AmazonAppFlow API Reference

HTTP Status Code: 500

ResourceNotFoundException

The resource speciﬁed in the request (such as the source or destination connector proﬁle) is not
found.

HTTP Status Code: 404

ServiceQuotaExceededException

The request would cause a service quota (such as the number of ﬂows) to be exceeded.

HTTP Status Code: 402

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Salesforce

This example shows a sample request for the UpdateFlow API using Salesforce.

Sample Request

{
"flowName": "testFlow-newpayload",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Salesforce",
"connectorProfileName": "Connector_Profile_Name",
"sourceConnectorProperties": {
"salesforce": {
"object": "account"
}
}
},
"destinationFlowConfigList": [

Examples API Version 2020-08-23 230

AmazonAppFlow API Reference

{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_value",
"bucketKey": "Bucket_Name_value"
}
}
}
],
"tasks": [
{
"sourceFields": ["CreatedDate"],
"taskProperties": {},
"destinationField": "CreatedDate",
"taskType": "Map"
},
{
"destinationField": "LastActivityDate",
"sourceFields": ["LastActivityDate"],
"taskProperties": {},
"taskType": "Map"
}
]
}

Zendesk

This example shows a sample request for the UpdateFlow API using Zendesk.

Sample Request

{
"useDefaultEncryption": false,
"flowName": "testFlowZendesk",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Zendesk",
"connectorProfileName": "connector-profile-name",

Examples API Version 2020-08-23 231

AmazonAppFlow API Reference

"sourceConnectorProperties": {
"zendesk": {
"object": "tickets"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": ["url"],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}

Google Analytics

This example shows a sample request for the UpdateFlow API using Google Analytics.

Sample Request

{
"useDefaultEncryption": false,
"flowName": "testFlowGAnalytics",
"description": "TestFlow",
"triggerConfig": {
"triggerType": "OnDemand"
},

Examples API Version 2020-08-23 232

AmazonAppFlow API Reference

"sourceFlowConfig": {
"connectorType": "Googleanalytics",
"connectorProfileName": "connector-profile-name",
"sourceConnectorProperties": {
"googleanalytics": {
"object": "Object_ID"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"destinationField": "url",
"sourceFields": ["url"],
"taskProperties": {
"SOURCE_DATA_TYPE": "integer"
},
"taskType": "Map"
}
]
}

Marketo

This example shows a sample request for the UpdateFlow API using Marketo.

Sample Request

{
"flowName": "testMarketo",
"description": "TestFlow",
"triggerConfig": {

Examples API Version 2020-08-23 233

AmazonAppFlow API Reference

"triggerType": "OnDemand"
},
"sourceFlowConfig": {
"connectorType": "Marketo",
"connectorProfileName": "Connector-profile-new",
"sourceConnectorProperties": {
"marketo": {
"object": "leads"
}
}
},
"destinationFlowConfigList": [
{
"connectorType": "S3",
"connectorProfileName": "Test",
"destinationConnectorProperties": {
"s3": {
"bucketName": "Bucket_Name_Value",
"bucketKey": "Bucket_Name_Value"
}
}
}
],
"tasks": [
{
"connectorOperator": {
"marketo":"BETWEEN"
},
"sourceFields": [
"updatedAt"
],
"taskProperties": {
"DATA_TYPE": "datetime",
"LOWER_BOUND": "Lower_Bound_value",
"UPPER_BOUND": "Upper_Bound_value"
},
"taskType": "Filter"
},
{
"destinationField": "company",
"sourceFields": [
"company"
],
"taskProperties": {

Examples API Version 2020-08-23 234

AmazonAppFlow API Reference

"SOURCE_DATA_TYPE": "string"
},
"taskType": "Map"
}
]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface V2

The following data types are supported:

• AggregationConfig
• AmplitudeConnectorProfileCredentials
• AmplitudeConnectorProfileProperties
• AmplitudeMetadata
• AmplitudeSourceProperties
• ApiKeyCredentials
• AuthenticationConfig
• AuthParameter
• BasicAuthCredentials
• ConnectorConfiguration
• ConnectorDetail
• ConnectorEntity
• ConnectorEntityField
• ConnectorMetadata
• ConnectorOAuthRequest
• ConnectorOperator
• ConnectorProfile
• ConnectorProfileConfig
• ConnectorProfileCredentials
• ConnectorProfileProperties

API Version 2020-08-23 236

AmazonAppFlow API Reference

• ConnectorProvisioningConfig
• ConnectorRuntimeSetting
• CustomAuthConfig
• CustomAuthCredentials
• CustomConnectorDestinationProperties
• CustomConnectorProfileCredentials
• CustomConnectorProfileProperties
• CustomConnectorSourceProperties
• CustomerProfilesDestinationProperties
• CustomerProfilesMetadata
• DatadogConnectorProfileCredentials
• DatadogConnectorProfileProperties
• DatadogMetadata
• DatadogSourceProperties
• DataTransferApi
• DestinationConnectorProperties
• DestinationFieldProperties
• DestinationFlowConfig
• DynatraceConnectorProfileCredentials
• DynatraceConnectorProfileProperties
• DynatraceMetadata
• DynatraceSourceProperties
• ErrorHandlingConfig
• ErrorInfo
• EventBridgeDestinationProperties
• EventBridgeMetadata
• ExecutionDetails
• ExecutionRecord
• ExecutionResult
• FieldTypeDetails

API Version 2020-08-23 237

AmazonAppFlow API Reference

• FlowDefinition
• GlueDataCatalogConfig
• GoogleAnalyticsConnectorProfileCredentials
• GoogleAnalyticsConnectorProfileProperties
• GoogleAnalyticsMetadata
• GoogleAnalyticsSourceProperties
• HoneycodeConnectorProfileCredentials
• HoneycodeConnectorProfileProperties
• HoneycodeDestinationProperties
• HoneycodeMetadata
• IncrementalPullConfig
• InforNexusConnectorProfileCredentials
• InforNexusConnectorProfileProperties
• InforNexusMetadata
• InforNexusSourceProperties
• LambdaConnectorProvisioningConfig
• LookoutMetricsDestinationProperties
• MarketoConnectorProfileCredentials
• MarketoConnectorProfileProperties
• MarketoDestinationProperties
• MarketoMetadata
• MarketoSourceProperties
• MetadataCatalogConfig
• MetadataCatalogDetail
• OAuth2Credentials
• OAuth2CustomParameter
• OAuth2Defaults
• OAuth2Properties
• OAuthCredentials
• OAuthProperties

API Version 2020-08-23 238

AmazonAppFlow API Reference

• PardotConnectorProfileCredentials
• PardotConnectorProfileProperties
• PardotMetadata
• PardotSourceProperties
• PrefixConfig
• PrivateConnectionProvisioningState
• Range
• RedshiftConnectorProfileCredentials
• RedshiftConnectorProfileProperties
• RedshiftDestinationProperties
• RedshiftMetadata
• RegistrationOutput
• S3DestinationProperties
• S3InputFormatConfig
• S3Metadata
• S3OutputFormatConfig
• S3SourceProperties
• SalesforceConnectorProfileCredentials
• SalesforceConnectorProfileProperties
• SalesforceDestinationProperties
• SalesforceMetadata
• SalesforceSourceProperties
• SAPODataConnectorProfileCredentials
• SAPODataConnectorProfileProperties
• SAPODataDestinationProperties
• SAPODataMetadata
• SAPODataPaginationConfig
• SAPODataParallelismConfig
• SAPODataSourceProperties
• ScheduledTriggerProperties

API Version 2020-08-23 239

AmazonAppFlow API Reference

• ServiceNowConnectorProfileCredentials
• ServiceNowConnectorProfileProperties
• ServiceNowMetadata
• ServiceNowSourceProperties
• SingularConnectorProfileCredentials
• SingularConnectorProfileProperties
• SingularMetadata
• SingularSourceProperties
• SlackConnectorProfileCredentials
• SlackConnectorProfileProperties
• SlackMetadata
• SlackSourceProperties
• SnowflakeConnectorProfileCredentials
• SnowflakeConnectorProfileProperties
• SnowflakeDestinationProperties
• SnowflakeMetadata
• SourceConnectorProperties
• SourceFieldProperties
• SourceFlowConfig
• SuccessResponseHandlingConfig
• SupportedFieldTypeDetails
• Task
• TrendmicroConnectorProfileCredentials
• TrendmicroConnectorProfileProperties
• TrendmicroMetadata
• TrendmicroSourceProperties
• TriggerConfig
• TriggerProperties
• UpsolverDestinationProperties
• UpsolverMetadata

API Version 2020-08-23 240

AmazonAppFlow API Reference

• UpsolverS3OutputFormatConfig
• VeevaConnectorProfileCredentials
• VeevaConnectorProfileProperties
• VeevaMetadata
• VeevaSourceProperties
• ZendeskConnectorProfileCredentials
• ZendeskConnectorProfileProperties
• ZendeskDestinationProperties
• ZendeskMetadata
• ZendeskSourceProperties

API Version 2020-08-23 241

AmazonAppFlow API Reference

AggregationConﬁg
The aggregation settings that you can use to customize the output format of your ﬂow data.

Contents
aggregationType

Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them
unaggregated.

Type: String

Valid Values: None | SingleFile

Required: No
targetFileSize

The desired file size, in MB, for each output file that Amazon AppFlow writes to the flow
destination. For each file, Amazon AppFlow attempts to achieve the size that you specify. The
actual file sizes might differ from this target based on the number and size of the records that
each file contains.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AggregationConﬁg API Version 2020-08-23 242

AmazonAppFlow API Reference

AmplitudeConnectorProﬁleCredentials
The connector-speciﬁc credentials required when using Amplitude.

Contents
apiKey

A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to

your API.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes
secretKey

The Secret Access Key portion of the credentials.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AmplitudeConnectorProﬁleCredentials API Version 2020-08-23 243

AmazonAppFlow API Reference

AmplitudeConnectorProfileProperties
The connector-specific profile properties required when using Amplitude.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AmplitudeConnectorProﬁleProperties API Version 2020-08-23 244

AmazonAppFlow API Reference

AmplitudeMetadata
The connector metadata speciﬁc to Amplitude.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AmplitudeMetadata API Version 2020-08-23 245

AmazonAppFlow API Reference

AmplitudeSourceProperties
The properties that are applied when Amplitude is being used as a source.

Contents
object

The object speciﬁed in the Amplitude ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

AmplitudeSourceProperties API Version 2020-08-23 246

AmazonAppFlow API Reference

ApiKeyCredentials
The API key credentials required for API key authentication.

Contents
apiKey

The API key required for API key authentication.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes
apiSecretKey

The API secret key required for API key authentication.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ApiKeyCredentials API Version 2020-08-23 247

AmazonAppFlow API Reference

AuthenticationConﬁg
Contains information about the authentication conﬁg that the connector supports.

Contents
customAuthConﬁgs

Contains information required for custom authentication.

Type: Array of CustomAuthConﬁg objects

Required: No
isApiKeyAuthSupported

Indicates whether API key authentication is supported by the connector

Type: Boolean

Required: No
isBasicAuthSupported

Indicates whether basic authentication is supported by the connector.

Type: Boolean

Required: No
isCustomAuthSupported

Indicates whether custom authentication is supported by the connector

Type: Boolean

Required: No
isOAuth2Supported

Indicates whether OAuth 2.0 authentication is supported by the connector.

Type: Boolean

Required: No

AuthenticationConﬁg API Version 2020-08-23 248

AmazonAppFlow API Reference

oAuth2Defaults

Contains the default values required for OAuth 2.0 authentication.

Type: OAuth2Defaults object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
description

A description about the authentication parameter.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No
isRequired

Indicates whether this authentication parameter is required.

Type: Boolean

Required: No
isSensitiveField

Indicates whether this authentication parameter is a sensitive ﬁeld.

Type: Boolean

Required: No

AuthParameter API Version 2020-08-23 250

AmazonAppFlow API Reference

key

The authentication key required to authenticate with the connector.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
label

Label used for authentication parameter.

Type: String

Length Constraints: Maximum length of 128.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The password to use to connect to a resource.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: Yes
username

The username to use to connect to a resource.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

BasicAuthCredentials API Version 2020-08-23 252

AmazonAppFlow API Reference

ConnectorConﬁguration
The conﬁguration settings related to a given connector.

Contents
authenticationConﬁg

The authentication conﬁg required for the connector.

Type: AuthenticationConﬁg object

Required: No
canUseAsDestination

Speciﬁes whether the connector can be used as a destination.

Type: Boolean

Required: No
canUseAsSource

Speciﬁes whether the connector can be used as a source.

Type: Boolean

Required: No
connectorArn

The Amazon Resource Name (ARN) for the registered connector.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: No
connectorDescription

A description about the connector.

ConnectorConﬁguration API Version 2020-08-23 253

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
connectorLabel

The label used for registering the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorMetadata

Speciﬁes connector-speciﬁc metadata such as oAuthScopes, supportedRegions,

privateLinkServiceUrl, and so on.

Type: ConnectorMetadata object

Required: No
connectorModes

The connection modes that the connector supports.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorName

The connector name.

Type: String

Contents API Version 2020-08-23 254

AmazonAppFlow API Reference

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No
connectorOwner

The owner who developed the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No
connectorProvisioningConﬁg

The conﬁguration required for registering the connector.

Type: ConnectorProvisioningConﬁg object

Required: No
connectorProvisioningType

The provisioning type used to register the connector.

Type: String

Valid Values: LAMBDA

Required: No
connectorRuntimeSettings

The required connector runtime settings.

Type: Array of ConnectorRuntimeSetting objects

Required: No
connectorType

The connector type.

Contents API Version 2020-08-23 255

AmazonAppFlow API Reference

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
connectorVersion

The connector version.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
isPrivateLinkEnabled

Speciﬁes if PrivateLink is enabled for that connector.

Type: Boolean

Required: No
isPrivateLinkEndpointUrlRequired

Speciﬁes if a PrivateLink endpoint URL is required.

Type: Boolean

Required: No
logoURL

Logo URL of the connector.

Type: String

Length Constraints: Maximum length of 256.

Contents API Version 2020-08-23 256

AmazonAppFlow API Reference

Pattern: ^(https?|ftp|file)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/
%=~_|]

Required: No
registeredAt

The date on which the connector was registered.

Type: Timestamp

Required: No
registeredBy

Information about who registered the connector.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
supportedApiVersions

A list of API versions that are supported by the connector.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
supportedDataTransferApis

The APIs of the connector application that Amazon AppFlow can use to transfer your data.

Type: Array of DataTransferApi objects

Required: No
supportedDataTransferTypes

The data transfer types that the connector supports.

Contents API Version 2020-08-23 257

AmazonAppFlow API Reference

RECORD

Structured records.
FILE

Files or binary data.

Type: Array of strings

Valid Values: RECORD | FILE

Required: No
supportedDestinationConnectors

Lists the connectors that are available for use as destinations.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
supportedOperators

A list of operators supported by the connector.

Type: Array of strings

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN

Required: No

Contents API Version 2020-08-23 258

AmazonAppFlow API Reference

supportedSchedulingFrequencies

Speciﬁes the supported ﬂow frequency for that connector.

Type: Array of strings

Valid Values: BYMINUTE | HOURLY | DAILY | WEEKLY | MONTHLY | ONCE

Required: No
supportedTriggerTypes

Speciﬁes the supported trigger types for the ﬂow.

Type: Array of strings

Valid Values: Scheduled | Event | OnDemand

Required: No
supportedWriteOperations

A list of write operations supported by the connector.

Type: Array of strings

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The application type of the connector.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
connectorDescription

A description about the registered connector.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
connectorLabel

A label used for the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorModes

The connection mode that the connector supports.

ConnectorDetail API Version 2020-08-23 260

AmazonAppFlow API Reference

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorName

The name of the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No
connectorOwner

The owner of the connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No
connectorProvisioningType

The provisioning type that the connector uses.

Type: String

Valid Values: LAMBDA

Required: No
connectorType

The connector type.

Type: String

Contents API Version 2020-08-23 261

AmazonAppFlow API Reference

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
connectorVersion

The connector version.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
registeredAt

The time at which the connector was registered.

Type: Timestamp

Required: No
registeredBy

The user who registered the connector.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
supportedDataTransferTypes

The data transfer types that the connector supports.

RECORD

Structured records.

Contents API Version 2020-08-23 262

AmazonAppFlow API Reference

FILE

Files or binary data.

Type: Array of strings

Valid Values: RECORD | FILE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the connector entity.

Type: String

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: Yes
hasNestedEntities

Speciﬁes whether the connector entity is a parent or a category and has more
entities nested underneath it. If another call is made with entitiesPath =
"the_current_entity_name_with_hasNestedEntities_true", then it returns the
nested entities underneath it. This provides a way to retrieve all supported entities in a recursive
fashion.

Type: Boolean

Required: No
label

The label applied to the connector entity.

Type: String

Length Constraints: Maximum length of 128.

Pattern: .*

Required: No

ConnectorEntity API Version 2020-08-23 264

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The unique identiﬁer of the connector ﬁeld.

Type: String

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: Yes
customProperties

A map that has speciﬁc properties related to the ConnectorEntityField.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

Required: No
defaultValue

Default value that can be assigned to this ﬁeld.

Type: String

Length Constraints: Maximum length of 2048.

ConnectorEntityField API Version 2020-08-23 266

AmazonAppFlow API Reference

Pattern: .*

Required: No
description

A description of the connector entity ﬁeld.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No
destinationProperties

The properties applied to a ﬁeld when the connector is being used as a destination.

Type: DestinationFieldProperties object

Required: No
isDeprecated

Booelan value that indicates whether this ﬁeld is deprecated or not.

Type: Boolean

Required: No
isPrimaryKey

Booelan value that indicates whether this ﬁeld can be used as a primary key.

Type: Boolean

Required: No
label

The label applied to a connector entity ﬁeld.

Type: String

Length Constraints: Maximum length of 128.

Contents API Version 2020-08-23 267

AmazonAppFlow API Reference

Pattern: .*

Required: No
parentIdentiﬁer

The parent identiﬁer of the connector ﬁeld.

Type: String

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No
sourceProperties

The properties that can be applied to a ﬁeld when the connector is being used as a source.

Type: SourceFieldProperties object

Required: No
supportedFieldTypeDetails

Contains details regarding the supported FieldType, including the corresponding

filterOperators and supportedValues.

Type: SupportedFieldTypeDetails object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The connector metadata speciﬁc to Amplitude.

Type: AmplitudeMetadata object

Required: No
CustomerProﬁles

The connector metadata speciﬁc to Amazon Connect Customer Proﬁles.

Type: CustomerProﬁlesMetadata object

Required: No
Datadog

The connector metadata speciﬁc to Datadog.

Type: DatadogMetadata object

Required: No
Dynatrace

The connector metadata speciﬁc to Dynatrace.

Type: DynatraceMetadata object

Required: No
EventBridge

The connector metadata speciﬁc to Amazon EventBridge.

Type: EventBridgeMetadata object

Required: No

ConnectorMetadata API Version 2020-08-23 269

AmazonAppFlow API Reference

GoogleAnalytics

The connector metadata speciﬁc to Google Analytics.

Type: GoogleAnalyticsMetadata object

Required: No
Honeycode

The connector metadata speciﬁc to Amazon Honeycode.

Type: HoneycodeMetadata object

Required: No
InforNexus

The connector metadata speciﬁc to Infor Nexus.

Type: InforNexusMetadata object

Required: No
Marketo

The connector metadata speciﬁc to Marketo.

Type: MarketoMetadata object

Required: No
Pardot

The connector metadata speciﬁc to Salesforce Pardot.

Type: PardotMetadata object

Required: No
Redshift

The connector metadata speciﬁc to Amazon Redshift.

Type: RedshiftMetadata object

Required: No

Contents API Version 2020-08-23 270

AmazonAppFlow API Reference

The connector metadata speciﬁc to Amazon S3.

Type: S3Metadata object

Required: No
Salesforce

The connector metadata speciﬁc to Salesforce.

Type: SalesforceMetadata object

Required: No
SAPOData

The connector metadata speciﬁc to SAPOData.

Type: SAPODataMetadata object

Required: No
ServiceNow

The connector metadata speciﬁc to ServiceNow.

Type: ServiceNowMetadata object

Required: No
Singular

The connector metadata speciﬁc to Singular.

Type: SingularMetadata object

Required: No
Slack

The connector metadata speciﬁc to Slack.

Type: SlackMetadata object

Required: No

Contents API Version 2020-08-23 271

AmazonAppFlow API Reference

Snowﬂake

The connector metadata speciﬁc to Snowﬂake.

Type: SnowﬂakeMetadata object

Required: No
Trendmicro

The connector metadata speciﬁc to Trend Micro.

Type: TrendmicroMetadata object

Required: No
Upsolver

The connector metadata speciﬁc to Upsolver.

Type: UpsolverMetadata object

Required: No
Veeva

The connector metadata speciﬁc to Veeva.

Type: VeevaMetadata object

Required: No
Zendesk

The connector metadata speciﬁc to Zendesk.

Type: ZendeskMetadata object

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
redirectUri

The URL to which the authentication server redirects the browser after authorization has been
granted.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectorOAuthRequest API Version 2020-08-23 274

AmazonAppFlow API Reference

ConnectorOperator
The operation to be performed on the provided source ﬁelds.

Contents
Amplitude

The operation to be performed on the provided Amplitude source ﬁelds.

Type: String

Valid Values: BETWEEN

Required: No
CustomConnector

Operators supported by the custom connector.

Type: String

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN

Required: No
Datadog

The operation to be performed on the provided Datadog source ﬁelds.

Type: String

Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION

Required: No

ConnectorOperator API Version 2020-08-23 275

AmazonAppFlow API Reference

Dynatrace

The operation to be performed on the provided Dynatrace source ﬁelds.

Type: String

Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION

Required: No
GoogleAnalytics

The operation to be performed on the provided Google Analytics source ﬁelds.

Type: String

Valid Values: PROJECTION | BETWEEN

Required: No
InforNexus

The operation to be performed on the provided Infor Nexus source ﬁelds.

Type: String

Valid Values: PROJECTION | BETWEEN | EQUAL_TO | ADDITION | MULTIPLICATION

Required: No
Marketo

The operation to be performed on the provided Marketo source ﬁelds.

Type: String

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN |

Contents API Version 2020-08-23 276

AmazonAppFlow API Reference

MASK_FIRST_N | MASK_LAST_N | VALIDATE_NON_NULL | VALIDATE_NON_ZERO |

VALIDATE_NON_NEGATIVE | VALIDATE_NUMERIC | NO_OP

Required: No
Pardot

The operation to be performed on the provided Salesforce Pardot source ﬁelds.

Type: String

Valid Values: PROJECTION | EQUAL_TO | NO_OP | ADDITION | MULTIPLICATION

Required: No
S3

The operation to be performed on the provided Amazon S3 source ﬁelds.

Type: String

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN |

Required: No
Salesforce

The operation to be performed on the provided Salesforce source ﬁelds.

Type: String

Valid Values: PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN

Contents API Version 2020-08-23 277

AmazonAppFlow API Reference

Required: No
SAPOData

The operation to be performed on the provided SAPOData source ﬁelds.

Type: String

Valid Values: PROJECTION | LESS_THAN | CONTAINS | GREATER_THAN | BETWEEN

Required: No
ServiceNow

The operation to be performed on the provided ServiceNow source ﬁelds.

Type: String

Valid Values: PROJECTION | CONTAINS | LESS_THAN | GREATER_THAN | BETWEEN

Required: No
Singular

The operation to be performed on the provided Singular source ﬁelds.

Type: String

Valid Values: PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION |

Required: No
Slack

The operation to be performed on the provided Slack source ﬁelds.

Contents API Version 2020-08-23 278

AmazonAppFlow API Reference

Type: String

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | BETWEEN |

Required: No
Trendmicro

The operation to be performed on the provided Trend Micro source ﬁelds.

Type: String

Valid Values: PROJECTION | EQUAL_TO | ADDITION | MULTIPLICATION | DIVISION |

Required: No
Veeva

The operation to be performed on the provided Veeva source ﬁelds.

Type: String

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN

Required: No
Zendesk

The operation to be performed on the provided Zendesk source ﬁelds.

Type: String

Valid Values: PROJECTION | GREATER_THAN | ADDITION | MULTIPLICATION |

Contents API Version 2020-08-23 279

AmazonAppFlow API Reference

VALIDATE_NON_NULL | VALIDATE_NON_ZERO | VALIDATE_NON_NEGATIVE |

VALIDATE_NUMERIC | NO_OP

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Indicates the connection mode and if it is public or private.

Type: String

Valid Values: Public | Private

Required: No
connectorLabel

The label for the connector proﬁle being created.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
connectorProﬁleArn

The Amazon Resource Name (ARN) of the connector proﬁle.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*

Required: No

ConnectorProﬁle API Version 2020-08-23 281

AmazonAppFlow API Reference

connectorProﬁleName

The name of the connector proﬁle. The name is unique for each ConnectorProfile in the
AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No
connectorProﬁleProperties

The connector-specific properties of the profile configuration.

Type: ConnectorProﬁleProperties object

Required: No
connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
createdAt

Speciﬁes when the connector proﬁle was created.

Type: Timestamp

Required: No
credentialsArn

The Amazon Resource Name (ARN) of the connector proﬁle credentials.

Contents API Version 2020-08-23 282

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: No
lastUpdatedAt

Speciﬁes when the connector proﬁle was last updated.

Type: Timestamp

Required: No
privateConnectionProvisioningState

Speciﬁes the private connection provisioning state.

Type: PrivateConnectionProvisioningState object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The connector-specific properties of the profile configuration.

Type: ConnectorProﬁleProperties object

Required: Yes
connectorProﬁleCredentials

The connector-speciﬁc credentials required by each connector.

Type: ConnectorProﬁleCredentials object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectorProﬁleConﬁg API Version 2020-08-23 284

AmazonAppFlow API Reference

ConnectorProﬁleCredentials
The connector-speciﬁc credentials required by a connector.

Contents
Amplitude

The connector-speciﬁc credentials required when using Amplitude.

Type: AmplitudeConnectorProﬁleCredentials object

Required: No
CustomConnector

The connector-speciﬁc proﬁle credentials that are required when using the custom connector.

Type: CustomConnectorProﬁleCredentials object

Required: No
Datadog

The connector-speciﬁc credentials required when using Datadog.

Type: DatadogConnectorProﬁleCredentials object

Required: No
Dynatrace

The connector-speciﬁc credentials required when using Dynatrace.

Type: DynatraceConnectorProﬁleCredentials object

Required: No
GoogleAnalytics

The connector-speciﬁc credentials required when using Google Analytics.

Type: GoogleAnalyticsConnectorProﬁleCredentials object

Required: No

ConnectorProﬁleCredentials API Version 2020-08-23 285

AmazonAppFlow API Reference

Honeycode

The connector-speciﬁc credentials required when using Amazon Honeycode.

Type: HoneycodeConnectorProﬁleCredentials object

Required: No
InforNexus

The connector-speciﬁc credentials required when using Infor Nexus.

Type: InforNexusConnectorProﬁleCredentials object

Required: No
Marketo

The connector-speciﬁc credentials required when using Marketo.

Type: MarketoConnectorProﬁleCredentials object

Required: No
Pardot

The connector-speciﬁc credentials required when using Salesforce Pardot.

Type: PardotConnectorProﬁleCredentials object

Required: No
Redshift

The connector-speciﬁc credentials required when using Amazon Redshift.

Type: RedshiftConnectorProﬁleCredentials object

Required: No
Salesforce

The connector-speciﬁc credentials required when using Salesforce.

Type: SalesforceConnectorProﬁleCredentials object

Required: No

Contents API Version 2020-08-23 286

AmazonAppFlow API Reference

SAPOData

The connector-speciﬁc proﬁle credentials required when using SAPOData.

Type: SAPODataConnectorProﬁleCredentials object

Required: No
ServiceNow

The connector-speciﬁc credentials required when using ServiceNow.

Type: ServiceNowConnectorProﬁleCredentials object

Required: No
Singular

The connector-speciﬁc credentials required when using Singular.

Type: SingularConnectorProﬁleCredentials object

Required: No
Slack

The connector-speciﬁc credentials required when using Slack.

Type: SlackConnectorProﬁleCredentials object

Required: No
Snowﬂake

The connector-speciﬁc credentials required when using Snowﬂake.

Type: SnowﬂakeConnectorProﬁleCredentials object

Required: No
Trendmicro

The connector-speciﬁc credentials required when using Trend Micro.

Type: TrendmicroConnectorProﬁleCredentials object

Required: No

Contents API Version 2020-08-23 287

AmazonAppFlow API Reference

Veeva

The connector-speciﬁc credentials required when using Veeva.

Type: VeevaConnectorProﬁleCredentials object

Required: No
Zendesk

The connector-speciﬁc credentials required when using Zendesk.

Type: ZendeskConnectorProﬁleCredentials object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The connector-speciﬁc properties required by Amplitude.

Type: AmplitudeConnectorProﬁleProperties object

Required: No
CustomConnector

The properties required by the custom connector.

Type: CustomConnectorProﬁleProperties object

Required: No
Datadog

The connector-speciﬁc properties required by Datadog.

Type: DatadogConnectorProﬁleProperties object

Required: No
Dynatrace

The connector-speciﬁc properties required by Dynatrace.

Type: DynatraceConnectorProﬁleProperties object

Required: No
GoogleAnalytics

The connector-speciﬁc properties required Google Analytics.

Type: GoogleAnalyticsConnectorProﬁleProperties object

Required: No

ConnectorProﬁleProperties API Version 2020-08-23 289

AmazonAppFlow API Reference

Honeycode

The connector-speciﬁc properties required by Amazon Honeycode.

Type: HoneycodeConnectorProﬁleProperties object

Required: No
InforNexus

The connector-speciﬁc properties required by Infor Nexus.

Type: InforNexusConnectorProﬁleProperties object

Required: No
Marketo

The connector-speciﬁc properties required by Marketo.

Type: MarketoConnectorProﬁleProperties object

Required: No
Pardot

The connector-speciﬁc properties required by Salesforce Pardot.

Type: PardotConnectorProﬁleProperties object

Required: No
Redshift

The connector-speciﬁc properties required by Amazon Redshift.

Type: RedshiftConnectorProﬁleProperties object

Required: No
Salesforce

The connector-speciﬁc properties required by Salesforce.

Type: SalesforceConnectorProﬁleProperties object

Required: No

Contents API Version 2020-08-23 290

AmazonAppFlow API Reference

SAPOData

The connector-speciﬁc proﬁle properties required when using SAPOData.

Type: SAPODataConnectorProﬁleProperties object

Required: No
ServiceNow

The connector-speciﬁc properties required by serviceNow.

Type: ServiceNowConnectorProﬁleProperties object

Required: No
Singular

The connector-speciﬁc properties required by Singular.

Type: SingularConnectorProﬁleProperties object

Required: No
Slack

The connector-speciﬁc properties required by Slack.

Type: SlackConnectorProﬁleProperties object

Required: No
Snowﬂake

The connector-speciﬁc properties required by Snowﬂake.

Type: SnowﬂakeConnectorProﬁleProperties object

Required: No
Trendmicro

The connector-speciﬁc properties required by Trend Micro.

Type: TrendmicroConnectorProﬁleProperties object

Required: No

Contents API Version 2020-08-23 291

AmazonAppFlow API Reference

Veeva

The connector-speciﬁc properties required by Veeva.

Type: VeevaConnectorProﬁleProperties object

Required: No
Zendesk

The connector-speciﬁc properties required by Zendesk.

Type: ZendeskConnectorProﬁleProperties object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: LambdaConnectorProvisioningConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ConnectorProvisioningConﬁg API Version 2020-08-23 293

AmazonAppFlow API Reference

ConnectorRuntimeSetting
Contains information about the connector runtime settings that are required for ﬂow execution.

Contents
connectorSuppliedValueOptions

Contains default values for the connector runtime setting that are supplied by the connector.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
dataType

Data type of the connector runtime setting.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
description

A description about the connector runtime setting.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No
isRequired

Indicates whether this connector runtime setting is required.

ConnectorRuntimeSetting API Version 2020-08-23 294

AmazonAppFlow API Reference

Type: Boolean

Required: No
key

Contains value information about the connector runtime setting.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
label

A label used for connector runtime setting.

Type: String

Length Constraints: Maximum length of 128.

Pattern: .*

Required: No
scope

Indicates the scope of the connector runtime setting.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Information about authentication parameters required for authentication.

Type: Array of AuthParameter objects

Required: No
customAuthenticationType

The authentication type that the custom connector uses.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CustomAuthConﬁg API Version 2020-08-23 297

AmazonAppFlow API Reference

CustomAuthCredentials
The custom credentials required for custom authentication.

Contents
customAuthenticationType

The custom authentication type that the connector uses.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes
credentialsMap

A map that holds custom authentication credentials.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

CustomAuthCredentials API Version 2020-08-23 298

AmazonAppFlow API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

The entity speciﬁed in the custom connector as a destination in the ﬂow.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: \S+

Required: Yes
customProperties

The custom properties that are speciﬁc to the connector when it's used as a destination in the
ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

Required: No
errorHandlingConﬁg

The settings that determine how Amazon AppFlow handles an error when placing data in the
custom connector as destination.

Type: ErrorHandlingConﬁg object

CustomConnectorDestinationProperties API Version 2020-08-23 300

AmazonAppFlow API Reference

Required: No
idFieldNames

The name of the ﬁeld that Amazon AppFlow uses as an ID when performing a write operation
such as update, delete, or upsert.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No
writeOperationType

Speciﬁes the type of write operation to be performed in the custom connector when it's used as
destination.

Type: String

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: OAUTH2 | APIKEY | BASIC | CUSTOM

Required: Yes
apiKey

The API keys required for the authentication of the user.

Type: ApiKeyCredentials object

Required: No
basic

The basic credentials that are required for the authentication of the user.

Type: BasicAuthCredentials object

Required: No
custom

If the connector uses the custom authentication mechanism, this holds the required credentials.

Type: CustomAuthCredentials object

Required: No
oauth2

The OAuth 2.0 credentials required for the authentication of the user.

Type: OAuth2Credentials object

CustomConnectorProﬁleCredentials API Version 2020-08-23 302

AmazonAppFlow API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The OAuth 2.0 properties required for OAuth 2.0 authentication.

Type: OAuth2Properties object

Required: No
proﬁleProperties

A map of properties that are required to create a proﬁle for the custom connector.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CustomConnectorProﬁleProperties API Version 2020-08-23 304

AmazonAppFlow API Reference

CustomConnectorSourceProperties
The properties that are applied when the custom connector is being used as a source.

Contents
entityName

The entity speciﬁed in the custom connector as a source in the ﬂow.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: \S+

Required: Yes
customProperties

Custom properties that are required to use the custom connector as a source.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

Required: No
dataTransferApi

The API of the connector application that Amazon AppFlow uses to transfer your data.

Type: DataTransferApi object

Required: No

CustomConnectorSourceProperties API Version 2020-08-23 305

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The unique name of the Amazon Connect Customer Proﬁles domain.

Type: String

Length Constraints: Maximum length of 64.

Pattern: \S+

Required: Yes
objectTypeName

The object specified in the Amazon Connect Customer Profiles flow destination.

Type: String

Length Constraints: Maximum length of 255.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CustomerProﬁlesDestinationProperties API Version 2020-08-23 307

AmazonAppFlow API Reference

CustomerProfilesMetadata
The connector metadata specific to Amazon Connect Customer Profiles.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

CustomerProﬁlesMetadata API Version 2020-08-23 308

AmazonAppFlow API Reference

DatadogConnectorProﬁleCredentials
The connector-speciﬁc credentials required by Datadog.

Contents
apiKey

A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to

your API.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes
applicationKey

Application keys, in conjunction with your API key, give you full access to Datadog’s
programmatic API. Application keys are associated with the user account that created them. The
application key is used to log all requests made to the API.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DatadogConnectorProﬁleCredentials API Version 2020-08-23 309

AmazonAppFlow API Reference

The location of the Datadog resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DatadogConnectorProﬁleProperties API Version 2020-08-23 311

AmazonAppFlow API Reference

DatadogMetadata
The connector metadata speciﬁc to Datadog.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DatadogMetadata API Version 2020-08-23 312

AmazonAppFlow API Reference

DatadogSourceProperties
The properties that are applied when Datadog is being used as a source.

Contents
object

The object speciﬁed in the Datadog ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DatadogSourceProperties API Version 2020-08-23 313

AmazonAppFlow API Reference

DataTransferApi
The API of the connector application that Amazon AppFlow uses to transfer your data.

Contents
Name

The name of the connector application API.

Type: String

Length Constraints: Maximum length of 64.

Pattern: [\w/-]+

Required: No

Type

You can specify one of the following types:

AUTOMATIC

The default. Optimizes a flow for datasets that fluctuate in size from small to large. For
each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the
amount of data that the run transfers.

SYNC

A synchronous API. This type of API optimizes a ﬂow for small to medium-sized datasets.

ASYNC

An asynchronous API. This type of API optimizes a ﬂow for large datasets.

Type: String

Valid Values: SYNC | ASYNC | AUTOMATIC

Required: No

DataTransferApi API Version 2020-08-23 314

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The properties that are required to query the custom Connector.

Type: CustomConnectorDestinationProperties object

Required: No
CustomerProﬁles

The properties required to query Amazon Connect Customer Proﬁles.

Type: CustomerProﬁlesDestinationProperties object

Required: No
EventBridge

The properties required to query Amazon EventBridge.

Type: EventBridgeDestinationProperties object

Required: No
Honeycode

The properties required to query Amazon Honeycode.

Type: HoneycodeDestinationProperties object

Required: No
LookoutMetrics

The properties required to query Amazon Lookout for Metrics.

Type: LookoutMetricsDestinationProperties object

Required: No

DestinationConnectorProperties API Version 2020-08-23 316

AmazonAppFlow API Reference

Marketo

The properties required to query Marketo.

Type: MarketoDestinationProperties object

Required: No
Redshift

The properties required to query Amazon Redshift.

Type: RedshiftDestinationProperties object

Required: No
S3

The properties required to query Amazon S3.

Type: S3DestinationProperties object

Required: No
Salesforce

The properties required to query Salesforce.

Type: SalesforceDestinationProperties object

Required: No
SAPOData

The properties required to query SAPOData.

Type: SAPODataDestinationProperties object

Required: No
Snowﬂake

The properties required to query Snowﬂake.

Type: SnowﬂakeDestinationProperties object

Required: No

Contents API Version 2020-08-23 317

AmazonAppFlow API Reference

Upsolver

The properties required to query Upsolver.

Type: UpsolverDestinationProperties object

Required: No
Zendesk

The properties required to query Zendesk.

Type: ZendeskDestinationProperties object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Speciﬁes if the destination ﬁeld can be created by the current user.

Type: Boolean

Required: No
isDefaultedOnCreate

Speciﬁes whether the ﬁeld can use the default value during a Create operation.

Type: Boolean

Required: No
isNullable

Speciﬁes if the destination ﬁeld can have a null value.

Type: Boolean

Required: No
isUpdatable

Speciﬁes whether the ﬁeld can be updated during an UPDATE or UPSERT write operation.

Type: Boolean

Required: No
isUpsertable

Specifies if the flow run can either insert new rows in the destination field if they do not already
exist, or update them if they do.

Type: Boolean

Required: No

DestinationFieldProperties API Version 2020-08-23 319

AmazonAppFlow API Reference

supportedWriteOperations

A list of supported write operations. For each write operation listed, this ﬁeld can be used in
idFieldNames when that write operation is present as a destination option.

Type: Array of strings

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: Yes
destinationConnectorProperties

This stores the information that is required to query a particular connector.

Type: DestinationConnectorProperties object

Required: Yes
apiVersion

The API version that the destination connector uses.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorProﬁleName

The name of the connector proﬁle. This name must be unique for each connector proﬁle in the
AWS account.

DestinationFlowConﬁg API Version 2020-08-23 321

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DynatraceConnectorProﬁleCredentials API Version 2020-08-23 323

AmazonAppFlow API Reference

DynatraceConnectorProfileProperties
The connector-specific profile properties required by Dynatrace.

Contents
instanceUrl

The location of the Dynatrace resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DynatraceConnectorProﬁleProperties API Version 2020-08-23 324

AmazonAppFlow API Reference

DynatraceMetadata
The connector metadata speciﬁc to Dynatrace.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DynatraceMetadata API Version 2020-08-23 325

AmazonAppFlow API Reference

DynatraceSourceProperties
The properties that are applied when Dynatrace is being used as a source.

Contents
object

The object speciﬁed in the Dynatrace ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

DynatraceSourceProperties API Version 2020-08-23 326

AmazonAppFlow API Reference

ErrorHandlingConﬁg
The settings that determine how Amazon AppFlow handles an error when placing data in
the destination. For example, this setting would determine if the ﬂow should fail after one
insertion error, or continue and attempt to insert every record regardless of the initial failure.
ErrorHandlingConfig is a part of the destination connector details.

Contents
bucketName

Speciﬁes the name of the Amazon S3 bucket.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: No
bucketPreﬁx

Speciﬁes the Amazon S3 bucket preﬁx.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
failOnFirstDestinationError

Specifies if the flow should fail after the first instance of a failure when attempting to place
data in the destination.

Type: Boolean

Required: No

ErrorHandlingConﬁg API Version 2020-08-23 327

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Speciﬁes the error message that appears if a ﬂow fails.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\s\w/!@#+=.-]*

Required: No
putFailuresCount

Speciﬁes the failure count for the attempted ﬂow.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ErrorInfo API Version 2020-08-23 329

AmazonAppFlow API Reference

EventBridgeDestinationProperties
The properties that are applied when Amazon EventBridge is being used as a destination.

Contents
object

The object speciﬁed in the Amazon EventBridge ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
errorHandlingConﬁg

The settings that determine how Amazon AppFlow handles an error when placing data in
the destination. For example, this setting would determine if the ﬂow should fail after one
insertion error, or continue and attempt to insert every record regardless of the initial failure.
ErrorHandlingConfig is a part of the destination connector details.

Type: ErrorHandlingConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EventBridgeDestinationProperties API Version 2020-08-23 330

AmazonAppFlow API Reference

EventBridgeMetadata
The connector metadata speciﬁc to Amazon EventBridge.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

EventBridgeMetadata API Version 2020-08-23 331

AmazonAppFlow API Reference

ExecutionDetails
Describes the details of the ﬂow run, including the timestamp, status, and message.

Contents
mostRecentExecutionMessage

Describes the details of the most recent ﬂow run.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
mostRecentExecutionStatus

Speciﬁes the status of the most recent ﬂow run.

Type: String

Valid Values: InProgress | Successful | Error | CancelStarted | Canceled

Required: No
mostRecentExecutionTime

Speciﬁes the time of the most recent ﬂow run.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

ExecutionDetails API Version 2020-08-23 332

AmazonAppFlow API Reference

• AWS SDK for Ruby V3

Specifies the identifier of the given flow run.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
executionResult

Describes the result of the given ﬂow run.

Type: ExecutionResult object

Required: No
executionStatus

Speciﬁes the ﬂow run status and whether it is in progress, has completed successfully, or has
failed.

ExecutionRecord API Version 2020-08-23 334

AmazonAppFlow API Reference

Type: String

Valid Values: InProgress | Successful | Error | CancelStarted | Canceled

Required: No
lastUpdatedAt

Speciﬁes the time of the most recent update.

Type: Timestamp

Required: No
metadataCatalogDetails

Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow
used for the associated ﬂow run.

Type: Array of MetadataCatalogDetail objects

Required: No
startedAt

Speciﬁes the start time of the ﬂow run.

Type: Timestamp

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The total number of bytes processed by the ﬂow run.

Type: Long

Required: No
bytesWritten

The total number of bytes written as a result of the ﬂow run.

Type: Long

Required: No
errorInfo

Provides any error message information related to the ﬂow run.

Type: ErrorInfo object

Required: No
maxPageSize

The maximum number of records that Amazon AppFlow receives in each page of the response
from your SAP application.

Type: Long

Required: No
numParallelProcesses

The number of processes that Amazon AppFlow ran at the same time when it retrieved your
data.

Type: Long

ExecutionResult API Version 2020-08-23 336

AmazonAppFlow API Reference

Required: No
recordsProcessed

The number of records processed in the ﬂow run.

Type: Long

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The type of ﬁeld, such as string, integer, date, and so on.

Type: String

Required: Yes
ﬁlterOperators

The list of operators supported by a ﬁeld.

Type: Array of strings

Valid Values: PROJECTION | LESS_THAN | GREATER_THAN | CONTAINS | BETWEEN

Required: Yes
ﬁeldLengthRange

This is the allowable length range for this ﬁeld's value.

Type: Range object

Required: No
ﬁeldValueRange

The range of values this ﬁeld can hold.

Type: Range object

Required: No

FieldTypeDetails API Version 2020-08-23 338

AmazonAppFlow API Reference

supportedDateFormat

The date format that the ﬁeld supports.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: No
supportedValues

The list of values that a ﬁeld can contain. For example, a Boolean fieldType can have two
values: "true" and "false".

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No
valueRegexPattern

The regular expression pattern for the ﬁeld name.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

• AWS SDK for Ruby V3

Speciﬁes when the ﬂow was created.

Type: Timestamp

Required: No
createdBy

The ARN of the user who created the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
description

A user-entered description of the ﬂow.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\w!@#\-.?,\s]*

Required: No
destinationConnectorLabel

The label of the destination connector in the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

FlowDeﬁnition API Version 2020-08-23 341

AmazonAppFlow API Reference

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
destinationConnectorType

Speciﬁes the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
ﬂowArn

The ﬂow's Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:appflow:.*:[0-9]+:.*

Required: No
ﬂowName

The speciﬁed name of the ﬂow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
ﬂowStatus

Indicates the current status of the ﬂow.

Type: String

Contents API Version 2020-08-23 342

AmazonAppFlow API Reference

Valid Values: Active | Deprecated | Deleted | Draft | Errored | Suspended

Required: No
lastRunExecutionDetails

Describes the details of the most recent ﬂow run.

Type: ExecutionDetails object

Required: No
lastUpdatedAt

Speciﬁes when the ﬂow was last updated.

Type: Timestamp

Required: No
lastUpdatedBy

Speciﬁes the account user name that most recently updated the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
sourceConnectorLabel

The label of the source connector in the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No
sourceConnectorType

Speciﬁes the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on.

Contents API Version 2020-08-23 343

AmazonAppFlow API Reference

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: No
tags

The tags used to organize, track, or control access for your ﬂow.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Value Pattern: [\s\w+-=\.:/@]*

Required: No
triggerType

Speciﬁes the type of ﬂow trigger. This can be OnDemand, Scheduled, or Event.

Type: String

Valid Values: Scheduled | Event | OnDemand

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes
roleArn

The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions
it needs to create Data Catalog tables, databases, and partitions.

For an example IAM policy that has the required permissions, see Identity-based policy
examples for Amazon AppFlow.

GlueDataCatalogConﬁg API Version 2020-08-23 346

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:iam:.*:[0-9]+:.*

Required: Yes
tablePreﬁx

A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you
configure with this setting. Amazon AppFlow adds the prefix to the beginning of the each table
name.

Type: String

Length Constraints: Maximum length of 128.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The identiﬁer for the desired client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
accessToken

The credentials used to access protected Google Analytics resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

GoogleAnalyticsConnectorProﬁleCredentials API Version 2020-08-23 348

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The credentials used to acquire new access tokens. This is required only for OAuth2 access
tokens, and is not required for OAuth1 access tokens.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

GoogleAnalyticsConnectorProﬁleProperties API Version 2020-08-23 350

AmazonAppFlow API Reference

GoogleAnalyticsMetadata
The connector metadata speciﬁc to Google Analytics.

Contents
oAuthScopes

The desired authorization scope for the Google Analytics account.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

GoogleAnalyticsMetadata API Version 2020-08-23 351

AmazonAppFlow API Reference

GoogleAnalyticsSourceProperties
The properties that are applied when Google Analytics is being used as a source.

Contents
object

The object speciﬁed in the Google Analytics ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

GoogleAnalyticsSourceProperties API Version 2020-08-23 352

AmazonAppFlow API Reference

HoneycodeConnectorProﬁleCredentials
The connector-speciﬁc credentials required when using Amazon Honeycode.

Contents
accessToken

The credentials used to access protected Amazon Honeycode resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce,
Google Analytics, Marketo, Zendesk, and Slack.

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The credentials used to acquire new access tokens.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

HoneycodeConnectorProﬁleCredentials API Version 2020-08-23 353

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

HoneycodeConnectorProﬁleProperties API Version 2020-08-23 355

AmazonAppFlow API Reference

HoneycodeDestinationProperties
The properties that are applied when Amazon Honeycode is used as a destination.

Contents
object

The object speciﬁed in the Amazon Honeycode ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
errorHandlingConﬁg

Type: ErrorHandlingConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

HoneycodeDestinationProperties API Version 2020-08-23 356

AmazonAppFlow API Reference

HoneycodeMetadata
The connector metadata speciﬁc to Amazon Honeycode.

Contents
oAuthScopes

The desired authorization scope for the Amazon Honeycode account.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

HoneycodeMetadata API Version 2020-08-23 357

AmazonAppFlow API Reference

IncrementalPullConfig
Specifies the configuration used when importing incremental records from the source.

Contents
datetimeTypeFieldName

A field that specifies the date time or timestamp field as the criteria to use when importing
incremental records from the source.

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

IncrementalPullConﬁg API Version 2020-08-23 358

AmazonAppFlow API Reference

InforNexusConnectorProfileCredentials
The connector-specific profile credentials required by Infor Nexus.

Contents
accessKeyId

The Access Key portion of the credentials.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes
datakey

The encryption keys used to encrypt data.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
secretAccessKey

The secret key used to sign requests.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
userId

The identiﬁer for the user.

InforNexusConnectorProﬁleCredentials API Version 2020-08-23 359

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the Infor Nexus resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

InforNexusConnectorProﬁleProperties API Version 2020-08-23 361

AmazonAppFlow API Reference

InforNexusMetadata
The connector metadata speciﬁc to Infor Nexus.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

InforNexusMetadata API Version 2020-08-23 362

AmazonAppFlow API Reference

InforNexusSourceProperties
The properties that are applied when Infor Nexus is being used as a source.

Contents
object

The object speciﬁed in the Infor Nexus ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

InforNexusSourceProperties API Version 2020-08-23 363

AmazonAppFlow API Reference

LambdaConnectorProvisioningConﬁg
Contains information about the conﬁguration of the lambda which is being registered as the
connector.

Contents
lambdaArn

Lambda ARN of the connector being registered.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

LambdaConnectorProvisioningConﬁg API Version 2020-08-23 364

AmazonAppFlow API Reference

LookoutMetricsDestinationProperties
The properties that are applied when Amazon Lookout for Metrics is used as a destination.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

LookoutMetricsDestinationProperties API Version 2020-08-23 365

AmazonAppFlow API Reference

MarketoConnectorProfileCredentials
The connector-specific profile credentials required by Marketo.

Contents
clientId

The identiﬁer for the desired client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
accessToken

The credentials used to access protected Marketo resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

MarketoConnectorProﬁleCredentials API Version 2020-08-23 366

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the Marketo resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MarketoConnectorProﬁleProperties API Version 2020-08-23 368

AmazonAppFlow API Reference

MarketoDestinationProperties
The properties that Amazon AppFlow applies when you use Marketo as a ﬂow destination.

Contents
object

The object speciﬁed in the Marketo ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
errorHandlingConﬁg

Type: ErrorHandlingConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MarketoDestinationProperties API Version 2020-08-23 369

AmazonAppFlow API Reference

MarketoMetadata
The connector metadata speciﬁc to Marketo.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MarketoMetadata API Version 2020-08-23 370

AmazonAppFlow API Reference

MarketoSourceProperties
The properties that are applied when Marketo is being used as a source.

Contents
object

The object speciﬁed in the Marketo ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MarketoSourceProperties API Version 2020-08-23 371

AmazonAppFlow API Reference

MetadataCatalogConfig
Specifies the configuration that Amazon AppFlow uses when it catalogs your data. When Amazon
AppFlow catalogs your data, it stores metadata in a data catalog.

Contents
glueDataCatalog

Speciﬁes the conﬁguration that Amazon AppFlow uses when it catalogs your data with the AWS
Glue Data Catalog.

Type: GlueDataCatalogConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

MetadataCatalogConﬁg API Version 2020-08-23 372

AmazonAppFlow API Reference

MetadataCatalogDetail
Describes the metadata catalog, metadata table, and data partitions that Amazon AppFlow used
for the associated ﬂow run.

Contents
catalogType

The type of metadata catalog that Amazon AppFlow used for the associated ﬂow run. This
parameter returns the following value:
GLUE

The metadata catalog is provided by the AWS Glue Data Catalog. AWS Glue includes the
AWS Glue Data Catalog as a component.

Type: String

Valid Values: GLUE

Required: No
partitionRegistrationOutput

Describes the status of the attempt from Amazon AppFlow to register the data partitions with
the metadata catalog. The data partitions organize the flow output into a hierarchical path,
such as a folder path in an S3 bucket. Amazon AppFlow creates the partitions (if they don't
already exist) based on your flow configuration.

Type: RegistrationOutput object

Required: No
tableName

The name of the table that stores the metadata for the associated ﬂow run. The table stores
metadata that represents the data that the ﬂow transferred. Amazon AppFlow stores the table
in the metadata catalog.

Type: String

Length Constraints: Maximum length of 2048.

MetadataCatalogDetail API Version 2020-08-23 373

AmazonAppFlow API Reference

Pattern: .*

Required: No
tableRegistrationOutput

Describes the status of the attempt from Amazon AppFlow to register the metadata table with
the metadata catalog. Amazon AppFlow creates or updates this table for the associated ﬂow
run.

Type: RegistrationOutput object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The access token used to access the connector on your behalf.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
clientId

The identiﬁer for the desired client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
oAuthRequest

Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce,
Google Analytics, Marketo, Zendesk, and Slack.

OAuth2Credentials API Version 2020-08-23 375

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The refresh token used to refresh an expired access token.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
description

A description about the custom parameter used for OAuth 2.0 authentication.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\s\w/!@#+=.-]*

Required: No
isRequired

Indicates whether the custom parameter for OAuth 2.0 authentication is required.

Type: Boolean

Required: No
isSensitiveField

Indicates whether this authentication custom parameter is a sensitive ﬁeld.

Type: Boolean

Required: No

OAuth2CustomParameter API Version 2020-08-23 377

AmazonAppFlow API Reference

key

The key of the custom parameter required for OAuth 2.0 authentication.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
label

The label of the custom parameter used for OAuth 2.0 authentication.

Type: String

Length Constraints: Maximum length of 128.

Pattern: .*

Required: No
type

Indicates whether custom parameter is used with TokenUrl or AuthUrl.

Type: String

Valid Values: TOKEN_URL | AUTH_URL

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: No
oauth2CustomProperties

List of custom parameters required for OAuth 2.0 authentication.

Type: Array of OAuth2CustomParameter objects

Required: No
oauth2GrantTypesSupported

OAuth 2.0 grant types supported by the connector.

Type: Array of strings

Valid Values: CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER

Required: No
oauthScopes

OAuth 2.0 scopes that the connector supports.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

OAuth2Defaults API Version 2020-08-23 379

AmazonAppFlow API Reference

Required: No
tokenUrls

Token URLs that can be used for OAuth 2.0 authentication.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER

Required: Yes
tokenUrl

The token URL required for OAuth 2.0 authentication.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: Yes
tokenUrlCustomProperties

Associates your token URL with a map of properties that you deﬁne. Use this parameter to
provide any additional details that the connector requires to authenticate your request.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [\w]+

Value Length Constraints: Maximum length of 2048.

Value Pattern: \S+

OAuth2Properties API Version 2020-08-23 381

AmazonAppFlow API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The identiﬁer for the desired client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
accessToken

The access token used to access protected SAPOData resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

OAuthCredentials API Version 2020-08-23 383

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The refresh token used to refresh expired access token.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: Yes
oAuthScopes

The OAuth scopes required for OAuth type authentication.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: Yes
tokenUrl

The token url required to fetch access/refresh tokens using authorization code and also to
refresh expired access token using refresh token.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: Yes

OAuthProperties API Version 2020-08-23 385

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The credentials used to access protected Salesforce Pardot resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
clientCredentialsArn

The secret manager ARN, which contains the client ID and client secret of the connected app.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:secretsmanager:.*:[0-9]+:.*

Required: No
oAuthRequest

Used by select connectors for which the OAuth workﬂow is supported, such as Salesforce,
Google Analytics, Marketo, Zendesk, and Slack.

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The credentials used to acquire new access tokens.

Type: String

PardotConnectorProﬁleCredentials API Version 2020-08-23 387

AmazonAppFlow API Reference

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The business unit id of Salesforce Pardot instance.

Type: String

Length Constraints: Maximum length of 18.

Pattern: \S+

Required: No
instanceUrl

The location of the Salesforce Pardot resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
isSandboxEnvironment

Indicates whether the connector proﬁle applies to a sandbox or production environment.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

PardotConnectorProﬁleProperties API Version 2020-08-23 389

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

PardotMetadata API Version 2020-08-23 391

AmazonAppFlow API Reference

PardotSourceProperties
The properties that are applied when Salesforce Pardot is being used as a source.

Contents
object

The object speciﬁed in the Salesforce Pardot ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

PardotSourceProperties API Version 2020-08-23 392

AmazonAppFlow API Reference

PrefixConfig
Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
destination.

Contents
pathPreﬁxHierarchy

Speciﬁes whether the destination ﬁle path includes either or both of the following elements:
EXECUTION_ID

The ID that Amazon AppFlow assigns to the ﬂow run.

SCHEMA_VERSION

Type: Array of strings

Valid Values: EXECUTION_ID | SCHEMA_VERSION

Required: No
preﬁxFormat

Determines the level of granularity for the date and time that's included in the preﬁx.

Type: String

Valid Values: YEAR | MONTH | DAY | HOUR | MINUTE

Required: No
preﬁxType

Determines the format of the prefix, and whether it applies to the file name, file path, or both.

PreﬁxConﬁg API Version 2020-08-23 393

AmazonAppFlow API Reference

Type: String

Valid Values: FILENAME | PATH | PATH_AND_FILENAME

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Speciﬁes the private connection provisioning failure cause.

Type: String

Valid Values: CONNECTOR_AUTHENTICATION | CONNECTOR_SERVER | INTERNAL_SERVER

| ACCESS_DENIED | VALIDATION

Required: No
failureMessage

Speciﬁes the private connection provisioning failure reason.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: [\s\w/!@#+=.-]*

Required: No
status

Speciﬁes the private connection provisioning status.

Type: String

Valid Values: FAILED | PENDING | CREATED

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

PrivateConnectionProvisioningState API Version 2020-08-23 395

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Maximum value supported by the ﬁeld.

Type: Double

Required: No
minimum

Minimum value supported by the ﬁeld.

Type: Double

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Range API Version 2020-08-23 397

AmazonAppFlow API Reference

RedshiftConnectorProfileCredentials
The connector-specific profile credentials required when using Amazon Redshift.

Contents
password

The password that corresponds to the user name.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
username

The name of the user.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RedshiftConnectorProﬁleCredentials API Version 2020-08-23 398

AmazonAppFlow API Reference

RedshiftConnectorProfileProperties
The connector-specific profile properties when using Amazon Redshift.

Contents
bucketName

A name for the associated Amazon S3 bucket.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
roleArn

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access
to Amazon S3. For more information, and for the polices that you attach to this role, see Allow
Amazon Redshift to access your Amazon AppFlow data in Amazon S3.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:iam:.*:[0-9]+:.*

Required: Yes
bucketPreﬁx

The object key for the destination bucket in which Amazon AppFlow places the ﬁles.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

RedshiftConnectorProﬁleProperties API Version 2020-08-23 399

AmazonAppFlow API Reference

clusterIdentiﬁer

The unique ID that's assigned to an Amazon Redshift cluster.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
dataApiRoleArn

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your
Amazon Redshift database through the Data API. For more information, and for the polices that
you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with
the Data API.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:iam:.*:[0-9]+:.*

Required: No
databaseName

The name of an Amazon Redshift database.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
databaseUrl

The JDBC URL of the Amazon Redshift cluster.

Type: String

Length Constraints: Maximum length of 512.

Contents API Version 2020-08-23 400

AmazonAppFlow API Reference

Pattern: \S+

Required: No
isRedshiftServerless

Indicates whether the connector proﬁle deﬁnes a connection to an Amazon Redshift Serverless
data warehouse.

Type: Boolean

Required: No
workgroupName

The name of an Amazon Redshift workgroup.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
object

The object speciﬁed in the Amazon Redshift ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
bucketPreﬁx

The object key for the bucket in which Amazon AppFlow places the destination ﬁles.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
errorHandlingConﬁg

The settings that determine how Amazon AppFlow handles an error when placing data in the
Amazon Redshift destination. For example, this setting would determine if the ﬂow should fail

RedshiftDestinationProperties API Version 2020-08-23 402

AmazonAppFlow API Reference

after one insertion error, or continue and attempt to insert every record regardless of the initial
failure. ErrorHandlingConfig is a part of the destination connector details.

Type: ErrorHandlingConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

RedshiftMetadata API Version 2020-08-23 404

AmazonAppFlow API Reference

RegistrationOutput
Describes the status of an attempt from Amazon AppFlow to register a resource.

When you run a ﬂow that you've conﬁgured to use a metadata catalog, Amazon AppFlow registers
a metadata table and data partitions with that catalog. This operation provides the status of that
registration attempt. The operation also indicates how many related resources Amazon AppFlow
created or updated.

Contents
message

Explains the status of the registration attempt from Amazon AppFlow. If the attempt fails, the
message explains why.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: No
result

Indicates the number of resources that Amazon AppFlow created or updated. Possible resources
include metadata tables and data partitions.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: No
status

Indicates the status of the registration attempt from Amazon AppFlow.

Type: String

Valid Values: InProgress | Successful | Error | CancelStarted | Canceled

RegistrationOutput API Version 2020-08-23 405

AmazonAppFlow API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
bucketPreﬁx

The object key for the destination bucket in which Amazon AppFlow places the ﬁles.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
s3OutputFormatConﬁg

The conﬁguration that determines how Amazon AppFlow should format the ﬂow output data
when Amazon S3 is used as the destination.

Type: S3OutputFormatConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

S3DestinationProperties API Version 2020-08-23 407

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: CSV | JSON

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

S3InputFormatConﬁg API Version 2020-08-23 409

AmazonAppFlow API Reference

S3Metadata
The connector metadata speciﬁc to Amazon S3.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

S3Metadata API Version 2020-08-23 410

AmazonAppFlow API Reference

S3OutputFormatConfig
The configuration that determines how Amazon AppFlow should format the flow output data
when Amazon S3 is used as the destination.

Contents
aggregationConﬁg

The aggregation settings that you can use to customize the output format of your ﬂow data.

Type: AggregationConﬁg object

Required: No
ﬁleType

Indicates the ﬁle type that Amazon AppFlow places in the Amazon S3 bucket.

Type: String

Valid Values: CSV | JSON | PARQUET

Required: No
preﬁxConﬁg

Determines the preﬁx that Amazon AppFlow applies to the folder name in the Amazon S3
bucket. You can name folders according to the ﬂow frequency and date.

Type: PreﬁxConﬁg object

Required: No
preserveSourceDataTyping

If your ﬁle 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.
• true: Amazon AppFlow preserves the data types when it writes to Amazon S3. For example,
an integer or 1 in your source data is still an integer in your output.
• false: Amazon AppFlow converts all of the source data into strings when it writes to
Amazon S3. For example, an integer of 1 in your source data becomes the string "1" in the
output.

S3OutputFormatConﬁg API Version 2020-08-23 411

AmazonAppFlow API Reference

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
bucketPreﬁx

The object key for the Amazon S3 bucket in which the source ﬁles are stored.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
s3InputFormatConﬁg

When you use Amazon S3 as the source, the conﬁguration format that you provide the ﬂow
input data.

Type: S3InputFormatConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

S3SourceProperties API Version 2020-08-23 413

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The credentials used to access protected Salesforce resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
clientCredentialsArn

The secret manager ARN, which contains the client ID and client secret of the connected app.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws:secretsmanager:.*:[0-9]+:.*

Required: No
jwtToken

A JSON web token (JWT) that authorizes Amazon AppFlow to access your Salesforce records.

Type: String

Length Constraints: Maximum length of 8000.

Pattern: ^([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_=]+)\.([a-zA-Z0-9_\-\+\/=]*)

Required: No
oAuth2GrantType

Speciﬁes the OAuth 2.0 grant type that Amazon AppFlow uses when it requests an access token
from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your
Salesforce records.

SalesforceConnectorProﬁleCredentials API Version 2020-08-23 415

AmazonAppFlow API Reference

You can specify one of the following values:

AUTHORIZATION_CODE

Amazon AppFlow passes an authorization code when it requests the access token from
Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in
to your Salesforce account and authorize Amazon AppFlow to access your records.
JWT_BEARER

Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from
Salesforce. You provide the JWT to Amazon AppFlow when you deﬁne the connection to
your Salesforce account. When you use this grant type, you don't need to log in to your
Salesforce account to authorize Amazon AppFlow to access your records.

Note
The CLIENT_CREDENTIALS value is not supported for Salesforce.

Type: String

Valid Values: CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

Type: ConnectorOAuthRequest object

Required: No
refreshToken

The credentials used to acquire new access tokens.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No

Contents API Version 2020-08-23 416

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the Salesforce resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
isSandboxEnvironment

Indicates whether the connector proﬁle applies to a sandbox or production environment.

Type: Boolean

Required: No
usePrivateLinkForMetadataAndAuthorization

If the connection mode for the connector proﬁle is private, this parameter sets whether Amazon
AppFlow uses the private network to send metadata and authorization calls to Salesforce.
Amazon AppFlow sends private calls through AWS PrivateLink. These calls travel through AWS
infrastructure without being exposed to the public internet.

Set either of the following values:

true

Amazon AppFlow sends all calls to Salesforce over the private network.

These private calls are:

• Calls to get metadata about your Salesforce records. This metadata describes your
Salesforce objects and their ﬁelds.
• Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce
records.

SalesforceConnectorProﬁleProperties API Version 2020-08-23 418

AmazonAppFlow API Reference

• Calls to transfer your Salesforce records as part of a ﬂow run.

false

The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls
over the public internet.

The public calls are:

• Calls to get metadata about your Salesforce records.
• Calls to get or refresh access tokens.

The private calls are:

• Calls to transfer your Salesforce records as part of a ﬂow run.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The object speciﬁed in the Salesforce ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
dataTransferApi

Speciﬁes which Salesforce API is used by Amazon AppFlow when your ﬂow transfers data to
Salesforce.
AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that
your flow transfers to Salesforce. If your flow transfers fewer than 1,000 records, Amazon
AppFlow uses Salesforce REST API. If your flow transfers 1,000 records or more, Amazon
AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the
API automatically, be aware that, for recurring flows, the data output might vary from one
flow run to the next. For example, if a flow runs daily, it might use REST API on one day to
transfer 900 records, and it might use Bulk API 2.0 on the next day to transfer 1,100 records.
For each of these flow runs, the respective Salesforce API formats the data differently. Some
of the differences include how dates are formatted and null values are represented. Also,
Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize ﬂow performance for both small and large data
transfers, but the tradeoﬀ is inconsistent formatting in the output.

SalesforceDestinationProperties API Version 2020-08-23 420

AmazonAppFlow API Reference

BULKV2

Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data
transfers, and it's optimal for large sets of data. By choosing this option, you ensure that
your ﬂow writes consistent output, but you optimize performance only for large data
transfers.

Note that Bulk API 2.0 does not transfer Salesforce compound ﬁelds.
REST_SYNC

Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that
your ﬂow writes consistent output, but you decrease performance for large data transfers
that are better suited for Bulk API 2.0. In some cases, if your ﬂow attempts to transfer a vary
large set of data, it might fail with a timed out error.

Type: String

Valid Values: AUTOMATIC | BULKV2 | REST_SYNC

Required: No
errorHandlingConﬁg

The settings that determine how Amazon AppFlow handles an error when placing data in the
Salesforce destination. For example, this setting would determine if the ﬂow should fail after
one insertion error, or continue and attempt to insert every record regardless of the initial
failure. ErrorHandlingConfig is a part of the destination connector details.

Type: ErrorHandlingConﬁg object

Required: No
idFieldNames

The name of the ﬁeld that Amazon AppFlow uses as an ID when performing a write operation
such as update or delete.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Maximum length of 128.

Contents API Version 2020-08-23 421

AmazonAppFlow API Reference

Pattern: \S+

Required: No
writeOperationType

This speciﬁes the type of write operation to be performed in Salesforce. When the value is
UPSERT, then idFieldNames is required.

Type: String

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Valid Values: AUTOMATIC | BULKV2 | REST_SYNC

Required: No
oauth2GrantTypesSupported

The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token
from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your
Salesforce records.
AUTHORIZATION_CODE

Note
The CLIENT_CREDENTIALS value is not supported for Salesforce.

Type: Array of strings

SalesforceMetadata API Version 2020-08-23 423

AmazonAppFlow API Reference

Valid Values: CLIENT_CREDENTIALS | AUTHORIZATION_CODE | JWT_BEARER

Required: No
oAuthScopes

The desired authorization scope for the Salesforce account.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The object speciﬁed in the Salesforce ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
dataTransferApi

Speciﬁes which Salesforce API is used by Amazon AppFlow when your ﬂow transfers data from
Salesforce.
AUTOMATIC

The default. Amazon AppFlow selects which API to use based on the number of records that
your flow transfers from Salesforce. If your flow transfers fewer than 1,000,000 records,
Amazon AppFlow uses Salesforce REST API. If your flow transfers 1,000,000 records or more,
Amazon AppFlow uses Salesforce Bulk API 2.0.

Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the
API automatically, be aware that, for recurring flows, the data output might vary from
one flow run to the next. For example, if a flow runs daily, it might use REST API on one
day to transfer 900,000 records, and it might use Bulk API 2.0 on the next day to transfer
1,100,000 records. For each of these flow runs, the respective Salesforce API formats the
data differently. Some of the differences include how dates are formatted and null values
are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields.

By choosing this option, you optimize ﬂow performance for both small and large data
transfers, but the tradeoﬀ is inconsistent formatting in the output.

SalesforceSourceProperties API Version 2020-08-23 425

AmazonAppFlow API Reference

BULKV2

Note that Bulk API 2.0 does not transfer Salesforce compound ﬁelds.
REST_SYNC

Type: String

Valid Values: AUTOMATIC | BULKV2 | REST_SYNC

Required: No
enableDynamicFieldUpdate

The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects
while running a flow.

Type: Boolean

Required: No
includeDeletedRecords

Indicates whether Amazon AppFlow includes deleted ﬁles in the ﬂow run.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The SAPOData basic authentication credentials.

Type: BasicAuthCredentials object

Required: No
oAuthCredentials

The SAPOData OAuth type authentication credentials.

Type: OAuthCredentials object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SAPODataConnectorProﬁleCredentials API Version 2020-08-23 428

AmazonAppFlow API Reference

SAPODataConnectorProfileProperties
The connector-specific profile properties required when using SAPOData.

Contents
applicationHostUrl

The location of the SAPOData resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]

Required: Yes
applicationServicePath

The application path to catalog service.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientNumber

The client number for the client creating the connection.

Type: String

Length Constraints: Fixed length of 3.

Pattern: ^\d{3}$

Required: Yes
portNumber

The port number of the SAPOData instance.

SAPODataConnectorProﬁleProperties API Version 2020-08-23 429

AmazonAppFlow API Reference

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65535.

Required: Yes
disableSSO

If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings
in your SAP account when it accesses your SAP OData instance.

Whether you need this option depends on the types of credentials that you applied to your SAP
OData connection profile. If your profile uses basic authentication credentials, SAP SSO can
prevent Amazon AppFlow from connecting to your account with your username and password.
In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully.
However, if your profile uses OAuth credentials, this parameter has no affect.

Type: Boolean

Required: No
logonLanguage

The logon language of SAPOData instance.

Type: String

Length Constraints: Maximum length of 2.

Pattern: ^[a-zA-Z0-9_]*$

Required: No
oAuthProperties

The SAPOData OAuth properties required for OAuth type authentication.

Type: OAuthProperties object

Required: No
privateLinkServiceName

The SAPOData Private Link service name to be used for private data transfers.

Type: String

Contents API Version 2020-08-23 430

AmazonAppFlow API Reference

Length Constraints: Maximum length of 512.

Pattern: ^$|[Link].[\w/!:@#.\-]+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The object path speciﬁed in the SAPOData ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
errorHandlingConﬁg

Type: ErrorHandlingConﬁg object

Required: No
idFieldNames

A list of ﬁeld names that can be used as an ID ﬁeld when performing a write operation.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

SAPODataDestinationProperties API Version 2020-08-23 432

AmazonAppFlow API Reference

successResponseHandlingConﬁg

Determines how Amazon AppFlow handles the success response that it gets from the connector
after placing data.

For example, this setting would determine where to write the response from a destination
connector upon a successful insert operation.

Type: SuccessResponseHandlingConﬁg object

Required: No
writeOperationType

The possible write operations in the destination connector. When this value is not provided, this
defaults to the INSERT operation.

Type: String

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SAPODataMetadata API Version 2020-08-23 434

AmazonAppFlow API Reference

SAPODataPaginationConﬁg
Sets the page size for each concurrent process that transfers OData records from your SAP instance.
A concurrent process is query that retrieves a batch of records as part of a ﬂow run. Amazon
AppFlow can run multiple concurrent processes in parallel to transfer data faster.

Contents
maxPageSize

The maximum number of records that Amazon AppFlow receives in each page of the response
from your SAP application. For transfers of OData records, the maximum page size is 3,000. For
transfers of data that comes from an ODP provider, the maximum page size is 10,000.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SAPODataPaginationConﬁg API Version 2020-08-23 435

AmazonAppFlow API Reference

SAPODataParallelismConﬁg
Sets the number of concurrent processes that transfer OData records from your SAP instance. A
concurrent process is query that retrieves a batch of records as part of a ﬂow run. Amazon AppFlow
can run multiple concurrent processes in parallel to transfer data faster.

Contents
maxParallelism

The maximum number of processes that Amazon AppFlow runs at the same time when it
retrieves your data from your SAP application.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SAPODataParallelismConﬁg API Version 2020-08-23 436

AmazonAppFlow API Reference

SAPODataSourceProperties
The properties that are applied when using SAPOData as a ﬂow source.

Contents
objectPath

The object path speciﬁed in the SAPOData ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
paginationConﬁg

Sets the page size for each concurrent process that transfers OData records from your SAP
instance.

Type: SAPODataPaginationConﬁg object

Required: No
parallelismConﬁg

Sets the number of concurrent processes that transfers OData records from your SAP instance.

Type: SAPODataParallelismConﬁg object

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

SAPODataSourceProperties API Version 2020-08-23 437

AmazonAppFlow API Reference

• AWS SDK for Ruby V3

Length Constraints: Maximum length of 256.

Pattern: .*

Required: Yes
dataPullMode

Specifies whether a scheduled flow has an incremental data transfer or a complete data
transfer for each flow run.

Type: String

Valid Values: Incremental | Complete

Required: No
ﬁrstExecutionFrom

Specifies the date range for the records to import from the connector in the first flow run.

Type: Timestamp

Required: No
ﬂowErrorDeactivationThreshold

Deﬁnes how many times a scheduled ﬂow fails consecutively before Amazon AppFlow
deactivates it.

ScheduledTriggerProperties API Version 2020-08-23 439

AmazonAppFlow API Reference

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
scheduleEndTime

The time at which the scheduled ﬂow ends. The time is formatted as a timestamp that follows
the ISO 8601 standard, such as 2022-04-27T13:00:00-07:00.

Type: Timestamp

Required: No
scheduleOﬀset

Specifies the optional offset that is added to the time interval for a schedule-triggered flow.

Type: Long

Valid Range: Minimum value of 0. Maximum value of 36000.

Required: No
scheduleStartTime

The time at which the scheduled ﬂow starts. The time is formatted as a timestamp that follows
the ISO 8601 standard, such as 2022-04-26T13:00:00-07:00.

Type: Timestamp

Required: No
timezone

Specifies the time zone used when referring to the dates and times of a scheduled flow, such as
America/New_York. This time zone is only a descriptive label. It doesn't affect how Amazon
AppFlow interprets the timestamps that you specify to schedule the flow.

If you want to schedule a flow by using times in a particular time zone, indicate the time zone
as a UTC offset in your timestamps. For example, the UTC offsets for the America/New_York
timezone are -04:00 EDT and -05:00 EST.

Type: String

Contents API Version 2020-08-23 440

AmazonAppFlow API Reference

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The OAuth 2.0 credentials required to authenticate the user.

Type: OAuth2Credentials object

Required: No
password

The password that corresponds to the user name.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
username

The name of the user.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

ServiceNowConnectorProﬁleCredentials API Version 2020-08-23 442

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the ServiceNow resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ServiceNowConnectorProﬁleProperties API Version 2020-08-23 444

AmazonAppFlow API Reference

ServiceNowMetadata
The connector metadata speciﬁc to ServiceNow.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ServiceNowMetadata API Version 2020-08-23 445

AmazonAppFlow API Reference

ServiceNowSourceProperties
The properties that are applied when ServiceNow is being used as a source.

Contents
object

The object speciﬁed in the ServiceNow ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ServiceNowSourceProperties API Version 2020-08-23 446

AmazonAppFlow API Reference

SingularConnectorProfileCredentials
The connector-specific profile credentials required when using Singular.

Contents
apiKey

A unique alphanumeric identiﬁer used to authenticate a user, developer, or calling program to

your API.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SingularConnectorProﬁleCredentials API Version 2020-08-23 447

AmazonAppFlow API Reference

SingularConnectorProfileProperties
The connector-specific profile properties required when using Singular.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SingularConnectorProﬁleProperties API Version 2020-08-23 448

AmazonAppFlow API Reference

SingularMetadata
The connector metadata speciﬁc to Singular.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SingularMetadata API Version 2020-08-23 449

AmazonAppFlow API Reference

SingularSourceProperties
The properties that are applied when Singular is being used as a source.

Contents
object

The object speciﬁed in the Singular ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SingularSourceProperties API Version 2020-08-23 450

AmazonAppFlow API Reference

SlackConnectorProfileCredentials
The connector-specific profile credentials required when using Slack.

Contents
clientId

The identiﬁer for the client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
accessToken

The credentials used to access protected Slack resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

SlackConnectorProﬁleCredentials API Version 2020-08-23 451

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the Slack resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SlackConnectorProﬁleProperties API Version 2020-08-23 453

AmazonAppFlow API Reference

SlackMetadata
The connector metadata speciﬁc to Slack.

Contents
oAuthScopes

The desired authorization scope for the Slack account.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SlackMetadata API Version 2020-08-23 454

AmazonAppFlow API Reference

SlackSourceProperties
The properties that are applied when Slack is being used as a source.

Contents
object

The object speciﬁed in the Slack ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SlackSourceProperties API Version 2020-08-23 455

AmazonAppFlow API Reference

SnowflakeConnectorProfileCredentials
The connector-specific profile credentials required when using Snowflake.

Contents
password

The password that corresponds to the user name.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: Yes
username

The name of the user.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SnowﬂakeConnectorProﬁleCredentials API Version 2020-08-23 456

AmazonAppFlow API Reference

SnowflakeConnectorProfileProperties
The connector-specific profile properties required when using Snowflake.

Contents
bucketName

The name of the Amazon S3 bucket associated with Snowﬂake.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
stage

The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in
the Snowﬂake account. This is written in the following format: < Database>< Schema><Stage
Name>.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
warehouse

The name of the Snowﬂake warehouse.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\s\w/!@#+=.-]*

Required: Yes

SnowﬂakeConnectorProﬁleProperties API Version 2020-08-23 457

AmazonAppFlow API Reference

accountName

The name of the account.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: No
bucketPreﬁx

The bucket path that refers to the Amazon S3 bucket associated with Snowﬂake.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
privateLinkServiceName

The Snowﬂake Private Link service name to be used for private data transfers.

Type: String

Length Constraints: Maximum length of 512.

Pattern: ^$|[Link].[\w/!:@#.\-]+

Required: No
region

The AWS Region of the Snowﬂake account.

Type: String

Length Constraints: Maximum length of 64.

Pattern: \S+

Contents API Version 2020-08-23 458

AmazonAppFlow API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: Yes
object

The object specified in the Snowflake flow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
bucketPreﬁx

The object key for the destination bucket in which Amazon AppFlow places the ﬁles.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No
errorHandlingConﬁg

The settings that determine how Amazon AppFlow handles an error when placing data in the
Snowﬂake destination. For example, this setting would determine if the ﬂow should fail after

SnowﬂakeDestinationProperties API Version 2020-08-23 460

AmazonAppFlow API Reference

one insertion error, or continue and attempt to insert every record regardless of the initial
failure. ErrorHandlingConfig is a part of the destination connector details.

Type: ErrorHandlingConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Speciﬁes the supported AWS Regions when using Snowﬂake.

Type: Array of strings

Length Constraints: Maximum length of 64.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SnowﬂakeMetadata API Version 2020-08-23 462

AmazonAppFlow API Reference

SourceConnectorProperties
Speciﬁes the information that is required to query a particular connector.

Contents
Amplitude

Speciﬁes the information that is required for querying Amplitude.

Type: AmplitudeSourceProperties object

Required: No
CustomConnector

The properties that are applied when the custom connector is being used as a source.

Type: CustomConnectorSourceProperties object

Required: No
Datadog

Speciﬁes the information that is required for querying Datadog.

Type: DatadogSourceProperties object

Required: No
Dynatrace

Speciﬁes the information that is required for querying Dynatrace.

Type: DynatraceSourceProperties object

Required: No
GoogleAnalytics

Speciﬁes the information that is required for querying Google Analytics.

Type: GoogleAnalyticsSourceProperties object

Required: No

SourceConnectorProperties API Version 2020-08-23 463

AmazonAppFlow API Reference

InforNexus

Speciﬁes the information that is required for querying Infor Nexus.

Type: InforNexusSourceProperties object

Required: No
Marketo

Speciﬁes the information that is required for querying Marketo.

Type: MarketoSourceProperties object

Required: No
Pardot

Speciﬁes the information that is required for querying Salesforce Pardot.

Type: PardotSourceProperties object

Required: No
S3

Speciﬁes the information that is required for querying Amazon S3.

Type: S3SourceProperties object

Required: No
Salesforce

Speciﬁes the information that is required for querying Salesforce.

Type: SalesforceSourceProperties object

Required: No
SAPOData

The properties that are applied when using SAPOData as a ﬂow source.

Type: SAPODataSourceProperties object

Required: No

Contents API Version 2020-08-23 464

AmazonAppFlow API Reference

ServiceNow

Speciﬁes the information that is required for querying ServiceNow.

Type: ServiceNowSourceProperties object

Required: No
Singular

Speciﬁes the information that is required for querying Singular.

Type: SingularSourceProperties object

Required: No
Slack

Speciﬁes the information that is required for querying Slack.

Type: SlackSourceProperties object

Required: No
Trendmicro

Speciﬁes the information that is required for querying Trend Micro.

Type: TrendmicroSourceProperties object

Required: No
Veeva

Speciﬁes the information that is required for querying Veeva.

Type: VeevaSourceProperties object

Required: No
Zendesk

Speciﬁes the information that is required for querying Zendesk.

Type: ZendeskSourceProperties object

Required: No

Contents API Version 2020-08-23 465

AmazonAppFlow API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Indicates if the ﬁeld can be queried.

Type: Boolean

Required: No
isRetrievable

Indicates whether the ﬁeld can be returned in a search result.

Type: Boolean

Required: No
isTimestampFieldForIncrementalQueries

Indicates if this timestamp ﬁeld can be used for incremental queries.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SourceFieldProperties API Version 2020-08-23 467

AmazonAppFlow API Reference

SourceFlowConfig
Contains information about the configuration of the source connector used in the flow.

Contents
connectorType

The type of connector, such as Salesforce, Amplitude, and so on.

Type: String

Valid Values: Salesforce | Singular | Slack | Redshift | S3 | Marketo

Required: Yes
sourceConnectorProperties

Speciﬁes the information that is required to query a particular source connector.

Type: SourceConnectorProperties object

Required: Yes
apiVersion

The API version of the connector when it's used as a source in the ﬂow.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No
connectorProﬁleName

The name of the connector proﬁle. This name must be unique for each connector proﬁle in the
AWS account.

SourceFlowConﬁg API Version 2020-08-23 468

AmazonAppFlow API Reference

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No
incrementalPullConﬁg

Defines the configuration for a scheduled incremental data pull. If a valid configuration is
provided, the fields specified in the configuration are used when querying for the incremental
data pull.

Type: IncrementalPullConﬁg object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the Amazon S3 bucket.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: \S+

Required: No
bucketPreﬁx

The Amazon S3 bucket preﬁx.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2

SuccessResponseHandlingConﬁg API Version 2020-08-23 470

AmazonAppFlow API Reference

• AWS SDK for Ruby V3

Type: FieldTypeDetails object

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

SupportedFieldTypeDetails API Version 2020-08-23 472

AmazonAppFlow API Reference

Task
A class for modeling diﬀerent type of tasks. Task implementation varies based on the TaskType.

Contents
sourceFields

The source ﬁelds to which a particular task is applied.

Type: Array of strings

Length Constraints: Maximum length of 2048.

Pattern: .*

Required: Yes
taskType

Speciﬁes the particular task implementation that Amazon AppFlow performs.

Type: String

Valid Values: Arithmetic | Filter | Map | Map_all | Mask | Merge |

Passthrough | Truncate | Validate | Partition

Required: Yes
connectorOperator

The operation to be performed on the provided source ﬁelds.

Type: ConnectorOperator object

Required: No
destinationField

A field in a destination connector, or a field value against which Amazon AppFlow validates a
source field.

Type: String

Length Constraints: Maximum length of 256.

Task API Version 2020-08-23 473

AmazonAppFlow API Reference

Pattern: .*

Required: No
taskProperties

A map used to store task-related information. The execution service looks for particular
information based on the TaskType.

Type: String to string map

Valid Keys: VALUE | VALUES | DATA_TYPE | UPPER_BOUND | LOWER_BOUND

Value Length Constraints: Maximum length of 2048.

Value Pattern: .+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The Secret Access Key portion of the credentials.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TrendmicroConnectorProﬁleCredentials API Version 2020-08-23 475

AmazonAppFlow API Reference

TrendmicroConnectorProfileProperties
The connector-specific profile properties required when using Trend Micro.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TrendmicroConnectorProﬁleProperties API Version 2020-08-23 476

AmazonAppFlow API Reference

TrendmicroMetadata
The connector metadata speciﬁc to Trend Micro.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TrendmicroMetadata API Version 2020-08-23 477

AmazonAppFlow API Reference

TrendmicroSourceProperties
The properties that are applied when using Trend Micro as a ﬂow source.

Contents
object

The object speciﬁed in the Trend Micro ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TrendmicroSourceProperties API Version 2020-08-23 478

AmazonAppFlow API Reference

TriggerConfig
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.

Contents
triggerType

Speciﬁes the type of ﬂow trigger. This can be OnDemand, Scheduled, or Event.

Type: String

Valid Values: Scheduled | Event | OnDemand

Required: Yes
triggerProperties

Specifies the configuration details of a schedule-triggered flow as defined by the user.

Currently, these settings only apply to the Scheduled trigger type.

Type: TriggerProperties object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TriggerConﬁg API Version 2020-08-23 479

AmazonAppFlow API Reference

TriggerProperties
Specifies the configuration details that control the trigger for a flow. Currently, these settings only
apply to the Scheduled trigger type.

Contents
Scheduled

Specifies the configuration details of a schedule-triggered flow as defined by the user.

Type: ScheduledTriggerProperties object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

TriggerProperties API Version 2020-08-23 480

AmazonAppFlow API Reference

UpsolverDestinationProperties
The properties that are applied when Upsolver is used as a destination.

Contents
bucketName

The Upsolver Amazon S3 bucket name in which Amazon AppFlow places the transferred data.

Type: String

Length Constraints: Minimum length of 16. Maximum length of 63.

Pattern: ^(upsolver-appflow)\S*

Required: Yes
s3OutputFormatConﬁg

The conﬁguration that determines how data is formatted when Upsolver is used as the ﬂow
destination.

Type: UpsolverS3OutputFormatConﬁg object

Required: Yes
bucketPreﬁx

The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow
places the ﬁles.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

UpsolverDestinationProperties API Version 2020-08-23 481

AmazonAppFlow API Reference

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpsolverMetadata API Version 2020-08-23 483

AmazonAppFlow API Reference

UpsolverS3OutputFormatConfig
The configuration that determines how Amazon AppFlow formats the flow output data when
Upsolver is used as the destination.

Contents
preﬁxConﬁg

Specifies elements that Amazon AppFlow includes in the file and folder names in the flow
destination.

Type: PreﬁxConﬁg object

Required: Yes
aggregationConﬁg

The aggregation settings that you can use to customize the output format of your ﬂow data.

Type: AggregationConﬁg object

Required: No
ﬁleType

Indicates the ﬁle type that Amazon AppFlow places in the Upsolver Amazon S3 bucket.

Type: String

Valid Values: CSV | JSON | PARQUET

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

UpsolverS3OutputFormatConﬁg API Version 2020-08-23 484

AmazonAppFlow API Reference

The password that corresponds to the user name.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: Yes
username

The name of the user.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

VeevaConnectorProﬁleCredentials API Version 2020-08-23 486

AmazonAppFlow API Reference

VeevaConnectorProfileProperties
The connector-specific profile properties required when using Veeva.

Contents
instanceUrl

The location of the Veeva resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

VeevaConnectorProﬁleProperties API Version 2020-08-23 487

AmazonAppFlow API Reference

VeevaMetadata
The connector metadata speciﬁc to Veeva.

Contents
The members of this exception structure are context-dependent.

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

VeevaMetadata API Version 2020-08-23 488

AmazonAppFlow API Reference

VeevaSourceProperties
The properties that are applied when using Veeva as a ﬂow source.

Contents
object

The object speciﬁed in the Veeva ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
documentType

The document type speciﬁed in the Veeva document extract ﬂow.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\s\w_-]+

Required: No
includeAllVersions

Boolean value to include All Versions of ﬁles in Veeva document extract ﬂow.

Type: Boolean

Required: No
includeRenditions

Boolean value to include ﬁle renditions in Veeva document extract ﬂow.

Type: Boolean

Required: No

VeevaSourceProperties API Version 2020-08-23 489

AmazonAppFlow API Reference

includeSourceFiles

Boolean value to include source ﬁles in Veeva document extract ﬂow.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The identiﬁer for the desired client.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
clientSecret

The client secret used by the OAuth client to authenticate to the authorization server.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
accessToken

The credentials used to access protected Zendesk resources.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: \S+

Required: No
oAuthRequest

The OAuth requirement needed to request security tokens from the connector endpoint.

ZendeskConnectorProﬁleCredentials API Version 2020-08-23 491

AmazonAppFlow API Reference

Type: ConnectorOAuthRequest object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The location of the Zendesk resource.

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ZendeskConnectorProﬁleProperties API Version 2020-08-23 493

AmazonAppFlow API Reference

ZendeskDestinationProperties
The properties that are applied when Zendesk is used as a destination.

Contents
object

The object speciﬁed in the Zendesk ﬂow destination.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes
errorHandlingConﬁg

Type: ErrorHandlingConﬁg object

Required: No
idFieldNames

A list of ﬁeld names that can be used as an ID ﬁeld when performing a write operation.

Type: Array of strings

Array Members: Minimum number of 0 items.

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

ZendeskDestinationProperties API Version 2020-08-23 494

AmazonAppFlow API Reference

writeOperationType

The possible write operations in the destination connector. When this value is not provided, this
defaults to the INSERT operation.

Type: String

Valid Values: INSERT | UPSERT | UPDATE | DELETE

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The desired authorization scope for the Zendesk account.

Type: Array of strings

Length Constraints: Maximum length of 128.

Pattern: \S+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ZendeskMetadata API Version 2020-08-23 496

AmazonAppFlow API Reference

ZendeskSourceProperties
The properties that are applied when using Zendesk as a ﬂow source.

Contents
object

The object speciﬁed in the Zendesk ﬂow source.

Type: String

Length Constraints: Maximum length of 512.

Pattern: \S+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Java V2
• AWS SDK for Ruby V3

ZendeskSourceProperties API Version 2020-08-23 497

AmazonAppFlow API Reference

Common Parameters
The following list contains the parameters that all actions use for signing Signature Version 4
requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action.
For more information about Signature Version 4, see Signing AWS API requests in the IAM User
Guide.

X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region
you are targeting, the service you are requesting, and a termination string ("aws4_request").
The value is expressed in the following format: access_key/YYYYMMDD/region/service/
aws4_request.

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

API Version 2020-08-23 498

AmazonAppFlow API Reference

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service
(AWS STS). For a list of services that support temporary security credentials from AWS STS, see
AWS services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM
User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

API Version 2020-08-23 499

AmazonAppFlow API Reference

Required: Conditional

API Version 2020-08-23 500

AmazonAppFlow API Reference

Common Error Types

This section lists common error types that this AWS service may return. Not all services return all
error types listed here. For errors speciﬁc to an API action for this service, see the topic for that API
action.

AccessDeniedException

You don't have permission to perform this action. Verify that your IAM policy includes the
required permissions.

HTTP Status Code: 403

ExpiredTokenException

The security token included in the request has expired. Request a new security token and try
again.

HTTP Status Code: 403

IncompleteSignature

The request signature doesn't conform to AWS standards. Verify that you're using valid AWS
credentials and that your request is properly formatted. If you're using an SDK, ensure it's up to
date.

HTTP Status Code: 403

InternalFailure

The request can't be processed right now because of an internal server issue. Try again later. If
the problem persists, contact AWS Support.

HTTP Status Code: 500

MalformedHttpRequestException

The request body can't be processed. This typically happens when the request body can't be
decompressed using the speciﬁed content encoding algorithm. Verify that the content encoding
header matches the compression format used.

HTTP Status Code: 400

API Version 2020-08-23 501

AmazonAppFlow API Reference

NotAuthorized

You don't have permissions to perform this action. Verify that your IAM policy includes the
required permissions.

HTTP Status Code: 401

OptInRequired

Your AWS account needs a subscription for this service. Verify that you've enabled the service in
your account.

HTTP Status Code: 403

RequestAbortedException

The request was aborted before a response could be returned. This typically happens when the
client closes the connection.

HTTP Status Code: 400

RequestEntityTooLargeException

The request entity is too large. Reduce the size of the request body and try again.

HTTP Status Code: 413

RequestTimeoutException

The request timed out. The server didn't receive the complete request within the expected time
frame. Try again.

HTTP Status Code: 408

ServiceUnavailable

The service is temporarily unavailable. Try again later.

HTTP Status Code: 503

ThrottlingException

Your request rate is too high. The AWS SDKs automatically retry requests that receive this
exception. Reduce the frequency of requests.

HTTP Status Code: 400

API Version 2020-08-23 502

AmazonAppFlow API Reference

UnknownOperationException

The action or operation isn't recognized. Verify that the action name is spelled correctly and
that it's supported by the API version you're using.

HTTP Status Code: 404

UnrecognizedClientException

The X.509 certiﬁcate or AWS access key ID you provided doesn't exist in our records. Verify that
you're using valid credentials and that they haven't expired.

HTTP Status Code: 403

ValidationError

The input doesn't meet the required format or constraints. Check that all required parameters
are included and that values are valid.

HTTP Status Code: 400

API Version 2020-08-23 503

Amazon AppFlow
No ratings yet
Amazon AppFlow
26 pages
Apache Airflow REST API Overview
No ratings yet
Apache Airflow REST API Overview
83 pages
AWS Storage Gateway-API
No ratings yet
AWS Storage Gateway-API
181 pages
AWS API Gateway: Types and Pricing
No ratings yet
AWS API Gateway: Types and Pricing
1 page
Aws Iot Analytics Api
No ratings yet
Aws Iot Analytics Api
207 pages
Aws Iot Analytics API
No ratings yet
Aws Iot Analytics API
185 pages
Cloudfront API
No ratings yet
Cloudfront API
444 pages
AWS API Gateway Overview and Pricing
100% (1)
AWS API Gateway Overview and Pricing
18 pages
Amazon VPC Lattice API Guide
No ratings yet
Amazon VPC Lattice API Guide
231 pages
Deeplearning - Ai Deeplearning - Ai
No ratings yet
Deeplearning - Ai Deeplearning - Ai
87 pages
Airflow 101: Essential Guide for Beginners
No ratings yet
Airflow 101: Essential Guide for Beginners
25 pages
Ec2 Api
No ratings yet
Ec2 Api
955 pages
Data Ingestion: Week 2
No ratings yet
Data Ingestion: Week 2
86 pages
Understanding Apache NiFi Data Flows
No ratings yet
Understanding Apache NiFi Data Flows
4 pages
VPC Lattice API: List Target Groups
No ratings yet
VPC Lattice API: List Target Groups
426 pages
Gateway API
No ratings yet
Gateway API
16 pages
Firehose Apiref
No ratings yet
Firehose Apiref
359 pages
WebSocket API Development with AWS
No ratings yet
WebSocket API Development with AWS
99 pages
As Api
No ratings yet
As Api
224 pages
AWS Batch API Reference Guide
No ratings yet
AWS Batch API Reference Guide
437 pages
Video Streaming API Integration Guide
No ratings yet
Video Streaming API Integration Guide
10 pages
Comprehensive Guide to API Testing
No ratings yet
Comprehensive Guide to API Testing
6 pages
Module 4 - Understanding and Using APIs
No ratings yet
Module 4 - Understanding and Using APIs
23 pages
Rest Api Flow
No ratings yet
Rest Api Flow
2 pages
Trifacta Developer Guide
No ratings yet
Trifacta Developer Guide
525 pages
Spring Webflow Reference
No ratings yet
Spring Webflow Reference
77 pages
CC Lab
No ratings yet
CC Lab
82 pages
Getting Started With Serverless Computing Using AWS Lambda: Chris Munns - Senior Developer Advocate - Serverless
No ratings yet
Getting Started With Serverless Computing Using AWS Lambda: Chris Munns - Senior Developer Advocate - Serverless
46 pages
Understanding AWS API Gateway Basics
No ratings yet
Understanding AWS API Gateway Basics
12 pages
Amazon API Gateway
0% (1)
Amazon API Gateway
307 pages
3 of 6 - REST API - A To Z - Design Practices
No ratings yet
3 of 6 - REST API - A To Z - Design Practices
37 pages
Module 3.2
No ratings yet
Module 3.2
60 pages
Configuring Data Stream Actions in ServiceNow
No ratings yet
Configuring Data Stream Actions in ServiceNow
20 pages
Exp 3
No ratings yet
Exp 3
7 pages
Apigateway DG
No ratings yet
Apigateway DG
842 pages
Module 2
No ratings yet
Module 2
71 pages
API Gateway: Manage and Secure APIs
No ratings yet
API Gateway: Manage and Secure APIs
8 pages
Introduction to Amazon API Gateway
No ratings yet
Introduction to Amazon API Gateway
12 pages
Spring Webflow Reference
No ratings yet
Spring Webflow Reference
120 pages
Apache CloudStack 4.0.0 Incubating API Developers Guide en US
No ratings yet
Apache CloudStack 4.0.0 Incubating API Developers Guide en US
44 pages
AWS Lambda REST API Workshop Guide
No ratings yet
AWS Lambda REST API Workshop Guide
22 pages
AWS Lambda API Reference Guide
No ratings yet
AWS Lambda API Reference Guide
555 pages
Apache NiFi Use Cases Overview
No ratings yet
Apache NiFi Use Cases Overview
30 pages
AWS Cloud API Overview and Examples
No ratings yet
AWS Cloud API Overview and Examples
7 pages
Comprehensive Guide to Mule ESB and Anypoint
No ratings yet
Comprehensive Guide to Mule ESB and Anypoint
11 pages
Financial Reporting API Integration Guide
No ratings yet
Financial Reporting API Integration Guide
10 pages
What Is GraphQL - AWS AppSync GraphQL
No ratings yet
What Is GraphQL - AWS AppSync GraphQL
3 pages
What Is GraphQL - AWS AppSync GraphQL
No ratings yet
What Is GraphQL - AWS AppSync GraphQL
3 pages
RAGFlow Quick Start Guide
No ratings yet
RAGFlow Quick Start Guide
10 pages
{apiName} API Documentation Guide
No ratings yet
{apiName} API Documentation Guide
2 pages
{apiName} API Documentation Overview
No ratings yet
{apiName} API Documentation Overview
2 pages
SAG WebMethod Version 10.15 I Need Create AD
No ratings yet
SAG WebMethod Version 10.15 I Need Create AD
6 pages
WebMethods Flow Service Coding Guide
100% (1)
WebMethods Flow Service Coding Guide
11 pages
ADF CI/CD Deployment Guide
No ratings yet
ADF CI/CD Deployment Guide
12 pages
Overview of Apache NiFi Architecture
No ratings yet
Overview of Apache NiFi Architecture
9 pages
Amazon API Gateway - AWS Cheat Sheet
No ratings yet
Amazon API Gateway - AWS Cheat Sheet
33 pages
Ecr Public Api
No ratings yet
Ecr Public Api
101 pages

Amazon Appflow API

Uploaded by

Amazon Appflow API

Uploaded by

API Reference

API Version 2020-08-23

AmazonAppFlow: API Reference

API Version 2020-08-23 iii

API Version 2020-08-23 iv

Errors ..................................................................................................................................................... 112

API Version 2020-08-23 v

Errors ..................................................................................................................................................... 155

API Version 2020-08-23 vi

Examples ............................................................................................................................................... 178

API Version 2020-08-23 vii

See Also ................................................................................................................................................ 197

API Version 2020-08-23 viii

Request Syntax .................................................................................................................................... 220

API Version 2020-08-23 ix

ConnectorConﬁguration ......................................................................................................................... 253

API Version 2020-08-23 x

ConnectorRuntimeSetting ...................................................................................................................... 294

API Version 2020-08-23 xi

DatadogSourceProperties ....................................................................................................................... 313

API Version 2020-08-23 xii

EventBridgeMetadata .............................................................................................................................. 331

API Version 2020-08-23 xiii

HoneycodeConnectorProﬁleProperties ................................................................................................ 355

API Version 2020-08-23 xiv

MarketoDestinationProperties ............................................................................................................... 369

API Version 2020-08-23 xv

PardotConnectorProﬁleProperties ........................................................................................................ 389

API Version 2020-08-23 xvi

S3InputFormatConﬁg .............................................................................................................................. 409

API Version 2020-08-23 xvii

SAPODataMetadata ................................................................................................................................. 434

API Version 2020-08-23 xviii

SingularSourceProperties ....................................................................................................................... 450

API Version 2020-08-23 xix

SuccessResponseHandlingConﬁg .......................................................................................................... 470

API Version 2020-08-23 xx

VeevaConnectorProﬁleCredentials ....................................................................................................... 486

API Version 2020-08-23 xxi

• Actions: An alphabetical list of all Amazon AppFlow API operations.

This document was last published on April 3, 2026.

API Version 2020-08-23 1

API Version 2020-08-23 2

You cannot resume a run after you cancel it.

POST /cancel-flow-executions HTTP/1.1

URI Request Parameters

The request does not use any URI parameters.

CancelFlowExecutions API Version 2020-08-23 3

The request accepts the following data in JSON format.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

Length Constraints: Maximum length of 256.

Request Body API Version 2020-08-23 4

The following data is returned in JSON format by the service.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Length Constraints: Maximum length of 256.

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

HTTP Status Code: 500

HTTP Status Code: 404

Response Elements API Version 2020-08-23 5

HTTP Status Code: 429

The request has invalid or missing parameters.

HTTP Status Code: 400

• AWS Command Line Interface V2

See Also API Version 2020-08-23 6

POST /create-connector-profile HTTP/1.1

CreateConnectorProﬁle API Version 2020-08-23 7

Request Syntax API Version 2020-08-23 8

Request Syntax API Version 2020-08-23 9

Request Syntax API Version 2020-08-23 10

Request Syntax API Version 2020-08-23 11

Request Syntax API Version 2020-08-23 12

URI Request Parameters