/
docs-2.json
1963 lines (1963 loc) · 97.5 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>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. </p> <p>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. </p> <p>Use the following links to get started on the Amazon AppFlow API:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Operations.html\">Actions</a>: An alphabetical list of all Amazon AppFlow API operations.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/API_Types.html\">Data types</a>: An alphabetical list of all Amazon AppFlow data types.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonParameters.html\">Common parameters</a>: Parameters that all Query operations can use.</p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/appflow/1.0/APIReference/CommonErrors.html\">Common errors</a>: Client and server errors that all operations can return.</p> </li> </ul> <p>If you're new to Amazon AppFlow, we recommend that you review the <a href=\"https://docs.aws.amazon.com/appflow/latest/userguide/what-is-appflow.html\">Amazon AppFlow User Guide</a>.</p> <p>Amazon AppFlow API users can use vendor-specific mechanisms for OAuth, and include applicable OAuth attributes (such as <code>auth-code</code> and <code>redirecturi</code>) with the connector-specific <code>ConnectorProfileProperties</code> when creating a new connector profile using Amazon AppFlow API operations. For example, Salesforce users can refer to the <a href=\"https://help.salesforce.com/articleView?id=remoteaccess_authenticate.htm\"> <i>Authorize Apps with OAuth</i> </a> documentation.</p>",
"operations": {
"CreateConnectorProfile": "<p> Creates a new connector profile associated with your Amazon Web Services account. There is a soft quota of 100 connector profiles per Amazon Web Services account. If you need more connector profiles than this quota allows, you can submit a request to the Amazon AppFlow team through the Amazon AppFlow support channel. </p>",
"CreateFlow": "<p> Enables your application to create a new flow using Amazon AppFlow. You must create a connector profile before calling this API. Please note that the Request Syntax below shows syntax for multiple destinations, however, you can only transfer data to one item in this list at a time. Amazon AppFlow does not currently support flows to multiple destinations at once. </p>",
"DeleteConnectorProfile": "<p> Enables you to delete an existing connector profile. </p>",
"DeleteFlow": "<p> Enables your application to delete an existing flow. Before deleting the flow, Amazon AppFlow validates the request by checking the flow configuration and status. You can delete flows one at a time. </p>",
"DescribeConnectorEntity": "<p> Provides details regarding the entity used with the connector, with a description of the data model for each entity. </p>",
"DescribeConnectorProfiles": "<p> Returns a list of <code>connector-profile</code> details matching the provided <code>connector-profile</code> names and <code>connector-types</code>. Both input lists are optional, and you can use them to filter the result. </p> <p>If no names or <code>connector-types</code> are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.</p>",
"DescribeConnectors": "<p> Describes the connectors vended by Amazon AppFlow for specified connector types. If you don't specify a connector type, this operation describes all connectors vended by Amazon AppFlow. If there are more connectors than can be returned in one page, the response contains a <code>nextToken</code> object, which can be be passed in to the next call to the <code>DescribeConnectors</code> API operation to retrieve the next page. </p>",
"DescribeFlow": "<p> Provides a description of the specified flow. </p>",
"DescribeFlowExecutionRecords": "<p> Fetches the execution history of the flow. </p>",
"ListConnectorEntities": "<p> Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for <i>Account</i> and <i>Opportunity</i> entities, or query ServiceNow for the <i>Incident</i> entity. </p>",
"ListFlows": "<p> Lists all of the flows associated with your account. </p>",
"ListTagsForResource": "<p> Retrieves the tags that are associated with a specified flow. </p>",
"StartFlow": "<p> Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow. </p>",
"StopFlow": "<p> Deactivates the existing flow. For on-demand flows, this operation returns an <code>unsupportedOperationException</code> error message. For schedule and event-triggered flows, this operation deactivates the flow. </p>",
"TagResource": "<p> Applies a tag to the specified flow. </p>",
"UntagResource": "<p> Removes a tag from the specified flow. </p>",
"UpdateConnectorProfile": "<p> Updates a given connector profile associated with your account. </p>",
"UpdateFlow": "<p> Updates an existing flow. </p>"
},
"shapes": {
"ARN": {
"base": null,
"refs": {
"ConnectorProfile$credentialsArn": "<p> The Amazon Resource Name (ARN) of the connector profile credentials. </p>",
"ListTagsForResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the specified flow. </p>",
"TagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the flow that you want to tag. </p>",
"UntagResourceRequest$resourceArn": "<p> The Amazon Resource Name (ARN) of the flow that you want to untag. </p>"
}
},
"AccessKeyId": {
"base": null,
"refs": {
"InforNexusConnectorProfileCredentials$accessKeyId": "<p> The Access Key portion of the credentials. </p>"
}
},
"AccessToken": {
"base": null,
"refs": {
"GoogleAnalyticsConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Google Analytics resources. </p>",
"HoneycodeConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Amazon Honeycode resources. </p>",
"MarketoConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Marketo resources. </p>",
"OAuthCredentials$accessToken": "<p> The access token used to access protected SAPOData resources. </p>",
"SalesforceConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Salesforce resources. </p>",
"SlackConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Slack resources. </p>",
"ZendeskConnectorProfileCredentials$accessToken": "<p> The credentials used to access protected Zendesk resources. </p>"
}
},
"AccountName": {
"base": null,
"refs": {
"SnowflakeConnectorProfileProperties$accountName": "<p> The name of the account. </p>"
}
},
"AggregationConfig": {
"base": "<p> The aggregation settings that you can use to customize the output format of your flow data. </p>",
"refs": {
"S3OutputFormatConfig$aggregationConfig": null,
"UpsolverS3OutputFormatConfig$aggregationConfig": null
}
},
"AggregationType": {
"base": null,
"refs": {
"AggregationConfig$aggregationType": "<p> Specifies whether Amazon AppFlow aggregates the flow records into a single file, or leave them unaggregated. </p>"
}
},
"AmplitudeConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$Amplitude": "<p> The operation to be performed on the provided Amplitude source fields. </p>"
}
},
"AmplitudeConnectorProfileCredentials": {
"base": "<p> The connector-specific credentials required when using Amplitude. </p>",
"refs": {
"ConnectorProfileCredentials$Amplitude": "<p> The connector-specific credentials required when using Amplitude. </p>"
}
},
"AmplitudeConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required when using Amplitude. </p>",
"refs": {
"ConnectorProfileProperties$Amplitude": "<p> The connector-specific properties required by Amplitude. </p>"
}
},
"AmplitudeMetadata": {
"base": "<p> The connector metadata specific to Amplitude. </p>",
"refs": {
"ConnectorMetadata$Amplitude": "<p> The connector metadata specific to Amplitude. </p>"
}
},
"AmplitudeSourceProperties": {
"base": "<p> The properties that are applied when Amplitude is being used as a source. </p>",
"refs": {
"SourceConnectorProperties$Amplitude": "<p> Specifies the information that is required for querying Amplitude. </p>"
}
},
"ApiKey": {
"base": null,
"refs": {
"AmplitudeConnectorProfileCredentials$apiKey": "<p> A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. </p>",
"DatadogConnectorProfileCredentials$apiKey": "<p> A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. </p>",
"SingularConnectorProfileCredentials$apiKey": "<p> A unique alphanumeric identifier used to authenticate a user, developer, or calling program to your API. </p>"
}
},
"ApiSecretKey": {
"base": null,
"refs": {
"TrendmicroConnectorProfileCredentials$apiSecretKey": "<p> The Secret Access Key portion of the credentials. </p>"
}
},
"ApiToken": {
"base": null,
"refs": {
"DynatraceConnectorProfileCredentials$apiToken": "<p> The API tokens used by Dynatrace API to authenticate various API calls. </p>"
}
},
"ApplicationHostUrl": {
"base": null,
"refs": {
"SAPODataConnectorProfileProperties$applicationHostUrl": "<p> The location of the SAPOData resource. </p>"
}
},
"ApplicationKey": {
"base": null,
"refs": {
"DatadogConnectorProfileCredentials$applicationKey": "<p> 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. </p>"
}
},
"ApplicationServicePath": {
"base": null,
"refs": {
"SAPODataConnectorProfileProperties$applicationServicePath": "<p> The application path to catalog service. </p>"
}
},
"AuthCode": {
"base": null,
"refs": {
"ConnectorOAuthRequest$authCode": "<p> The code provided by the connector when it has been authenticated via the connected app. </p>"
}
},
"AuthCodeUrl": {
"base": null,
"refs": {
"OAuthProperties$authCodeUrl": "<p> The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication. </p>"
}
},
"BasicAuthCredentials": {
"base": "<p> The basic auth credentials required for basic authentication. </p>",
"refs": {
"SAPODataConnectorProfileCredentials$basicAuthCredentials": "<p> The SAPOData basic authentication credentials. </p>"
}
},
"Boolean": {
"base": null,
"refs": {
"ConnectorConfiguration$canUseAsSource": "<p> Specifies whether the connector can be used as a source. </p>",
"ConnectorConfiguration$canUseAsDestination": "<p> Specifies whether the connector can be used as a destination. </p>",
"ConnectorConfiguration$isPrivateLinkEnabled": "<p> Specifies if PrivateLink is enabled for that connector. </p>",
"ConnectorConfiguration$isPrivateLinkEndpointUrlRequired": "<p> Specifies if a PrivateLink endpoint URL is required. </p>",
"ConnectorEntity$hasNestedEntities": "<p> Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with <code>entitiesPath = \"the_current_entity_name_with_hasNestedEntities_true\"</code>, then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion. </p>",
"DeleteConnectorProfileRequest$forceDelete": "<p> Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows. </p>",
"DeleteFlowRequest$forceDelete": "<p> Indicates whether Amazon AppFlow should delete the flow, even if it is currently in use. </p>",
"DestinationFieldProperties$isCreatable": "<p> Specifies if the destination field can be created by the current user. </p>",
"DestinationFieldProperties$isNullable": "<p> Specifies if the destination field can have a null value. </p>",
"DestinationFieldProperties$isUpsertable": "<p> 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. </p>",
"DestinationFieldProperties$isUpdatable": "<p> Specifies whether the field can be updated during an <code>UPDATE</code> or <code>UPSERT</code> write operation. </p>",
"ErrorHandlingConfig$failOnFirstDestinationError": "<p> Specifies if the flow should fail after the first instance of a failure when attempting to place data in the destination. </p>",
"SalesforceConnectorProfileProperties$isSandboxEnvironment": "<p> Indicates whether the connector profile applies to a sandbox or production environment. </p>",
"SalesforceSourceProperties$enableDynamicFieldUpdate": "<p> The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow. </p>",
"SalesforceSourceProperties$includeDeletedRecords": "<p> Indicates whether Amazon AppFlow includes deleted files in the flow run. </p>",
"SourceFieldProperties$isRetrievable": "<p> Indicates whether the field can be returned in a search result. </p>",
"SourceFieldProperties$isQueryable": "<p> Indicates if the field can be queried. </p>",
"VeevaSourceProperties$includeSourceFiles": "<p>Boolean value to include source files in Veeva document extract flow.</p>",
"VeevaSourceProperties$includeRenditions": "<p>Boolean value to include file renditions in Veeva document extract flow.</p>",
"VeevaSourceProperties$includeAllVersions": "<p>Boolean value to include All Versions of files in Veeva document extract flow.</p>"
}
},
"BucketName": {
"base": null,
"refs": {
"ErrorHandlingConfig$bucketName": "<p> Specifies the name of the Amazon S3 bucket. </p>",
"RedshiftConnectorProfileProperties$bucketName": "<p> A name for the associated Amazon S3 bucket. </p>",
"RedshiftDestinationProperties$intermediateBucketName": "<p> The intermediate bucket that Amazon AppFlow uses when moving data into Amazon Redshift. </p>",
"S3DestinationProperties$bucketName": "<p> The Amazon S3 bucket name in which Amazon AppFlow places the transferred data. </p>",
"S3SourceProperties$bucketName": "<p> The Amazon S3 bucket name where the source files are stored. </p>",
"SnowflakeConnectorProfileProperties$bucketName": "<p> The name of the Amazon S3 bucket associated with Snowflake. </p>",
"SnowflakeDestinationProperties$intermediateBucketName": "<p> The intermediate bucket that Amazon AppFlow uses when moving data into Snowflake. </p>"
}
},
"BucketPrefix": {
"base": null,
"refs": {
"ErrorHandlingConfig$bucketPrefix": "<p> Specifies the Amazon S3 bucket prefix. </p>",
"RedshiftConnectorProfileProperties$bucketPrefix": "<p> The object key for the destination bucket in which Amazon AppFlow places the files. </p>",
"RedshiftDestinationProperties$bucketPrefix": "<p> The object key for the bucket in which Amazon AppFlow places the destination files. </p>",
"S3DestinationProperties$bucketPrefix": "<p> The object key for the destination bucket in which Amazon AppFlow places the files. </p>",
"S3SourceProperties$bucketPrefix": "<p> The object key for the Amazon S3 bucket in which the source files are stored. </p>",
"SnowflakeConnectorProfileProperties$bucketPrefix": "<p> The bucket path that refers to the Amazon S3 bucket associated with Snowflake. </p>",
"SnowflakeDestinationProperties$bucketPrefix": "<p> The object key for the destination bucket in which Amazon AppFlow places the files. </p>",
"UpsolverDestinationProperties$bucketPrefix": "<p> The object key for the destination Upsolver Amazon S3 bucket in which Amazon AppFlow places the files. </p>"
}
},
"ClientCredentialsArn": {
"base": null,
"refs": {
"SalesforceConnectorProfileCredentials$clientCredentialsArn": "<p> The secret manager ARN, which contains the client ID and client secret of the connected app. </p>"
}
},
"ClientId": {
"base": null,
"refs": {
"GoogleAnalyticsConnectorProfileCredentials$clientId": "<p> The identifier for the desired client. </p>",
"MarketoConnectorProfileCredentials$clientId": "<p> The identifier for the desired client. </p>",
"OAuthCredentials$clientId": "<p> The identifier for the desired client. </p>",
"SlackConnectorProfileCredentials$clientId": "<p> The identifier for the client. </p>",
"ZendeskConnectorProfileCredentials$clientId": "<p> The identifier for the desired client. </p>"
}
},
"ClientNumber": {
"base": null,
"refs": {
"SAPODataConnectorProfileProperties$clientNumber": "<p> The client number for the client creating the connection. </p>"
}
},
"ClientSecret": {
"base": null,
"refs": {
"GoogleAnalyticsConnectorProfileCredentials$clientSecret": "<p> The client secret used by the OAuth client to authenticate to the authorization server. </p>",
"MarketoConnectorProfileCredentials$clientSecret": "<p> The client secret used by the OAuth client to authenticate to the authorization server. </p>",
"OAuthCredentials$clientSecret": "<p> The client secret used by the OAuth client to authenticate to the authorization server. </p>",
"SlackConnectorProfileCredentials$clientSecret": "<p> The client secret used by the OAuth client to authenticate to the authorization server. </p>",
"ZendeskConnectorProfileCredentials$clientSecret": "<p> The client secret used by the OAuth client to authenticate to the authorization server. </p>"
}
},
"ConflictException": {
"base": "<p> 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. </p>",
"refs": {
}
},
"ConnectionMode": {
"base": null,
"refs": {
"ConnectorProfile$connectionMode": "<p> Indicates the connection mode and if it is public or private. </p>",
"CreateConnectorProfileRequest$connectionMode": "<p> Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public internet. </p>",
"UpdateConnectorProfileRequest$connectionMode": "<p> Indicates the connection mode and if it is public or private. </p>"
}
},
"ConnectorAuthenticationException": {
"base": "<p> An error occurred when authenticating with the connector endpoint. </p>",
"refs": {
}
},
"ConnectorConfiguration": {
"base": "<p> The configuration settings related to a given connector. </p>",
"refs": {
"ConnectorConfigurationsMap$value": null
}
},
"ConnectorConfigurationsMap": {
"base": null,
"refs": {
"DescribeConnectorsResponse$connectorConfigurations": "<p> The configuration that is applied to the connectors used in the flow. </p>"
}
},
"ConnectorEntity": {
"base": "<p> The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an <i>Account</i> or <i>Opportunity</i>, whereas a ServiceNow entity might be an <i>Incident</i>. </p>",
"refs": {
"ConnectorEntityList$member": null
}
},
"ConnectorEntityField": {
"base": "<p> Describes the data model of a connector field. For example, for an <i>account</i> entity, the fields would be <i>account name</i>, <i>account ID</i>, and so on. </p>",
"refs": {
"ConnectorEntityFieldList$member": null
}
},
"ConnectorEntityFieldList": {
"base": null,
"refs": {
"DescribeConnectorEntityResponse$connectorEntityFields": "<p> Describes the fields for that connector entity. For example, for an <i>account</i> entity, the fields would be <i>account name</i>, <i>account ID</i>, and so on. </p>"
}
},
"ConnectorEntityList": {
"base": null,
"refs": {
"ConnectorEntityMap$value": null
}
},
"ConnectorEntityMap": {
"base": null,
"refs": {
"ListConnectorEntitiesResponse$connectorEntityMap": "<p> The response of <code>ListConnectorEntities</code> 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. </p>"
}
},
"ConnectorMetadata": {
"base": "<p> A structure to specify connector-specific metadata such as <code>oAuthScopes</code>, <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>",
"refs": {
"ConnectorConfiguration$connectorMetadata": "<p> Specifies connector-specific metadata such as <code>oAuthScopes</code>, <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>"
}
},
"ConnectorOAuthRequest": {
"base": "<p> Used by select connectors for which the OAuth workflow is supported, such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack. </p>",
"refs": {
"GoogleAnalyticsConnectorProfileCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>",
"HoneycodeConnectorProfileCredentials$oAuthRequest": null,
"MarketoConnectorProfileCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>",
"OAuthCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>",
"SalesforceConnectorProfileCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>",
"SlackConnectorProfileCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>",
"ZendeskConnectorProfileCredentials$oAuthRequest": "<p> The OAuth requirement needed to request security tokens from the connector endpoint. </p>"
}
},
"ConnectorOperator": {
"base": "<p> The operation to be performed on the provided source fields. </p>",
"refs": {
"Task$connectorOperator": "<p> The operation to be performed on the provided source fields. </p>"
}
},
"ConnectorProfile": {
"base": "<p> Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the <code>connectorProfileProperties</code> field. </p>",
"refs": {
"ConnectorProfileDetailList$member": null
}
},
"ConnectorProfileArn": {
"base": null,
"refs": {
"ConnectorProfile$connectorProfileArn": "<p> The Amazon Resource Name (ARN) of the connector profile. </p>",
"CreateConnectorProfileResponse$connectorProfileArn": "<p> The Amazon Resource Name (ARN) of the connector profile. </p>",
"UpdateConnectorProfileResponse$connectorProfileArn": "<p> The Amazon Resource Name (ARN) of the connector profile. </p>"
}
},
"ConnectorProfileConfig": {
"base": "<p> Defines the connector-specific configuration and credentials for the connector profile. </p>",
"refs": {
"CreateConnectorProfileRequest$connectorProfileConfig": "<p> Defines the connector-specific configuration and credentials. </p>",
"UpdateConnectorProfileRequest$connectorProfileConfig": "<p> Defines the connector-specific profile configuration and credentials. </p>"
}
},
"ConnectorProfileCredentials": {
"base": "<p> The connector-specific credentials required by a connector. </p>",
"refs": {
"ConnectorProfileConfig$connectorProfileCredentials": "<p> The connector-specific credentials required by each connector. </p>"
}
},
"ConnectorProfileDetailList": {
"base": null,
"refs": {
"DescribeConnectorProfilesResponse$connectorProfileDetails": "<p> Returns information about the connector profiles associated with the flow. </p>"
}
},
"ConnectorProfileName": {
"base": null,
"refs": {
"ConnectorProfile$connectorProfileName": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>",
"ConnectorProfileNameList$member": null,
"CreateConnectorProfileRequest$connectorProfileName": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your Amazon Web Services account. </p>",
"DeleteConnectorProfileRequest$connectorProfileName": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your account. </p>",
"DescribeConnectorEntityRequest$connectorProfileName": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>",
"DestinationFlowConfig$connectorProfileName": "<p> The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account. </p>",
"ListConnectorEntitiesRequest$connectorProfileName": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the downstream connector. </p>",
"SourceFlowConfig$connectorProfileName": "<p> The name of the connector profile. This name must be unique for each connector profile in the Amazon Web Services account. </p>",
"UpdateConnectorProfileRequest$connectorProfileName": "<p> The name of the connector profile and is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>"
}
},
"ConnectorProfileNameList": {
"base": null,
"refs": {
"DescribeConnectorProfilesRequest$connectorProfileNames": "<p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>"
}
},
"ConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required by each connector. </p>",
"refs": {
"ConnectorProfile$connectorProfileProperties": "<p> The connector-specific properties of the profile configuration. </p>",
"ConnectorProfileConfig$connectorProfileProperties": "<p> The connector-specific properties of the profile configuration. </p>"
}
},
"ConnectorServerException": {
"base": "<p> An error occurred when retrieving data from the connector endpoint. </p>",
"refs": {
}
},
"ConnectorType": {
"base": null,
"refs": {
"ConnectorConfigurationsMap$key": null,
"ConnectorProfile$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>",
"ConnectorTypeList$member": null,
"CreateConnectorProfileRequest$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>",
"DescribeConnectorEntityRequest$connectorType": "<p> The type of connector application, such as Salesforce, Amplitude, and so on. </p>",
"DescribeConnectorProfilesRequest$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>",
"DestinationFlowConfig$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>",
"FlowDefinition$sourceConnectorType": "<p> Specifies the source connector type, such as Salesforce, Amazon S3, Amplitude, and so on. </p>",
"FlowDefinition$destinationConnectorType": "<p> Specifies the destination connector type, such as Salesforce, Amazon S3, Amplitude, and so on. </p>",
"ListConnectorEntitiesRequest$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>",
"SourceFlowConfig$connectorType": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>"
}
},
"ConnectorTypeList": {
"base": null,
"refs": {
"ConnectorConfiguration$supportedDestinationConnectors": "<p> Lists the connectors that are available for use as destinations. </p>",
"DescribeConnectorsRequest$connectorTypes": "<p> The type of connector, such as Salesforce, Amplitude, and so on. </p>"
}
},
"CreateConnectorProfileRequest": {
"base": null,
"refs": {
}
},
"CreateConnectorProfileResponse": {
"base": null,
"refs": {
}
},
"CreateFlowRequest": {
"base": null,
"refs": {
}
},
"CreateFlowResponse": {
"base": null,
"refs": {
}
},
"CreatedBy": {
"base": null,
"refs": {
"DescribeFlowResponse$createdBy": "<p> The ARN of the user who created the flow. </p>",
"FlowDefinition$createdBy": "<p> The ARN of the user who created the flow. </p>"
}
},
"CustomerProfilesDestinationProperties": {
"base": "<p> The properties that are applied when Amazon Connect Customer Profiles is used as a destination. </p>",
"refs": {
"DestinationConnectorProperties$CustomerProfiles": "<p> The properties required to query Amazon Connect Customer Profiles. </p>"
}
},
"CustomerProfilesMetadata": {
"base": "<p> The connector metadata specific to Amazon Connect Customer Profiles. </p>",
"refs": {
"ConnectorMetadata$CustomerProfiles": "<p> The connector metadata specific to Amazon Connect Customer Profiles. </p>"
}
},
"DataPullMode": {
"base": null,
"refs": {
"ScheduledTriggerProperties$dataPullMode": "<p> Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run. </p>"
}
},
"DatabaseUrl": {
"base": null,
"refs": {
"RedshiftConnectorProfileProperties$databaseUrl": "<p> The JDBC URL of the Amazon Redshift cluster. </p>"
}
},
"DatadogConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$Datadog": "<p> The operation to be performed on the provided Datadog source fields. </p>"
}
},
"DatadogConnectorProfileCredentials": {
"base": "<p> The connector-specific credentials required by Datadog. </p>",
"refs": {
"ConnectorProfileCredentials$Datadog": "<p> The connector-specific credentials required when using Datadog. </p>"
}
},
"DatadogConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required by Datadog. </p>",
"refs": {
"ConnectorProfileProperties$Datadog": "<p> The connector-specific properties required by Datadog. </p>"
}
},
"DatadogMetadata": {
"base": "<p> The connector metadata specific to Datadog. </p>",
"refs": {
"ConnectorMetadata$Datadog": "<p> The connector metadata specific to Datadog. </p>"
}
},
"DatadogSourceProperties": {
"base": "<p> The properties that are applied when Datadog is being used as a source. </p>",
"refs": {
"SourceConnectorProperties$Datadog": "<p> Specifies the information that is required for querying Datadog. </p>"
}
},
"Date": {
"base": null,
"refs": {
"ConnectorProfile$createdAt": "<p> Specifies when the connector profile was created. </p>",
"ConnectorProfile$lastUpdatedAt": "<p> Specifies when the connector profile was last updated. </p>",
"DescribeFlowResponse$createdAt": "<p> Specifies when the flow was created. </p>",
"DescribeFlowResponse$lastUpdatedAt": "<p> Specifies when the flow was last updated. </p>",
"ExecutionDetails$mostRecentExecutionTime": "<p> Specifies the time of the most recent flow run. </p>",
"ExecutionRecord$startedAt": "<p> Specifies the start time of the flow run. </p>",
"ExecutionRecord$lastUpdatedAt": "<p> Specifies the time of the most recent update. </p>",
"ExecutionRecord$dataPullStartTime": "<p> The timestamp that determines the first new or updated record to be transferred in the flow run. </p>",
"ExecutionRecord$dataPullEndTime": "<p> The timestamp that indicates the last new or updated record to be transferred in the flow run. </p>",
"FlowDefinition$createdAt": "<p> Specifies when the flow was created. </p>",
"FlowDefinition$lastUpdatedAt": "<p> Specifies when the flow was last updated. </p>",
"ScheduledTriggerProperties$scheduleStartTime": "<p> Specifies the scheduled start time for a schedule-triggered flow. </p>",
"ScheduledTriggerProperties$scheduleEndTime": "<p> Specifies the scheduled end time for a schedule-triggered flow. </p>",
"ScheduledTriggerProperties$firstExecutionFrom": "<p> Specifies the date range for the records to import from the connector in the first flow run. </p>"
}
},
"DatetimeTypeFieldName": {
"base": null,
"refs": {
"IncrementalPullConfig$datetimeTypeFieldName": "<p> A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source. </p>"
}
},
"DeleteConnectorProfileRequest": {
"base": null,
"refs": {
}
},
"DeleteConnectorProfileResponse": {
"base": null,
"refs": {
}
},
"DeleteFlowRequest": {
"base": null,
"refs": {
}
},
"DeleteFlowResponse": {
"base": null,
"refs": {
}
},
"DescribeConnectorEntityRequest": {
"base": null,
"refs": {
}
},
"DescribeConnectorEntityResponse": {
"base": null,
"refs": {
}
},
"DescribeConnectorProfilesRequest": {
"base": null,
"refs": {
}
},
"DescribeConnectorProfilesResponse": {
"base": null,
"refs": {
}
},
"DescribeConnectorsRequest": {
"base": null,
"refs": {
}
},
"DescribeConnectorsResponse": {
"base": null,
"refs": {
}
},
"DescribeFlowExecutionRecordsRequest": {
"base": null,
"refs": {
}
},
"DescribeFlowExecutionRecordsResponse": {
"base": null,
"refs": {
}
},
"DescribeFlowRequest": {
"base": null,
"refs": {
}
},
"DescribeFlowResponse": {
"base": null,
"refs": {
}
},
"Description": {
"base": null,
"refs": {
"ConnectorEntityField$description": "<p> A description of the connector entity field. </p>"
}
},
"DestinationConnectorProperties": {
"base": "<p> This stores the information that is required to query a particular connector. </p>",
"refs": {
"DestinationFlowConfig$destinationConnectorProperties": "<p> This stores the information that is required to query a particular connector. </p>"
}
},
"DestinationField": {
"base": null,
"refs": {
"Task$destinationField": "<p> A field in a destination connector, or a field value against which Amazon AppFlow validates a source field. </p>"
}
},
"DestinationFieldProperties": {
"base": "<p> The properties that can be applied to a field when connector is being used as a destination. </p>",
"refs": {
"ConnectorEntityField$destinationProperties": "<p> The properties applied to a field when the connector is being used as a destination. </p>"
}
},
"DestinationFlowConfig": {
"base": "<p> Contains information about the configuration of destination connectors present in the flow. </p>",
"refs": {
"DestinationFlowConfigList$member": null
}
},
"DestinationFlowConfigList": {
"base": null,
"refs": {
"CreateFlowRequest$destinationFlowConfigList": "<p> The configuration that controls how Amazon AppFlow places data in the destination connector. </p>",
"DescribeFlowResponse$destinationFlowConfigList": "<p> The configuration that controls how Amazon AppFlow transfers data to the destination connector. </p>",
"UpdateFlowRequest$destinationFlowConfigList": "<p> The configuration that controls how Amazon AppFlow transfers data to the destination connector. </p>"
}
},
"DocumentType": {
"base": null,
"refs": {
"VeevaSourceProperties$documentType": "<p>The document type specified in the Veeva document extract flow.</p>"
}
},
"DomainName": {
"base": null,
"refs": {
"CustomerProfilesDestinationProperties$domainName": "<p> The unique name of the Amazon Connect Customer Profiles domain. </p>"
}
},
"DynatraceConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$Dynatrace": "<p> The operation to be performed on the provided Dynatrace source fields. </p>"
}
},
"DynatraceConnectorProfileCredentials": {
"base": "<p> The connector-specific profile credentials required by Dynatrace. </p>",
"refs": {
"ConnectorProfileCredentials$Dynatrace": "<p> The connector-specific credentials required when using Dynatrace. </p>"
}
},
"DynatraceConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required by Dynatrace. </p>",
"refs": {
"ConnectorProfileProperties$Dynatrace": "<p> The connector-specific properties required by Dynatrace. </p>"
}
},
"DynatraceMetadata": {
"base": "<p> The connector metadata specific to Dynatrace. </p>",
"refs": {
"ConnectorMetadata$Dynatrace": "<p> The connector metadata specific to Dynatrace. </p>"
}
},
"DynatraceSourceProperties": {
"base": "<p> The properties that are applied when Dynatrace is being used as a source. </p>",
"refs": {
"SourceConnectorProperties$Dynatrace": "<p> Specifies the information that is required for querying Dynatrace. </p>"
}
},
"EntitiesPath": {
"base": null,
"refs": {
"ListConnectorEntitiesRequest$entitiesPath": "<p> This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the <code>entitiesPath</code> parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider. </p>"
}
},
"ErrorHandlingConfig": {
"base": "<p> The settings that determine how Amazon AppFlow handles an error when placing data in the destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details. </p>",
"refs": {
"EventBridgeDestinationProperties$errorHandlingConfig": null,
"HoneycodeDestinationProperties$errorHandlingConfig": null,
"RedshiftDestinationProperties$errorHandlingConfig": "<p> 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 flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details. </p>",
"SalesforceDestinationProperties$errorHandlingConfig": "<p> 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 flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details. </p>",
"SnowflakeDestinationProperties$errorHandlingConfig": "<p> The settings that determine how Amazon AppFlow handles an error when placing data in the Snowflake destination. For example, this setting would determine if the flow should fail after one insertion error, or continue and attempt to insert every record regardless of the initial failure. <code>ErrorHandlingConfig</code> is a part of the destination connector details. </p>",
"ZendeskDestinationProperties$errorHandlingConfig": null
}
},
"ErrorInfo": {
"base": "<p> Provides details in the event of a failed flow, including the failure count and the related error messages. </p>",
"refs": {
"ExecutionResult$errorInfo": "<p> Provides any error message information related to the flow run. </p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"ConflictException$message": null,
"ConnectorAuthenticationException$message": null,
"ConnectorServerException$message": null,
"InternalServerException$message": null,
"ResourceNotFoundException$message": null,
"ServiceQuotaExceededException$message": null,
"UnsupportedOperationException$message": null,
"ValidationException$message": null
}
},
"EventBridgeDestinationProperties": {
"base": "<p> The properties that are applied when Amazon EventBridge is being used as a destination. </p>",
"refs": {
"DestinationConnectorProperties$EventBridge": "<p> The properties required to query Amazon EventBridge. </p>"
}
},
"EventBridgeMetadata": {
"base": "<p> The connector metadata specific to Amazon EventBridge. </p>",
"refs": {
"ConnectorMetadata$EventBridge": "<p> The connector metadata specific to Amazon EventBridge. </p>"
}
},
"ExecutionDetails": {
"base": "<p> Describes the details of the flow run, including the timestamp, status, and message. </p>",
"refs": {
"DescribeFlowResponse$lastRunExecutionDetails": "<p> Describes the details of the most recent flow run. </p>",
"FlowDefinition$lastRunExecutionDetails": "<p> Describes the details of the most recent flow run. </p>"
}
},
"ExecutionId": {
"base": null,
"refs": {
"ExecutionRecord$executionId": "<p> Specifies the identifier of the given flow run. </p>",
"StartFlowResponse$executionId": "<p> 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. </p>"
}
},
"ExecutionMessage": {
"base": null,
"refs": {
"ErrorInfo$executionMessage": "<p> Specifies the error message that appears if a flow fails. </p>"
}
},
"ExecutionRecord": {
"base": "<p> Specifies information about the past flow run instances for a given flow. </p>",
"refs": {
"FlowExecutionList$member": null
}
},
"ExecutionResult": {
"base": "<p> Specifies the end result of the flow run. </p>",
"refs": {
"ExecutionRecord$executionResult": "<p> Describes the result of the given flow run. </p>"
}
},
"ExecutionStatus": {
"base": null,
"refs": {
"ExecutionDetails$mostRecentExecutionStatus": "<p> Specifies the status of the most recent flow run. </p>",
"ExecutionRecord$executionStatus": "<p> Specifies the flow run status and whether it is in progress, has completed successfully, or has failed. </p>"
}
},
"FieldType": {
"base": null,
"refs": {
"FieldTypeDetails$fieldType": "<p> The type of field, such as string, integer, date, and so on. </p>"
}
},
"FieldTypeDetails": {
"base": "<p> Contains details regarding the supported field type and the operators that can be applied for filtering. </p>",
"refs": {
"SupportedFieldTypeDetails$v1": "<p> The initial supported version for <code>fieldType</code>. If this is later changed to a different version, v2 will be introduced. </p>"
}
},
"FileType": {
"base": null,
"refs": {
"S3OutputFormatConfig$fileType": "<p> Indicates the file type that Amazon AppFlow places in the Amazon S3 bucket. </p>",
"UpsolverS3OutputFormatConfig$fileType": "<p> Indicates the file type that Amazon AppFlow places in the Upsolver Amazon S3 bucket. </p>"
}
},
"FilterOperatorList": {
"base": null,
"refs": {
"FieldTypeDetails$filterOperators": "<p> The list of operators supported by a field. </p>"
}
},
"FlowArn": {
"base": null,
"refs": {
"CreateFlowResponse$flowArn": "<p> The flow's Amazon Resource Name (ARN). </p>",
"DescribeFlowResponse$flowArn": "<p> The flow's Amazon Resource Name (ARN). </p>",
"FlowDefinition$flowArn": "<p> The flow's Amazon Resource Name (ARN). </p>",
"StartFlowResponse$flowArn": "<p> The flow's Amazon Resource Name (ARN). </p>",
"StopFlowResponse$flowArn": "<p> The flow's Amazon Resource Name (ARN). </p>"
}
},
"FlowDefinition": {
"base": "<p> The properties of the flow, such as its source, destination, trigger type, and so on. </p>",
"refs": {
"FlowList$member": null
}
},
"FlowDescription": {
"base": null,
"refs": {
"CreateFlowRequest$description": "<p> A description of the flow you want to create. </p>",
"DescribeFlowResponse$description": "<p> A description of the flow. </p>",
"FlowDefinition$description": "<p> A user-entered description of the flow. </p>",
"UpdateFlowRequest$description": "<p> A description of the flow. </p>"
}
},
"FlowExecutionList": {
"base": null,
"refs": {
"DescribeFlowExecutionRecordsResponse$flowExecutions": "<p> Returns a list of all instances when this flow was run. </p>"
}
},
"FlowList": {
"base": null,
"refs": {
"ListFlowsResponse$flows": "<p> The list of flows associated with your account. </p>"
}
},
"FlowName": {
"base": null,
"refs": {
"CreateFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"DeleteFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"DescribeFlowExecutionRecordsRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"DescribeFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"DescribeFlowResponse$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"FlowDefinition$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"StartFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"StopFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>",
"UpdateFlowRequest$flowName": "<p> The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only. </p>"
}
},
"FlowStatus": {
"base": null,
"refs": {
"CreateFlowResponse$flowStatus": "<p> Indicates the current status of the flow. </p>",
"DescribeFlowResponse$flowStatus": "<p> Indicates the current status of the flow. </p>",
"FlowDefinition$flowStatus": "<p> Indicates the current status of the flow. </p>",
"StartFlowResponse$flowStatus": "<p> Indicates the current status of the flow. </p>",
"StopFlowResponse$flowStatus": "<p> Indicates the current status of the flow. </p>",
"UpdateFlowResponse$flowStatus": "<p>Indicates the current status of the flow. </p>"
}
},
"FlowStatusMessage": {
"base": null,
"refs": {
"DescribeFlowResponse$flowStatusMessage": "<p> Contains an error message if the flow status is in a suspended or error state. This applies only to scheduled or event-triggered flows. </p>"
}
},
"GoogleAnalyticsConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$GoogleAnalytics": "<p> The operation to be performed on the provided Google Analytics source fields. </p>"
}
},
"GoogleAnalyticsConnectorProfileCredentials": {
"base": "<p> The connector-specific profile credentials required by Google Analytics. </p>",
"refs": {
"ConnectorProfileCredentials$GoogleAnalytics": "<p> The connector-specific credentials required when using Google Analytics. </p>"
}
},
"GoogleAnalyticsConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required by Google Analytics. </p>",
"refs": {
"ConnectorProfileProperties$GoogleAnalytics": "<p> The connector-specific properties required Google Analytics. </p>"
}
},
"GoogleAnalyticsMetadata": {
"base": "<p> The connector metadata specific to Google Analytics. </p>",
"refs": {
"ConnectorMetadata$GoogleAnalytics": "<p> The connector metadata specific to Google Analytics. </p>"
}
},
"GoogleAnalyticsSourceProperties": {
"base": "<p> The properties that are applied when Google Analytics is being used as a source. </p>",
"refs": {
"SourceConnectorProperties$GoogleAnalytics": "<p> Specifies the information that is required for querying Google Analytics. </p>"
}
},
"Group": {
"base": null,
"refs": {
"ConnectorEntityMap$key": null
}
},
"HoneycodeConnectorProfileCredentials": {
"base": "<p> The connector-specific credentials required when using Amazon Honeycode. </p>",
"refs": {
"ConnectorProfileCredentials$Honeycode": "<p> The connector-specific credentials required when using Amazon Honeycode. </p>"
}
},
"HoneycodeConnectorProfileProperties": {
"base": "<p> The connector-specific properties required when using Amazon Honeycode. </p>",
"refs": {
"ConnectorProfileProperties$Honeycode": "<p> The connector-specific properties required by Amazon Honeycode. </p>"
}
},
"HoneycodeDestinationProperties": {
"base": "<p> The properties that are applied when Amazon Honeycode is used as a destination. </p>",
"refs": {
"DestinationConnectorProperties$Honeycode": "<p> The properties required to query Amazon Honeycode. </p>"
}
},
"HoneycodeMetadata": {
"base": "<p> The connector metadata specific to Amazon Honeycode. </p>",
"refs": {
"ConnectorMetadata$Honeycode": "<p> The connector metadata specific to Amazon Honeycode. </p>"
}
},
"IdFieldNameList": {
"base": "<p> A list of field names that can be used as an ID field when performing a write operation. </p>",
"refs": {
"SalesforceDestinationProperties$idFieldNames": "<p> The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update or delete. </p>",
"ZendeskDestinationProperties$idFieldNames": null
}
},
"Identifier": {
"base": null,
"refs": {
"ConnectorEntityField$identifier": "<p> The unique identifier of the connector field. </p>"
}
},
"IncrementalPullConfig": {
"base": "<p> Specifies the configuration used when importing incremental records from the source. </p>",
"refs": {
"SourceFlowConfig$incrementalPullConfig": "<p> 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. </p>"
}
},
"InforNexusConnectorOperator": {
"base": null,
"refs": {
"ConnectorOperator$InforNexus": "<p> The operation to be performed on the provided Infor Nexus source fields. </p>"
}
},
"InforNexusConnectorProfileCredentials": {
"base": "<p> The connector-specific profile credentials required by Infor Nexus. </p>",
"refs": {
"ConnectorProfileCredentials$InforNexus": "<p> The connector-specific credentials required when using Infor Nexus. </p>"
}
},
"InforNexusConnectorProfileProperties": {
"base": "<p> The connector-specific profile properties required by Infor Nexus. </p>",
"refs": {
"ConnectorProfileProperties$InforNexus": "<p> The connector-specific properties required by Infor Nexus. </p>"
}
},
"InforNexusMetadata": {
"base": "<p> The connector metadata specific to Infor Nexus. </p>",
"refs": {
"ConnectorMetadata$InforNexus": "<p> The connector metadata specific to Infor Nexus. </p>"
}
},
"InforNexusSourceProperties": {
"base": "<p> The properties that are applied when Infor Nexus is being used as a source. </p>",
"refs": {
"SourceConnectorProperties$InforNexus": "<p> Specifies the information that is required for querying Infor Nexus. </p>"
}
},
"InstanceUrl": {
"base": null,
"refs": {
"DatadogConnectorProfileProperties$instanceUrl": "<p> The location of the Datadog resource. </p>",
"DynatraceConnectorProfileProperties$instanceUrl": "<p> The location of the Dynatrace resource. </p>",
"InforNexusConnectorProfileProperties$instanceUrl": "<p> The location of the Infor Nexus resource. </p>",
"MarketoConnectorProfileProperties$instanceUrl": "<p> The location of the Marketo resource. </p>",
"SalesforceConnectorProfileProperties$instanceUrl": "<p> The location of the Salesforce resource. </p>",
"ServiceNowConnectorProfileProperties$instanceUrl": "<p> The location of the ServiceNow resource. </p>",
"SlackConnectorProfileProperties$instanceUrl": "<p> The location of the Slack resource. </p>",
"VeevaConnectorProfileProperties$instanceUrl": "<p> The location of the Veeva resource. </p>",
"ZendeskConnectorProfileProperties$instanceUrl": "<p> The location of the Zendesk resource. </p>"
}
},
"InternalServerException": {
"base": "<p> An internal service error occurred during the processing of your request. Try again later. </p>",
"refs": {
}
},
"KMSArn": {
"base": null,
"refs": {
"CreateConnectorProfileRequest$kmsArn": "<p> 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. </p>",
"CreateFlowRequest$kmsArn": "<p> 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. </p>",
"DescribeFlowResponse$kmsArn": "<p> 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. </p>"
}
},
"Key": {
"base": null,
"refs": {
"InforNexusConnectorProfileCredentials$secretAccessKey": "<p> The secret key used to sign requests. </p>",
"InforNexusConnectorProfileCredentials$datakey": "<p> The encryption keys used to encrypt data. </p>"
}
},
"Label": {
"base": null,
"refs": {
"ConnectorEntity$label": "<p> The label applied to the connector entity. </p>",
"ConnectorEntityField$label": "<p> The label applied to a connector entity field. </p>"
}
},
"ListConnectorEntitiesRequest": {
"base": null,
"refs": {
}