aws-sdk-appflow 1.20.0 → 1.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-appflow/client.rb +506 -24
- data/lib/aws-sdk-appflow/client_api.rb +339 -1
- data/lib/aws-sdk-appflow/errors.rb +32 -0
- data/lib/aws-sdk-appflow/types.rb +1346 -36
- data/lib/aws-sdk-appflow.rb +1 -1
- metadata +2 -2
@@ -10,6 +10,19 @@
|
|
10
10
|
module Aws::Appflow
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# AppFlow/Requester has invalid or missing permissions.
|
14
|
+
#
|
15
|
+
# @!attribute [rw] message
|
16
|
+
# @return [String]
|
17
|
+
#
|
18
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/AccessDeniedException AWS API Documentation
|
19
|
+
#
|
20
|
+
class AccessDeniedException < Struct.new(
|
21
|
+
:message)
|
22
|
+
SENSITIVE = []
|
23
|
+
include Aws::Structure
|
24
|
+
end
|
25
|
+
|
13
26
|
# The aggregation settings that you can use to customize the output
|
14
27
|
# format of your flow data.
|
15
28
|
#
|
@@ -57,7 +70,7 @@ module Aws::Appflow
|
|
57
70
|
class AmplitudeConnectorProfileCredentials < Struct.new(
|
58
71
|
:api_key,
|
59
72
|
:secret_key)
|
60
|
-
SENSITIVE = [:secret_key]
|
73
|
+
SENSITIVE = [:api_key, :secret_key]
|
61
74
|
include Aws::Structure
|
62
75
|
end
|
63
76
|
|
@@ -98,6 +111,118 @@ module Aws::Appflow
|
|
98
111
|
include Aws::Structure
|
99
112
|
end
|
100
113
|
|
114
|
+
# The API key credentials required for API key authentication.
|
115
|
+
#
|
116
|
+
# @note When making an API call, you may pass ApiKeyCredentials
|
117
|
+
# data as a hash:
|
118
|
+
#
|
119
|
+
# {
|
120
|
+
# api_key: "ApiKey", # required
|
121
|
+
# api_secret_key: "ApiSecretKey",
|
122
|
+
# }
|
123
|
+
#
|
124
|
+
# @!attribute [rw] api_key
|
125
|
+
# The API key required for API key authentication.
|
126
|
+
# @return [String]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] api_secret_key
|
129
|
+
# The API secret key required for API key authentication.
|
130
|
+
# @return [String]
|
131
|
+
#
|
132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ApiKeyCredentials AWS API Documentation
|
133
|
+
#
|
134
|
+
class ApiKeyCredentials < Struct.new(
|
135
|
+
:api_key,
|
136
|
+
:api_secret_key)
|
137
|
+
SENSITIVE = [:api_key, :api_secret_key]
|
138
|
+
include Aws::Structure
|
139
|
+
end
|
140
|
+
|
141
|
+
# Information about required authentication parameters.
|
142
|
+
#
|
143
|
+
# @!attribute [rw] key
|
144
|
+
# The authentication key required to authenticate with the connector.
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
# @!attribute [rw] is_required
|
148
|
+
# Indicates whether this authentication parameter is required.
|
149
|
+
# @return [Boolean]
|
150
|
+
#
|
151
|
+
# @!attribute [rw] label
|
152
|
+
# Label used for authentication parameter.
|
153
|
+
# @return [String]
|
154
|
+
#
|
155
|
+
# @!attribute [rw] description
|
156
|
+
# A description about the authentication parameter.
|
157
|
+
# @return [String]
|
158
|
+
#
|
159
|
+
# @!attribute [rw] is_sensitive_field
|
160
|
+
# Indicates whether this authentication parameter is a sensitive
|
161
|
+
# field.
|
162
|
+
# @return [Boolean]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] connector_supplied_values
|
165
|
+
# Contains default values for this authentication parameter that are
|
166
|
+
# supplied by the connector.
|
167
|
+
# @return [Array<String>]
|
168
|
+
#
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/AuthParameter AWS API Documentation
|
170
|
+
#
|
171
|
+
class AuthParameter < Struct.new(
|
172
|
+
:key,
|
173
|
+
:is_required,
|
174
|
+
:label,
|
175
|
+
:description,
|
176
|
+
:is_sensitive_field,
|
177
|
+
:connector_supplied_values)
|
178
|
+
SENSITIVE = []
|
179
|
+
include Aws::Structure
|
180
|
+
end
|
181
|
+
|
182
|
+
# Contains information about the authentication config that the
|
183
|
+
# connector supports.
|
184
|
+
#
|
185
|
+
# @!attribute [rw] is_basic_auth_supported
|
186
|
+
# Indicates whether basic authentication is supported by the
|
187
|
+
# connector.
|
188
|
+
# @return [Boolean]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] is_api_key_auth_supported
|
191
|
+
# Indicates whether API key authentication is supported by the
|
192
|
+
# connector
|
193
|
+
# @return [Boolean]
|
194
|
+
#
|
195
|
+
# @!attribute [rw] is_o_auth_2_supported
|
196
|
+
# Indicates whether OAuth 2.0 authentication is supported by the
|
197
|
+
# connector.
|
198
|
+
# @return [Boolean]
|
199
|
+
#
|
200
|
+
# @!attribute [rw] is_custom_auth_supported
|
201
|
+
# Indicates whether custom authentication is supported by the
|
202
|
+
# connector
|
203
|
+
# @return [Boolean]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] o_auth_2_defaults
|
206
|
+
# Contains the default values required for OAuth 2.0 authentication.
|
207
|
+
# @return [Types::OAuth2Defaults]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] custom_auth_configs
|
210
|
+
# Contains information required for custom authentication.
|
211
|
+
# @return [Array<Types::CustomAuthConfig>]
|
212
|
+
#
|
213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/AuthenticationConfig AWS API Documentation
|
214
|
+
#
|
215
|
+
class AuthenticationConfig < Struct.new(
|
216
|
+
:is_basic_auth_supported,
|
217
|
+
:is_api_key_auth_supported,
|
218
|
+
:is_o_auth_2_supported,
|
219
|
+
:is_custom_auth_supported,
|
220
|
+
:o_auth_2_defaults,
|
221
|
+
:custom_auth_configs)
|
222
|
+
SENSITIVE = []
|
223
|
+
include Aws::Structure
|
224
|
+
end
|
225
|
+
|
101
226
|
# The basic auth credentials required for basic authentication.
|
102
227
|
#
|
103
228
|
# @note When making an API call, you may pass BasicAuthCredentials
|
@@ -188,6 +313,78 @@ module Aws::Appflow
|
|
188
313
|
# `supportedRegions`, `privateLinkServiceUrl`, and so on.
|
189
314
|
# @return [Types::ConnectorMetadata]
|
190
315
|
#
|
316
|
+
# @!attribute [rw] connector_type
|
317
|
+
# The connector type.
|
318
|
+
# @return [String]
|
319
|
+
#
|
320
|
+
# @!attribute [rw] connector_label
|
321
|
+
# The label used for registering the connector.
|
322
|
+
# @return [String]
|
323
|
+
#
|
324
|
+
# @!attribute [rw] connector_description
|
325
|
+
# A description about the connector.
|
326
|
+
# @return [String]
|
327
|
+
#
|
328
|
+
# @!attribute [rw] connector_owner
|
329
|
+
# The owner who developed the connector.
|
330
|
+
# @return [String]
|
331
|
+
#
|
332
|
+
# @!attribute [rw] connector_name
|
333
|
+
# The connector name.
|
334
|
+
# @return [String]
|
335
|
+
#
|
336
|
+
# @!attribute [rw] connector_version
|
337
|
+
# The connector version.
|
338
|
+
# @return [String]
|
339
|
+
#
|
340
|
+
# @!attribute [rw] connector_arn
|
341
|
+
# The Amazon Resource Name (ARN) for the registered connector.
|
342
|
+
# @return [String]
|
343
|
+
#
|
344
|
+
# @!attribute [rw] connector_modes
|
345
|
+
# The connection modes that the connector supports.
|
346
|
+
# @return [Array<String>]
|
347
|
+
#
|
348
|
+
# @!attribute [rw] authentication_config
|
349
|
+
# The authentication config required for the connector.
|
350
|
+
# @return [Types::AuthenticationConfig]
|
351
|
+
#
|
352
|
+
# @!attribute [rw] connector_runtime_settings
|
353
|
+
# The required connector runtime settings.
|
354
|
+
# @return [Array<Types::ConnectorRuntimeSetting>]
|
355
|
+
#
|
356
|
+
# @!attribute [rw] supported_api_versions
|
357
|
+
# A list of API versions that are supported by the connector.
|
358
|
+
# @return [Array<String>]
|
359
|
+
#
|
360
|
+
# @!attribute [rw] supported_operators
|
361
|
+
# A list of operators supported by the connector.
|
362
|
+
# @return [Array<String>]
|
363
|
+
#
|
364
|
+
# @!attribute [rw] supported_write_operations
|
365
|
+
# A list of write operations supported by the connector.
|
366
|
+
# @return [Array<String>]
|
367
|
+
#
|
368
|
+
# @!attribute [rw] connector_provisioning_type
|
369
|
+
# The provisioning type used to register the connector.
|
370
|
+
# @return [String]
|
371
|
+
#
|
372
|
+
# @!attribute [rw] connector_provisioning_config
|
373
|
+
# The configuration required for registering the connector.
|
374
|
+
# @return [Types::ConnectorProvisioningConfig]
|
375
|
+
#
|
376
|
+
# @!attribute [rw] logo_url
|
377
|
+
# Logo URL of the connector.
|
378
|
+
# @return [String]
|
379
|
+
#
|
380
|
+
# @!attribute [rw] registered_at
|
381
|
+
# The date on which the connector was registered.
|
382
|
+
# @return [Time]
|
383
|
+
#
|
384
|
+
# @!attribute [rw] registered_by
|
385
|
+
# Information about who registered the connector.
|
386
|
+
# @return [String]
|
387
|
+
#
|
191
388
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorConfiguration AWS API Documentation
|
192
389
|
#
|
193
390
|
class ConnectorConfiguration < Struct.new(
|
@@ -198,7 +395,89 @@ module Aws::Appflow
|
|
198
395
|
:is_private_link_enabled,
|
199
396
|
:is_private_link_endpoint_url_required,
|
200
397
|
:supported_trigger_types,
|
201
|
-
:connector_metadata
|
398
|
+
:connector_metadata,
|
399
|
+
:connector_type,
|
400
|
+
:connector_label,
|
401
|
+
:connector_description,
|
402
|
+
:connector_owner,
|
403
|
+
:connector_name,
|
404
|
+
:connector_version,
|
405
|
+
:connector_arn,
|
406
|
+
:connector_modes,
|
407
|
+
:authentication_config,
|
408
|
+
:connector_runtime_settings,
|
409
|
+
:supported_api_versions,
|
410
|
+
:supported_operators,
|
411
|
+
:supported_write_operations,
|
412
|
+
:connector_provisioning_type,
|
413
|
+
:connector_provisioning_config,
|
414
|
+
:logo_url,
|
415
|
+
:registered_at,
|
416
|
+
:registered_by)
|
417
|
+
SENSITIVE = []
|
418
|
+
include Aws::Structure
|
419
|
+
end
|
420
|
+
|
421
|
+
# Information about the registered connector.
|
422
|
+
#
|
423
|
+
# @!attribute [rw] connector_description
|
424
|
+
# A description about the registered connector.
|
425
|
+
# @return [String]
|
426
|
+
#
|
427
|
+
# @!attribute [rw] connector_name
|
428
|
+
# The name of the connector.
|
429
|
+
# @return [String]
|
430
|
+
#
|
431
|
+
# @!attribute [rw] connector_owner
|
432
|
+
# The owner of the connector.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] connector_version
|
436
|
+
# The connector version.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] application_type
|
440
|
+
# The application type of the connector.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] connector_type
|
444
|
+
# The connector type.
|
445
|
+
# @return [String]
|
446
|
+
#
|
447
|
+
# @!attribute [rw] connector_label
|
448
|
+
# A label used for the connector.
|
449
|
+
# @return [String]
|
450
|
+
#
|
451
|
+
# @!attribute [rw] registered_at
|
452
|
+
# The time at which the connector was registered.
|
453
|
+
# @return [Time]
|
454
|
+
#
|
455
|
+
# @!attribute [rw] registered_by
|
456
|
+
# The user who registered the connector.
|
457
|
+
# @return [String]
|
458
|
+
#
|
459
|
+
# @!attribute [rw] connector_provisioning_type
|
460
|
+
# The provisioning type that the connector uses.
|
461
|
+
# @return [String]
|
462
|
+
#
|
463
|
+
# @!attribute [rw] connector_modes
|
464
|
+
# The connection mode that the connector supports.
|
465
|
+
# @return [Array<String>]
|
466
|
+
#
|
467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorDetail AWS API Documentation
|
468
|
+
#
|
469
|
+
class ConnectorDetail < Struct.new(
|
470
|
+
:connector_description,
|
471
|
+
:connector_name,
|
472
|
+
:connector_owner,
|
473
|
+
:connector_version,
|
474
|
+
:application_type,
|
475
|
+
:connector_type,
|
476
|
+
:connector_label,
|
477
|
+
:registered_at,
|
478
|
+
:registered_by,
|
479
|
+
:connector_provisioning_type,
|
480
|
+
:connector_modes)
|
202
481
|
SENSITIVE = []
|
203
482
|
include Aws::Structure
|
204
483
|
end
|
@@ -242,10 +521,28 @@ module Aws::Appflow
|
|
242
521
|
# The unique identifier of the connector field.
|
243
522
|
# @return [String]
|
244
523
|
#
|
524
|
+
# @!attribute [rw] parent_identifier
|
525
|
+
# The parent identifier of the connector field.
|
526
|
+
# @return [String]
|
527
|
+
#
|
245
528
|
# @!attribute [rw] label
|
246
529
|
# The label applied to a connector entity field.
|
247
530
|
# @return [String]
|
248
531
|
#
|
532
|
+
# @!attribute [rw] is_primary_key
|
533
|
+
# Booelan value that indicates whether this field can be used as a
|
534
|
+
# primary key.
|
535
|
+
# @return [Boolean]
|
536
|
+
#
|
537
|
+
# @!attribute [rw] default_value
|
538
|
+
# Default value that can be assigned to this field.
|
539
|
+
# @return [String]
|
540
|
+
#
|
541
|
+
# @!attribute [rw] is_deprecated
|
542
|
+
# Booelan value that indicates whether this field is deprecated or
|
543
|
+
# not.
|
544
|
+
# @return [Boolean]
|
545
|
+
#
|
249
546
|
# @!attribute [rw] supported_field_type_details
|
250
547
|
# Contains details regarding the supported `FieldType`, including the
|
251
548
|
# corresponding `filterOperators` and `supportedValues`.
|
@@ -265,15 +562,25 @@ module Aws::Appflow
|
|
265
562
|
# as a destination.
|
266
563
|
# @return [Types::DestinationFieldProperties]
|
267
564
|
#
|
565
|
+
# @!attribute [rw] custom_properties
|
566
|
+
# A map that has specific properties related to the
|
567
|
+
# ConnectorEntityField.
|
568
|
+
# @return [Hash<String,String>]
|
569
|
+
#
|
268
570
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorEntityField AWS API Documentation
|
269
571
|
#
|
270
572
|
class ConnectorEntityField < Struct.new(
|
271
573
|
:identifier,
|
574
|
+
:parent_identifier,
|
272
575
|
:label,
|
576
|
+
:is_primary_key,
|
577
|
+
:default_value,
|
578
|
+
:is_deprecated,
|
273
579
|
:supported_field_type_details,
|
274
580
|
:description,
|
275
581
|
:source_properties,
|
276
|
-
:destination_properties
|
582
|
+
:destination_properties,
|
583
|
+
:custom_properties)
|
277
584
|
SENSITIVE = []
|
278
585
|
include Aws::Structure
|
279
586
|
end
|
@@ -444,6 +751,7 @@ module Aws::Appflow
|
|
444
751
|
# veeva: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
445
752
|
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
446
753
|
# sapo_data: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
754
|
+
# custom_connector: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
447
755
|
# }
|
448
756
|
#
|
449
757
|
# @!attribute [rw] amplitude
|
@@ -516,6 +824,10 @@ module Aws::Appflow
|
|
516
824
|
# fields.
|
517
825
|
# @return [String]
|
518
826
|
#
|
827
|
+
# @!attribute [rw] custom_connector
|
828
|
+
# Operators supported by the custom connector.
|
829
|
+
# @return [String]
|
830
|
+
#
|
519
831
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorOperator AWS API Documentation
|
520
832
|
#
|
521
833
|
class ConnectorOperator < Struct.new(
|
@@ -533,7 +845,8 @@ module Aws::Appflow
|
|
533
845
|
:trendmicro,
|
534
846
|
:veeva,
|
535
847
|
:zendesk,
|
536
|
-
:sapo_data
|
848
|
+
:sapo_data,
|
849
|
+
:custom_connector)
|
537
850
|
SENSITIVE = []
|
538
851
|
include Aws::Structure
|
539
852
|
end
|
@@ -558,6 +871,10 @@ module Aws::Appflow
|
|
558
871
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
559
872
|
# @return [String]
|
560
873
|
#
|
874
|
+
# @!attribute [rw] connector_label
|
875
|
+
# The label for the connector profile being created.
|
876
|
+
# @return [String]
|
877
|
+
#
|
561
878
|
# @!attribute [rw] connection_mode
|
562
879
|
# Indicates the connection mode and if it is public or private.
|
563
880
|
# @return [String]
|
@@ -588,6 +905,7 @@ module Aws::Appflow
|
|
588
905
|
:connector_profile_arn,
|
589
906
|
:connector_profile_name,
|
590
907
|
:connector_type,
|
908
|
+
:connector_label,
|
591
909
|
:connection_mode,
|
592
910
|
:credentials_arn,
|
593
911
|
:connector_profile_properties,
|
@@ -672,6 +990,15 @@ module Aws::Appflow
|
|
672
990
|
# o_auth_scopes: ["OAuthScope"], # required
|
673
991
|
# },
|
674
992
|
# },
|
993
|
+
# custom_connector: {
|
994
|
+
# profile_properties: {
|
995
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
996
|
+
# },
|
997
|
+
# o_auth_2_properties: {
|
998
|
+
# token_url: "TokenUrl", # required
|
999
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
1000
|
+
# },
|
1001
|
+
# },
|
675
1002
|
# },
|
676
1003
|
# connector_profile_credentials: { # required
|
677
1004
|
# amplitude: {
|
@@ -783,6 +1110,33 @@ module Aws::Appflow
|
|
783
1110
|
# },
|
784
1111
|
# },
|
785
1112
|
# },
|
1113
|
+
# custom_connector: {
|
1114
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
1115
|
+
# basic: {
|
1116
|
+
# username: "Username", # required
|
1117
|
+
# password: "Password", # required
|
1118
|
+
# },
|
1119
|
+
# oauth2: {
|
1120
|
+
# client_id: "ClientId",
|
1121
|
+
# client_secret: "ClientSecret",
|
1122
|
+
# access_token: "AccessToken",
|
1123
|
+
# refresh_token: "RefreshToken",
|
1124
|
+
# o_auth_request: {
|
1125
|
+
# auth_code: "AuthCode",
|
1126
|
+
# redirect_uri: "RedirectUri",
|
1127
|
+
# },
|
1128
|
+
# },
|
1129
|
+
# api_key: {
|
1130
|
+
# api_key: "ApiKey", # required
|
1131
|
+
# api_secret_key: "ApiSecretKey",
|
1132
|
+
# },
|
1133
|
+
# custom: {
|
1134
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
1135
|
+
# credentials_map: {
|
1136
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
1137
|
+
# },
|
1138
|
+
# },
|
1139
|
+
# },
|
786
1140
|
# },
|
787
1141
|
# }
|
788
1142
|
#
|
@@ -918,6 +1272,33 @@ module Aws::Appflow
|
|
918
1272
|
# },
|
919
1273
|
# },
|
920
1274
|
# },
|
1275
|
+
# custom_connector: {
|
1276
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
1277
|
+
# basic: {
|
1278
|
+
# username: "Username", # required
|
1279
|
+
# password: "Password", # required
|
1280
|
+
# },
|
1281
|
+
# oauth2: {
|
1282
|
+
# client_id: "ClientId",
|
1283
|
+
# client_secret: "ClientSecret",
|
1284
|
+
# access_token: "AccessToken",
|
1285
|
+
# refresh_token: "RefreshToken",
|
1286
|
+
# o_auth_request: {
|
1287
|
+
# auth_code: "AuthCode",
|
1288
|
+
# redirect_uri: "RedirectUri",
|
1289
|
+
# },
|
1290
|
+
# },
|
1291
|
+
# api_key: {
|
1292
|
+
# api_key: "ApiKey", # required
|
1293
|
+
# api_secret_key: "ApiSecretKey",
|
1294
|
+
# },
|
1295
|
+
# custom: {
|
1296
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
1297
|
+
# credentials_map: {
|
1298
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
1299
|
+
# },
|
1300
|
+
# },
|
1301
|
+
# },
|
921
1302
|
# }
|
922
1303
|
#
|
923
1304
|
# @!attribute [rw] amplitude
|
@@ -992,6 +1373,11 @@ module Aws::Appflow
|
|
992
1373
|
# SAPOData.
|
993
1374
|
# @return [Types::SAPODataConnectorProfileCredentials]
|
994
1375
|
#
|
1376
|
+
# @!attribute [rw] custom_connector
|
1377
|
+
# The connector-specific profile credentials that are required when
|
1378
|
+
# using the custom connector.
|
1379
|
+
# @return [Types::CustomConnectorProfileCredentials]
|
1380
|
+
#
|
995
1381
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorProfileCredentials AWS API Documentation
|
996
1382
|
#
|
997
1383
|
class ConnectorProfileCredentials < Struct.new(
|
@@ -1011,7 +1397,8 @@ module Aws::Appflow
|
|
1011
1397
|
:trendmicro,
|
1012
1398
|
:veeva,
|
1013
1399
|
:zendesk,
|
1014
|
-
:sapo_data
|
1400
|
+
:sapo_data,
|
1401
|
+
:custom_connector)
|
1015
1402
|
SENSITIVE = []
|
1016
1403
|
include Aws::Structure
|
1017
1404
|
end
|
@@ -1088,6 +1475,15 @@ module Aws::Appflow
|
|
1088
1475
|
# o_auth_scopes: ["OAuthScope"], # required
|
1089
1476
|
# },
|
1090
1477
|
# },
|
1478
|
+
# custom_connector: {
|
1479
|
+
# profile_properties: {
|
1480
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
1481
|
+
# },
|
1482
|
+
# o_auth_2_properties: {
|
1483
|
+
# token_url: "TokenUrl", # required
|
1484
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
1485
|
+
# },
|
1486
|
+
# },
|
1091
1487
|
# }
|
1092
1488
|
#
|
1093
1489
|
# @!attribute [rw] amplitude
|
@@ -1159,6 +1555,10 @@ module Aws::Appflow
|
|
1159
1555
|
# SAPOData.
|
1160
1556
|
# @return [Types::SAPODataConnectorProfileProperties]
|
1161
1557
|
#
|
1558
|
+
# @!attribute [rw] custom_connector
|
1559
|
+
# The properties required by the custom connector.
|
1560
|
+
# @return [Types::CustomConnectorProfileProperties]
|
1561
|
+
#
|
1162
1562
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorProfileProperties AWS API Documentation
|
1163
1563
|
#
|
1164
1564
|
class ConnectorProfileProperties < Struct.new(
|
@@ -1178,7 +1578,79 @@ module Aws::Appflow
|
|
1178
1578
|
:trendmicro,
|
1179
1579
|
:veeva,
|
1180
1580
|
:zendesk,
|
1181
|
-
:sapo_data
|
1581
|
+
:sapo_data,
|
1582
|
+
:custom_connector)
|
1583
|
+
SENSITIVE = []
|
1584
|
+
include Aws::Structure
|
1585
|
+
end
|
1586
|
+
|
1587
|
+
# Contains information about the configuration of the connector being
|
1588
|
+
# registered.
|
1589
|
+
#
|
1590
|
+
# @note When making an API call, you may pass ConnectorProvisioningConfig
|
1591
|
+
# data as a hash:
|
1592
|
+
#
|
1593
|
+
# {
|
1594
|
+
# lambda: {
|
1595
|
+
# lambda_arn: "ARN", # required
|
1596
|
+
# },
|
1597
|
+
# }
|
1598
|
+
#
|
1599
|
+
# @!attribute [rw] lambda
|
1600
|
+
# Contains information about the configuration of the lambda which is
|
1601
|
+
# being registered as the connector.
|
1602
|
+
# @return [Types::LambdaConnectorProvisioningConfig]
|
1603
|
+
#
|
1604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorProvisioningConfig AWS API Documentation
|
1605
|
+
#
|
1606
|
+
class ConnectorProvisioningConfig < Struct.new(
|
1607
|
+
:lambda)
|
1608
|
+
SENSITIVE = []
|
1609
|
+
include Aws::Structure
|
1610
|
+
end
|
1611
|
+
|
1612
|
+
# Contains information about the connector runtime settings that are
|
1613
|
+
# required for flow execution.
|
1614
|
+
#
|
1615
|
+
# @!attribute [rw] key
|
1616
|
+
# Contains value information about the connector runtime setting.
|
1617
|
+
# @return [String]
|
1618
|
+
#
|
1619
|
+
# @!attribute [rw] data_type
|
1620
|
+
# Data type of the connector runtime setting.
|
1621
|
+
# @return [String]
|
1622
|
+
#
|
1623
|
+
# @!attribute [rw] is_required
|
1624
|
+
# Indicates whether this connector runtime setting is required.
|
1625
|
+
# @return [Boolean]
|
1626
|
+
#
|
1627
|
+
# @!attribute [rw] label
|
1628
|
+
# A label used for connector runtime setting.
|
1629
|
+
# @return [String]
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] description
|
1632
|
+
# A description about the connector runtime setting.
|
1633
|
+
# @return [String]
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] scope
|
1636
|
+
# Indicates the scope of the connector runtime setting.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] connector_supplied_value_options
|
1640
|
+
# Contains default values for the connector runtime setting that are
|
1641
|
+
# supplied by the connector.
|
1642
|
+
# @return [Array<String>]
|
1643
|
+
#
|
1644
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ConnectorRuntimeSetting AWS API Documentation
|
1645
|
+
#
|
1646
|
+
class ConnectorRuntimeSetting < Struct.new(
|
1647
|
+
:key,
|
1648
|
+
:data_type,
|
1649
|
+
:is_required,
|
1650
|
+
:label,
|
1651
|
+
:description,
|
1652
|
+
:scope,
|
1653
|
+
:connector_supplied_value_options)
|
1182
1654
|
SENSITIVE = []
|
1183
1655
|
include Aws::Structure
|
1184
1656
|
end
|
@@ -1202,7 +1674,8 @@ module Aws::Appflow
|
|
1202
1674
|
# {
|
1203
1675
|
# connector_profile_name: "ConnectorProfileName", # required
|
1204
1676
|
# kms_arn: "KMSArn",
|
1205
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
1677
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
1678
|
+
# connector_label: "ConnectorLabel",
|
1206
1679
|
# connection_mode: "Public", # required, accepts Public, Private
|
1207
1680
|
# connector_profile_config: { # required
|
1208
1681
|
# connector_profile_properties: { # required
|
@@ -1272,6 +1745,15 @@ module Aws::Appflow
|
|
1272
1745
|
# o_auth_scopes: ["OAuthScope"], # required
|
1273
1746
|
# },
|
1274
1747
|
# },
|
1748
|
+
# custom_connector: {
|
1749
|
+
# profile_properties: {
|
1750
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
1751
|
+
# },
|
1752
|
+
# o_auth_2_properties: {
|
1753
|
+
# token_url: "TokenUrl", # required
|
1754
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
1755
|
+
# },
|
1756
|
+
# },
|
1275
1757
|
# },
|
1276
1758
|
# connector_profile_credentials: { # required
|
1277
1759
|
# amplitude: {
|
@@ -1383,6 +1865,33 @@ module Aws::Appflow
|
|
1383
1865
|
# },
|
1384
1866
|
# },
|
1385
1867
|
# },
|
1868
|
+
# custom_connector: {
|
1869
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
1870
|
+
# basic: {
|
1871
|
+
# username: "Username", # required
|
1872
|
+
# password: "Password", # required
|
1873
|
+
# },
|
1874
|
+
# oauth2: {
|
1875
|
+
# client_id: "ClientId",
|
1876
|
+
# client_secret: "ClientSecret",
|
1877
|
+
# access_token: "AccessToken",
|
1878
|
+
# refresh_token: "RefreshToken",
|
1879
|
+
# o_auth_request: {
|
1880
|
+
# auth_code: "AuthCode",
|
1881
|
+
# redirect_uri: "RedirectUri",
|
1882
|
+
# },
|
1883
|
+
# },
|
1884
|
+
# api_key: {
|
1885
|
+
# api_key: "ApiKey", # required
|
1886
|
+
# api_secret_key: "ApiSecretKey",
|
1887
|
+
# },
|
1888
|
+
# custom: {
|
1889
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
1890
|
+
# credentials_map: {
|
1891
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
1892
|
+
# },
|
1893
|
+
# },
|
1894
|
+
# },
|
1386
1895
|
# },
|
1387
1896
|
# },
|
1388
1897
|
# }
|
@@ -1404,6 +1913,12 @@ module Aws::Appflow
|
|
1404
1913
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
1405
1914
|
# @return [String]
|
1406
1915
|
#
|
1916
|
+
# @!attribute [rw] connector_label
|
1917
|
+
# The label of the connector. The label is unique for each
|
1918
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
1919
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
1920
|
+
# @return [String]
|
1921
|
+
#
|
1407
1922
|
# @!attribute [rw] connection_mode
|
1408
1923
|
# Indicates the connection mode and specifies whether it is public or
|
1409
1924
|
# private. Private flows use Amazon Web Services PrivateLink to route
|
@@ -1421,6 +1936,7 @@ module Aws::Appflow
|
|
1421
1936
|
:connector_profile_name,
|
1422
1937
|
:kms_arn,
|
1423
1938
|
:connector_type,
|
1939
|
+
:connector_label,
|
1424
1940
|
:connection_mode,
|
1425
1941
|
:connector_profile_config)
|
1426
1942
|
SENSITIVE = []
|
@@ -1461,7 +1977,8 @@ module Aws::Appflow
|
|
1461
1977
|
# },
|
1462
1978
|
# },
|
1463
1979
|
# source_flow_config: { # required
|
1464
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
1980
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
1981
|
+
# api_version: "ApiVersion",
|
1465
1982
|
# connector_profile_name: "ConnectorProfileName",
|
1466
1983
|
# source_connector_properties: { # required
|
1467
1984
|
# amplitude: {
|
@@ -1519,6 +2036,12 @@ module Aws::Appflow
|
|
1519
2036
|
# sapo_data: {
|
1520
2037
|
# object_path: "Object",
|
1521
2038
|
# },
|
2039
|
+
# custom_connector: {
|
2040
|
+
# entity_name: "EntityName", # required
|
2041
|
+
# custom_properties: {
|
2042
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
2043
|
+
# },
|
2044
|
+
# },
|
1522
2045
|
# },
|
1523
2046
|
# incremental_pull_config: {
|
1524
2047
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
@@ -1526,7 +2049,8 @@ module Aws::Appflow
|
|
1526
2049
|
# },
|
1527
2050
|
# destination_flow_config_list: [ # required
|
1528
2051
|
# {
|
1529
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
2052
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
2053
|
+
# api_version: "ApiVersion",
|
1530
2054
|
# connector_profile_name: "ConnectorProfileName",
|
1531
2055
|
# destination_connector_properties: { # required
|
1532
2056
|
# redshift: {
|
@@ -1561,7 +2085,7 @@ module Aws::Appflow
|
|
1561
2085
|
# bucket_prefix: "BucketPrefix",
|
1562
2086
|
# bucket_name: "BucketName",
|
1563
2087
|
# },
|
1564
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
2088
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
1565
2089
|
# },
|
1566
2090
|
# snowflake: {
|
1567
2091
|
# object: "Object", # required
|
@@ -1617,7 +2141,20 @@ module Aws::Appflow
|
|
1617
2141
|
# bucket_prefix: "BucketPrefix",
|
1618
2142
|
# bucket_name: "BucketName",
|
1619
2143
|
# },
|
1620
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
2144
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
2145
|
+
# },
|
2146
|
+
# custom_connector: {
|
2147
|
+
# entity_name: "EntityName", # required
|
2148
|
+
# error_handling_config: {
|
2149
|
+
# fail_on_first_destination_error: false,
|
2150
|
+
# bucket_prefix: "BucketPrefix",
|
2151
|
+
# bucket_name: "BucketName",
|
2152
|
+
# },
|
2153
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
2154
|
+
# id_field_names: ["Name"],
|
2155
|
+
# custom_properties: {
|
2156
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
2157
|
+
# },
|
1621
2158
|
# },
|
1622
2159
|
# },
|
1623
2160
|
# },
|
@@ -1641,6 +2178,7 @@ module Aws::Appflow
|
|
1641
2178
|
# veeva: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1642
2179
|
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1643
2180
|
# sapo_data: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
2181
|
+
# custom_connector: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
1644
2182
|
# },
|
1645
2183
|
# destination_field: "DestinationField",
|
1646
2184
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
@@ -1726,6 +2264,247 @@ module Aws::Appflow
|
|
1726
2264
|
include Aws::Structure
|
1727
2265
|
end
|
1728
2266
|
|
2267
|
+
# Configuration information required for custom authentication.
|
2268
|
+
#
|
2269
|
+
# @!attribute [rw] custom_authentication_type
|
2270
|
+
# The authentication type that the custom connector uses.
|
2271
|
+
# @return [String]
|
2272
|
+
#
|
2273
|
+
# @!attribute [rw] auth_parameters
|
2274
|
+
# Information about authentication parameters required for
|
2275
|
+
# authentication.
|
2276
|
+
# @return [Array<Types::AuthParameter>]
|
2277
|
+
#
|
2278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomAuthConfig AWS API Documentation
|
2279
|
+
#
|
2280
|
+
class CustomAuthConfig < Struct.new(
|
2281
|
+
:custom_authentication_type,
|
2282
|
+
:auth_parameters)
|
2283
|
+
SENSITIVE = []
|
2284
|
+
include Aws::Structure
|
2285
|
+
end
|
2286
|
+
|
2287
|
+
# The custom credentials required for custom authentication.
|
2288
|
+
#
|
2289
|
+
# @note When making an API call, you may pass CustomAuthCredentials
|
2290
|
+
# data as a hash:
|
2291
|
+
#
|
2292
|
+
# {
|
2293
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
2294
|
+
# credentials_map: {
|
2295
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
2296
|
+
# },
|
2297
|
+
# }
|
2298
|
+
#
|
2299
|
+
# @!attribute [rw] custom_authentication_type
|
2300
|
+
# The custom authentication type that the connector uses.
|
2301
|
+
# @return [String]
|
2302
|
+
#
|
2303
|
+
# @!attribute [rw] credentials_map
|
2304
|
+
# A map that holds custom authentication credentials.
|
2305
|
+
# @return [Hash<String,String>]
|
2306
|
+
#
|
2307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomAuthCredentials AWS API Documentation
|
2308
|
+
#
|
2309
|
+
class CustomAuthCredentials < Struct.new(
|
2310
|
+
:custom_authentication_type,
|
2311
|
+
:credentials_map)
|
2312
|
+
SENSITIVE = []
|
2313
|
+
include Aws::Structure
|
2314
|
+
end
|
2315
|
+
|
2316
|
+
# The properties that are applied when the custom connector is being
|
2317
|
+
# used as a destination.
|
2318
|
+
#
|
2319
|
+
# @note When making an API call, you may pass CustomConnectorDestinationProperties
|
2320
|
+
# data as a hash:
|
2321
|
+
#
|
2322
|
+
# {
|
2323
|
+
# entity_name: "EntityName", # required
|
2324
|
+
# error_handling_config: {
|
2325
|
+
# fail_on_first_destination_error: false,
|
2326
|
+
# bucket_prefix: "BucketPrefix",
|
2327
|
+
# bucket_name: "BucketName",
|
2328
|
+
# },
|
2329
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
2330
|
+
# id_field_names: ["Name"],
|
2331
|
+
# custom_properties: {
|
2332
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
2333
|
+
# },
|
2334
|
+
# }
|
2335
|
+
#
|
2336
|
+
# @!attribute [rw] entity_name
|
2337
|
+
# The entity specified in the custom connector as a destination in the
|
2338
|
+
# flow.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] error_handling_config
|
2342
|
+
# The settings that determine how Amazon AppFlow handles an error when
|
2343
|
+
# placing data in the custom connector as destination.
|
2344
|
+
# @return [Types::ErrorHandlingConfig]
|
2345
|
+
#
|
2346
|
+
# @!attribute [rw] write_operation_type
|
2347
|
+
# Specifies the type of write operation to be performed in the custom
|
2348
|
+
# connector when it's used as destination.
|
2349
|
+
# @return [String]
|
2350
|
+
#
|
2351
|
+
# @!attribute [rw] id_field_names
|
2352
|
+
# The name of the field that Amazon AppFlow uses as an ID when
|
2353
|
+
# performing a write operation such as update, delete, or upsert.
|
2354
|
+
# @return [Array<String>]
|
2355
|
+
#
|
2356
|
+
# @!attribute [rw] custom_properties
|
2357
|
+
# The custom properties that are specific to the connector when it's
|
2358
|
+
# used as a destination in the flow.
|
2359
|
+
# @return [Hash<String,String>]
|
2360
|
+
#
|
2361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomConnectorDestinationProperties AWS API Documentation
|
2362
|
+
#
|
2363
|
+
class CustomConnectorDestinationProperties < Struct.new(
|
2364
|
+
:entity_name,
|
2365
|
+
:error_handling_config,
|
2366
|
+
:write_operation_type,
|
2367
|
+
:id_field_names,
|
2368
|
+
:custom_properties)
|
2369
|
+
SENSITIVE = []
|
2370
|
+
include Aws::Structure
|
2371
|
+
end
|
2372
|
+
|
2373
|
+
# The connector-specific profile credentials that are required when
|
2374
|
+
# using the custom connector.
|
2375
|
+
#
|
2376
|
+
# @note When making an API call, you may pass CustomConnectorProfileCredentials
|
2377
|
+
# data as a hash:
|
2378
|
+
#
|
2379
|
+
# {
|
2380
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
2381
|
+
# basic: {
|
2382
|
+
# username: "Username", # required
|
2383
|
+
# password: "Password", # required
|
2384
|
+
# },
|
2385
|
+
# oauth2: {
|
2386
|
+
# client_id: "ClientId",
|
2387
|
+
# client_secret: "ClientSecret",
|
2388
|
+
# access_token: "AccessToken",
|
2389
|
+
# refresh_token: "RefreshToken",
|
2390
|
+
# o_auth_request: {
|
2391
|
+
# auth_code: "AuthCode",
|
2392
|
+
# redirect_uri: "RedirectUri",
|
2393
|
+
# },
|
2394
|
+
# },
|
2395
|
+
# api_key: {
|
2396
|
+
# api_key: "ApiKey", # required
|
2397
|
+
# api_secret_key: "ApiSecretKey",
|
2398
|
+
# },
|
2399
|
+
# custom: {
|
2400
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
2401
|
+
# credentials_map: {
|
2402
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
2403
|
+
# },
|
2404
|
+
# },
|
2405
|
+
# }
|
2406
|
+
#
|
2407
|
+
# @!attribute [rw] authentication_type
|
2408
|
+
# The authentication type that the custom connector uses for
|
2409
|
+
# authenticating while creating a connector profile.
|
2410
|
+
# @return [String]
|
2411
|
+
#
|
2412
|
+
# @!attribute [rw] basic
|
2413
|
+
# The basic credentials that are required for the authentication of
|
2414
|
+
# the user.
|
2415
|
+
# @return [Types::BasicAuthCredentials]
|
2416
|
+
#
|
2417
|
+
# @!attribute [rw] oauth2
|
2418
|
+
# The OAuth 2.0 credentials required for the authentication of the
|
2419
|
+
# user.
|
2420
|
+
# @return [Types::OAuth2Credentials]
|
2421
|
+
#
|
2422
|
+
# @!attribute [rw] api_key
|
2423
|
+
# The API keys required for the authentication of the user.
|
2424
|
+
# @return [Types::ApiKeyCredentials]
|
2425
|
+
#
|
2426
|
+
# @!attribute [rw] custom
|
2427
|
+
# If the connector uses the custom authentication mechanism, this
|
2428
|
+
# holds the required credentials.
|
2429
|
+
# @return [Types::CustomAuthCredentials]
|
2430
|
+
#
|
2431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomConnectorProfileCredentials AWS API Documentation
|
2432
|
+
#
|
2433
|
+
class CustomConnectorProfileCredentials < Struct.new(
|
2434
|
+
:authentication_type,
|
2435
|
+
:basic,
|
2436
|
+
:oauth2,
|
2437
|
+
:api_key,
|
2438
|
+
:custom)
|
2439
|
+
SENSITIVE = []
|
2440
|
+
include Aws::Structure
|
2441
|
+
end
|
2442
|
+
|
2443
|
+
# The profile properties required by the custom connector.
|
2444
|
+
#
|
2445
|
+
# @note When making an API call, you may pass CustomConnectorProfileProperties
|
2446
|
+
# data as a hash:
|
2447
|
+
#
|
2448
|
+
# {
|
2449
|
+
# profile_properties: {
|
2450
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
2451
|
+
# },
|
2452
|
+
# o_auth_2_properties: {
|
2453
|
+
# token_url: "TokenUrl", # required
|
2454
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
2455
|
+
# },
|
2456
|
+
# }
|
2457
|
+
#
|
2458
|
+
# @!attribute [rw] profile_properties
|
2459
|
+
# A map of properties that are required to create a profile for the
|
2460
|
+
# custom connector.
|
2461
|
+
# @return [Hash<String,String>]
|
2462
|
+
#
|
2463
|
+
# @!attribute [rw] o_auth_2_properties
|
2464
|
+
# The OAuth 2.0 properties required for OAuth 2.0 authentication.
|
2465
|
+
# @return [Types::OAuth2Properties]
|
2466
|
+
#
|
2467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomConnectorProfileProperties AWS API Documentation
|
2468
|
+
#
|
2469
|
+
class CustomConnectorProfileProperties < Struct.new(
|
2470
|
+
:profile_properties,
|
2471
|
+
:o_auth_2_properties)
|
2472
|
+
SENSITIVE = []
|
2473
|
+
include Aws::Structure
|
2474
|
+
end
|
2475
|
+
|
2476
|
+
# The properties that are applied when the custom connector is being
|
2477
|
+
# used as a source.
|
2478
|
+
#
|
2479
|
+
# @note When making an API call, you may pass CustomConnectorSourceProperties
|
2480
|
+
# data as a hash:
|
2481
|
+
#
|
2482
|
+
# {
|
2483
|
+
# entity_name: "EntityName", # required
|
2484
|
+
# custom_properties: {
|
2485
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
2486
|
+
# },
|
2487
|
+
# }
|
2488
|
+
#
|
2489
|
+
# @!attribute [rw] entity_name
|
2490
|
+
# The entity specified in the custom connector as a source in the
|
2491
|
+
# flow.
|
2492
|
+
# @return [String]
|
2493
|
+
#
|
2494
|
+
# @!attribute [rw] custom_properties
|
2495
|
+
# Custom properties that are required to use the custom connector as a
|
2496
|
+
# source.
|
2497
|
+
# @return [Hash<String,String>]
|
2498
|
+
#
|
2499
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/CustomConnectorSourceProperties AWS API Documentation
|
2500
|
+
#
|
2501
|
+
class CustomConnectorSourceProperties < Struct.new(
|
2502
|
+
:entity_name,
|
2503
|
+
:custom_properties)
|
2504
|
+
SENSITIVE = []
|
2505
|
+
include Aws::Structure
|
2506
|
+
end
|
2507
|
+
|
1729
2508
|
# The properties that are applied when Amazon Connect Customer Profiles
|
1730
2509
|
# is used as a destination.
|
1731
2510
|
#
|
@@ -1788,7 +2567,7 @@ module Aws::Appflow
|
|
1788
2567
|
class DatadogConnectorProfileCredentials < Struct.new(
|
1789
2568
|
:api_key,
|
1790
2569
|
:application_key)
|
1791
|
-
SENSITIVE = []
|
2570
|
+
SENSITIVE = [:api_key]
|
1792
2571
|
include Aws::Structure
|
1793
2572
|
end
|
1794
2573
|
|
@@ -1907,9 +2686,10 @@ module Aws::Appflow
|
|
1907
2686
|
# data as a hash:
|
1908
2687
|
#
|
1909
2688
|
# {
|
1910
|
-
# connector_entity_name: "
|
1911
|
-
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
2689
|
+
# connector_entity_name: "EntityName", # required
|
2690
|
+
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
1912
2691
|
# connector_profile_name: "ConnectorProfileName",
|
2692
|
+
# api_version: "ApiVersion",
|
1913
2693
|
# }
|
1914
2694
|
#
|
1915
2695
|
# @!attribute [rw] connector_entity_name
|
@@ -1926,12 +2706,17 @@ module Aws::Appflow
|
|
1926
2706
|
# `ConnectorProfile` in the Amazon Web Services account.
|
1927
2707
|
# @return [String]
|
1928
2708
|
#
|
2709
|
+
# @!attribute [rw] api_version
|
2710
|
+
# The version of the API that's used by the connector.
|
2711
|
+
# @return [String]
|
2712
|
+
#
|
1929
2713
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectorEntityRequest AWS API Documentation
|
1930
2714
|
#
|
1931
2715
|
class DescribeConnectorEntityRequest < Struct.new(
|
1932
2716
|
:connector_entity_name,
|
1933
2717
|
:connector_type,
|
1934
|
-
:connector_profile_name
|
2718
|
+
:connector_profile_name,
|
2719
|
+
:api_version)
|
1935
2720
|
SENSITIVE = []
|
1936
2721
|
include Aws::Structure
|
1937
2722
|
end
|
@@ -1955,7 +2740,8 @@ module Aws::Appflow
|
|
1955
2740
|
#
|
1956
2741
|
# {
|
1957
2742
|
# connector_profile_names: ["ConnectorProfileName"],
|
1958
|
-
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
2743
|
+
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
2744
|
+
# connector_label: "ConnectorLabel",
|
1959
2745
|
# max_results: 1,
|
1960
2746
|
# next_token: "NextToken",
|
1961
2747
|
# }
|
@@ -1969,6 +2755,12 @@ module Aws::Appflow
|
|
1969
2755
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
1970
2756
|
# @return [String]
|
1971
2757
|
#
|
2758
|
+
# @!attribute [rw] connector_label
|
2759
|
+
# The name of the connector. The name is unique for each
|
2760
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
2761
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
2762
|
+
# @return [String]
|
2763
|
+
#
|
1972
2764
|
# @!attribute [rw] max_results
|
1973
2765
|
# Specifies the maximum number of items that should be returned in the
|
1974
2766
|
# result set. The default for `maxResults` is 20 (for all paginated
|
@@ -1984,6 +2776,7 @@ module Aws::Appflow
|
|
1984
2776
|
class DescribeConnectorProfilesRequest < Struct.new(
|
1985
2777
|
:connector_profile_names,
|
1986
2778
|
:connector_type,
|
2779
|
+
:connector_label,
|
1987
2780
|
:max_results,
|
1988
2781
|
:next_token)
|
1989
2782
|
SENSITIVE = []
|
@@ -2009,11 +2802,52 @@ module Aws::Appflow
|
|
2009
2802
|
include Aws::Structure
|
2010
2803
|
end
|
2011
2804
|
|
2805
|
+
# @note When making an API call, you may pass DescribeConnectorRequest
|
2806
|
+
# data as a hash:
|
2807
|
+
#
|
2808
|
+
# {
|
2809
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
2810
|
+
# connector_label: "ConnectorLabel",
|
2811
|
+
# }
|
2812
|
+
#
|
2813
|
+
# @!attribute [rw] connector_type
|
2814
|
+
# The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo.
|
2815
|
+
# Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
|
2816
|
+
# @return [String]
|
2817
|
+
#
|
2818
|
+
# @!attribute [rw] connector_label
|
2819
|
+
# The label of the connector. The label is unique for each
|
2820
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
2821
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
2822
|
+
# @return [String]
|
2823
|
+
#
|
2824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectorRequest AWS API Documentation
|
2825
|
+
#
|
2826
|
+
class DescribeConnectorRequest < Struct.new(
|
2827
|
+
:connector_type,
|
2828
|
+
:connector_label)
|
2829
|
+
SENSITIVE = []
|
2830
|
+
include Aws::Structure
|
2831
|
+
end
|
2832
|
+
|
2833
|
+
# @!attribute [rw] connector_configuration
|
2834
|
+
# Configuration info of all the connectors that the user requested.
|
2835
|
+
# @return [Types::ConnectorConfiguration]
|
2836
|
+
#
|
2837
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectorResponse AWS API Documentation
|
2838
|
+
#
|
2839
|
+
class DescribeConnectorResponse < Struct.new(
|
2840
|
+
:connector_configuration)
|
2841
|
+
SENSITIVE = []
|
2842
|
+
include Aws::Structure
|
2843
|
+
end
|
2844
|
+
|
2012
2845
|
# @note When making an API call, you may pass DescribeConnectorsRequest
|
2013
2846
|
# data as a hash:
|
2014
2847
|
#
|
2015
2848
|
# {
|
2016
|
-
# connector_types: ["Salesforce"], # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
2849
|
+
# connector_types: ["Salesforce"], # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
2850
|
+
# max_results: 1,
|
2017
2851
|
# next_token: "NextToken",
|
2018
2852
|
# }
|
2019
2853
|
#
|
@@ -2021,6 +2855,11 @@ module Aws::Appflow
|
|
2021
2855
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
2022
2856
|
# @return [Array<String>]
|
2023
2857
|
#
|
2858
|
+
# @!attribute [rw] max_results
|
2859
|
+
# The maximum number of items that should be returned in the result
|
2860
|
+
# set. The default is 20.
|
2861
|
+
# @return [Integer]
|
2862
|
+
#
|
2024
2863
|
# @!attribute [rw] next_token
|
2025
2864
|
# The pagination token for the next page of data.
|
2026
2865
|
# @return [String]
|
@@ -2029,6 +2868,7 @@ module Aws::Appflow
|
|
2029
2868
|
#
|
2030
2869
|
class DescribeConnectorsRequest < Struct.new(
|
2031
2870
|
:connector_types,
|
2871
|
+
:max_results,
|
2032
2872
|
:next_token)
|
2033
2873
|
SENSITIVE = []
|
2034
2874
|
include Aws::Structure
|
@@ -2039,6 +2879,10 @@ module Aws::Appflow
|
|
2039
2879
|
# flow.
|
2040
2880
|
# @return [Hash<String,Types::ConnectorConfiguration>]
|
2041
2881
|
#
|
2882
|
+
# @!attribute [rw] connectors
|
2883
|
+
# Information about the connectors supported in Amazon AppFlow.
|
2884
|
+
# @return [Array<Types::ConnectorDetail>]
|
2885
|
+
#
|
2042
2886
|
# @!attribute [rw] next_token
|
2043
2887
|
# The pagination token for the next page of data.
|
2044
2888
|
# @return [String]
|
@@ -2047,6 +2891,7 @@ module Aws::Appflow
|
|
2047
2891
|
#
|
2048
2892
|
class DescribeConnectorsResponse < Struct.new(
|
2049
2893
|
:connector_configurations,
|
2894
|
+
:connectors,
|
2050
2895
|
:next_token)
|
2051
2896
|
SENSITIVE = []
|
2052
2897
|
include Aws::Structure
|
@@ -2260,7 +3105,7 @@ module Aws::Appflow
|
|
2260
3105
|
# bucket_prefix: "BucketPrefix",
|
2261
3106
|
# bucket_name: "BucketName",
|
2262
3107
|
# },
|
2263
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
3108
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
2264
3109
|
# },
|
2265
3110
|
# snowflake: {
|
2266
3111
|
# object: "Object", # required
|
@@ -2316,7 +3161,20 @@ module Aws::Appflow
|
|
2316
3161
|
# bucket_prefix: "BucketPrefix",
|
2317
3162
|
# bucket_name: "BucketName",
|
2318
3163
|
# },
|
2319
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
3164
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
3165
|
+
# },
|
3166
|
+
# custom_connector: {
|
3167
|
+
# entity_name: "EntityName", # required
|
3168
|
+
# error_handling_config: {
|
3169
|
+
# fail_on_first_destination_error: false,
|
3170
|
+
# bucket_prefix: "BucketPrefix",
|
3171
|
+
# bucket_name: "BucketName",
|
3172
|
+
# },
|
3173
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
3174
|
+
# id_field_names: ["Name"],
|
3175
|
+
# custom_properties: {
|
3176
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
3177
|
+
# },
|
2320
3178
|
# },
|
2321
3179
|
# }
|
2322
3180
|
#
|
@@ -2360,6 +3218,10 @@ module Aws::Appflow
|
|
2360
3218
|
# The properties required to query Zendesk.
|
2361
3219
|
# @return [Types::ZendeskDestinationProperties]
|
2362
3220
|
#
|
3221
|
+
# @!attribute [rw] custom_connector
|
3222
|
+
# The properties that are required to query the custom Connector.
|
3223
|
+
# @return [Types::CustomConnectorDestinationProperties]
|
3224
|
+
#
|
2363
3225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DestinationConnectorProperties AWS API Documentation
|
2364
3226
|
#
|
2365
3227
|
class DestinationConnectorProperties < Struct.new(
|
@@ -2372,7 +3234,8 @@ module Aws::Appflow
|
|
2372
3234
|
:upsolver,
|
2373
3235
|
:honeycode,
|
2374
3236
|
:customer_profiles,
|
2375
|
-
:zendesk
|
3237
|
+
:zendesk,
|
3238
|
+
:custom_connector)
|
2376
3239
|
SENSITIVE = []
|
2377
3240
|
include Aws::Structure
|
2378
3241
|
end
|
@@ -2400,6 +3263,11 @@ module Aws::Appflow
|
|
2400
3263
|
# `UPSERT` write operation.
|
2401
3264
|
# @return [Boolean]
|
2402
3265
|
#
|
3266
|
+
# @!attribute [rw] is_defaulted_on_create
|
3267
|
+
# Specifies whether the field can use the default value during a
|
3268
|
+
# Create operation.
|
3269
|
+
# @return [Boolean]
|
3270
|
+
#
|
2403
3271
|
# @!attribute [rw] supported_write_operations
|
2404
3272
|
# A list of supported write operations. For each write operation
|
2405
3273
|
# listed, this field can be used in `idFieldNames` when that write
|
@@ -2413,6 +3281,7 @@ module Aws::Appflow
|
|
2413
3281
|
:is_nullable,
|
2414
3282
|
:is_upsertable,
|
2415
3283
|
:is_updatable,
|
3284
|
+
:is_defaulted_on_create,
|
2416
3285
|
:supported_write_operations)
|
2417
3286
|
SENSITIVE = []
|
2418
3287
|
include Aws::Structure
|
@@ -2425,7 +3294,8 @@ module Aws::Appflow
|
|
2425
3294
|
# data as a hash:
|
2426
3295
|
#
|
2427
3296
|
# {
|
2428
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
3297
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
3298
|
+
# api_version: "ApiVersion",
|
2429
3299
|
# connector_profile_name: "ConnectorProfileName",
|
2430
3300
|
# destination_connector_properties: { # required
|
2431
3301
|
# redshift: {
|
@@ -2460,7 +3330,7 @@ module Aws::Appflow
|
|
2460
3330
|
# bucket_prefix: "BucketPrefix",
|
2461
3331
|
# bucket_name: "BucketName",
|
2462
3332
|
# },
|
2463
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
3333
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
2464
3334
|
# },
|
2465
3335
|
# snowflake: {
|
2466
3336
|
# object: "Object", # required
|
@@ -2516,7 +3386,20 @@ module Aws::Appflow
|
|
2516
3386
|
# bucket_prefix: "BucketPrefix",
|
2517
3387
|
# bucket_name: "BucketName",
|
2518
3388
|
# },
|
2519
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
3389
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
3390
|
+
# },
|
3391
|
+
# custom_connector: {
|
3392
|
+
# entity_name: "EntityName", # required
|
3393
|
+
# error_handling_config: {
|
3394
|
+
# fail_on_first_destination_error: false,
|
3395
|
+
# bucket_prefix: "BucketPrefix",
|
3396
|
+
# bucket_name: "BucketName",
|
3397
|
+
# },
|
3398
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
3399
|
+
# id_field_names: ["Name"],
|
3400
|
+
# custom_properties: {
|
3401
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
3402
|
+
# },
|
2520
3403
|
# },
|
2521
3404
|
# },
|
2522
3405
|
# }
|
@@ -2525,6 +3408,10 @@ module Aws::Appflow
|
|
2525
3408
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
2526
3409
|
# @return [String]
|
2527
3410
|
#
|
3411
|
+
# @!attribute [rw] api_version
|
3412
|
+
# The API version that the destination connector uses.
|
3413
|
+
# @return [String]
|
3414
|
+
#
|
2528
3415
|
# @!attribute [rw] connector_profile_name
|
2529
3416
|
# The name of the connector profile. This name must be unique for each
|
2530
3417
|
# connector profile in the Amazon Web Services account.
|
@@ -2539,6 +3426,7 @@ module Aws::Appflow
|
|
2539
3426
|
#
|
2540
3427
|
class DestinationFlowConfig < Struct.new(
|
2541
3428
|
:connector_type,
|
3429
|
+
:api_version,
|
2542
3430
|
:connector_profile_name,
|
2543
3431
|
:destination_connector_properties)
|
2544
3432
|
SENSITIVE = []
|
@@ -2836,12 +3724,32 @@ module Aws::Appflow
|
|
2836
3724
|
# `fieldType` can have two values: "true" and "false".
|
2837
3725
|
# @return [Array<String>]
|
2838
3726
|
#
|
3727
|
+
# @!attribute [rw] value_regex_pattern
|
3728
|
+
# The regular expression pattern for the field name.
|
3729
|
+
# @return [String]
|
3730
|
+
#
|
3731
|
+
# @!attribute [rw] supported_date_format
|
3732
|
+
# The date format that the field supports.
|
3733
|
+
# @return [String]
|
3734
|
+
#
|
3735
|
+
# @!attribute [rw] field_value_range
|
3736
|
+
# The range of values this field can hold.
|
3737
|
+
# @return [Types::Range]
|
3738
|
+
#
|
3739
|
+
# @!attribute [rw] field_length_range
|
3740
|
+
# This is the allowable length range for this field's value.
|
3741
|
+
# @return [Types::Range]
|
3742
|
+
#
|
2839
3743
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/FieldTypeDetails AWS API Documentation
|
2840
3744
|
#
|
2841
3745
|
class FieldTypeDetails < Struct.new(
|
2842
3746
|
:field_type,
|
2843
3747
|
:filter_operators,
|
2844
|
-
:supported_values
|
3748
|
+
:supported_values,
|
3749
|
+
:value_regex_pattern,
|
3750
|
+
:supported_date_format,
|
3751
|
+
:field_value_range,
|
3752
|
+
:field_length_range)
|
2845
3753
|
SENSITIVE = []
|
2846
3754
|
include Aws::Structure
|
2847
3755
|
end
|
@@ -2871,11 +3779,19 @@ module Aws::Appflow
|
|
2871
3779
|
# Amplitude, and so on.
|
2872
3780
|
# @return [String]
|
2873
3781
|
#
|
3782
|
+
# @!attribute [rw] source_connector_label
|
3783
|
+
# The label of the source connector in the flow.
|
3784
|
+
# @return [String]
|
3785
|
+
#
|
2874
3786
|
# @!attribute [rw] destination_connector_type
|
2875
3787
|
# Specifies the destination connector type, such as Salesforce, Amazon
|
2876
3788
|
# S3, Amplitude, and so on.
|
2877
3789
|
# @return [String]
|
2878
3790
|
#
|
3791
|
+
# @!attribute [rw] destination_connector_label
|
3792
|
+
# The label of the destination connector in the flow.
|
3793
|
+
# @return [String]
|
3794
|
+
#
|
2879
3795
|
# @!attribute [rw] trigger_type
|
2880
3796
|
# Specifies the type of flow trigger. This can be `OnDemand`,
|
2881
3797
|
# `Scheduled`, or `Event`.
|
@@ -2913,7 +3829,9 @@ module Aws::Appflow
|
|
2913
3829
|
:flow_name,
|
2914
3830
|
:flow_status,
|
2915
3831
|
:source_connector_type,
|
3832
|
+
:source_connector_label,
|
2916
3833
|
:destination_connector_type,
|
3834
|
+
:destination_connector_label,
|
2917
3835
|
:trigger_type,
|
2918
3836
|
:created_at,
|
2919
3837
|
:last_updated_at,
|
@@ -3246,13 +4164,36 @@ module Aws::Appflow
|
|
3246
4164
|
include Aws::Structure
|
3247
4165
|
end
|
3248
4166
|
|
4167
|
+
# Contains information about the configuration of the lambda which is
|
4168
|
+
# being registered as the connector.
|
4169
|
+
#
|
4170
|
+
# @note When making an API call, you may pass LambdaConnectorProvisioningConfig
|
4171
|
+
# data as a hash:
|
4172
|
+
#
|
4173
|
+
# {
|
4174
|
+
# lambda_arn: "ARN", # required
|
4175
|
+
# }
|
4176
|
+
#
|
4177
|
+
# @!attribute [rw] lambda_arn
|
4178
|
+
# Lambda ARN of the connector being registered.
|
4179
|
+
# @return [String]
|
4180
|
+
#
|
4181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/LambdaConnectorProvisioningConfig AWS API Documentation
|
4182
|
+
#
|
4183
|
+
class LambdaConnectorProvisioningConfig < Struct.new(
|
4184
|
+
:lambda_arn)
|
4185
|
+
SENSITIVE = []
|
4186
|
+
include Aws::Structure
|
4187
|
+
end
|
4188
|
+
|
3249
4189
|
# @note When making an API call, you may pass ListConnectorEntitiesRequest
|
3250
4190
|
# data as a hash:
|
3251
4191
|
#
|
3252
4192
|
# {
|
3253
4193
|
# connector_profile_name: "ConnectorProfileName",
|
3254
|
-
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
4194
|
+
# connector_type: "Salesforce", # accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
3255
4195
|
# entities_path: "EntitiesPath",
|
4196
|
+
# api_version: "ApiVersion",
|
3256
4197
|
# }
|
3257
4198
|
#
|
3258
4199
|
# @!attribute [rw] connector_profile_name
|
@@ -3275,12 +4216,17 @@ module Aws::Appflow
|
|
3275
4216
|
# supported by the provider.
|
3276
4217
|
# @return [String]
|
3277
4218
|
#
|
4219
|
+
# @!attribute [rw] api_version
|
4220
|
+
# The version of the API that's used by the connector.
|
4221
|
+
# @return [String]
|
4222
|
+
#
|
3278
4223
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListConnectorEntitiesRequest AWS API Documentation
|
3279
4224
|
#
|
3280
4225
|
class ListConnectorEntitiesRequest < Struct.new(
|
3281
4226
|
:connector_profile_name,
|
3282
4227
|
:connector_type,
|
3283
|
-
:entities_path
|
4228
|
+
:entities_path,
|
4229
|
+
:api_version)
|
3284
4230
|
SENSITIVE = []
|
3285
4231
|
include Aws::Structure
|
3286
4232
|
end
|
@@ -3299,6 +4245,52 @@ module Aws::Appflow
|
|
3299
4245
|
include Aws::Structure
|
3300
4246
|
end
|
3301
4247
|
|
4248
|
+
# @note When making an API call, you may pass ListConnectorsRequest
|
4249
|
+
# data as a hash:
|
4250
|
+
#
|
4251
|
+
# {
|
4252
|
+
# max_results: 1,
|
4253
|
+
# next_token: "NextToken",
|
4254
|
+
# }
|
4255
|
+
#
|
4256
|
+
# @!attribute [rw] max_results
|
4257
|
+
# Specifies the maximum number of items that should be returned in the
|
4258
|
+
# result set. The default for `maxResults` is 20 (for all paginated
|
4259
|
+
# API operations).
|
4260
|
+
# @return [Integer]
|
4261
|
+
#
|
4262
|
+
# @!attribute [rw] next_token
|
4263
|
+
# The pagination token for the next page of data.
|
4264
|
+
# @return [String]
|
4265
|
+
#
|
4266
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListConnectorsRequest AWS API Documentation
|
4267
|
+
#
|
4268
|
+
class ListConnectorsRequest < Struct.new(
|
4269
|
+
:max_results,
|
4270
|
+
:next_token)
|
4271
|
+
SENSITIVE = []
|
4272
|
+
include Aws::Structure
|
4273
|
+
end
|
4274
|
+
|
4275
|
+
# @!attribute [rw] connectors
|
4276
|
+
# Contains information about the connectors supported by Amazon
|
4277
|
+
# AppFlow.
|
4278
|
+
# @return [Array<Types::ConnectorDetail>]
|
4279
|
+
#
|
4280
|
+
# @!attribute [rw] next_token
|
4281
|
+
# The pagination token for the next page of data. If nextToken=null,
|
4282
|
+
# this means that all records have been fetched.
|
4283
|
+
# @return [String]
|
4284
|
+
#
|
4285
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListConnectorsResponse AWS API Documentation
|
4286
|
+
#
|
4287
|
+
class ListConnectorsResponse < Struct.new(
|
4288
|
+
:connectors,
|
4289
|
+
:next_token)
|
4290
|
+
SENSITIVE = []
|
4291
|
+
include Aws::Structure
|
4292
|
+
end
|
4293
|
+
|
3302
4294
|
# @note When making an API call, you may pass ListFlowsRequest
|
3303
4295
|
# data as a hash:
|
3304
4296
|
#
|
@@ -3475,6 +4467,113 @@ module Aws::Appflow
|
|
3475
4467
|
include Aws::Structure
|
3476
4468
|
end
|
3477
4469
|
|
4470
|
+
# The OAuth 2.0 credentials required for OAuth 2.0 authentication.
|
4471
|
+
#
|
4472
|
+
# @note When making an API call, you may pass OAuth2Credentials
|
4473
|
+
# data as a hash:
|
4474
|
+
#
|
4475
|
+
# {
|
4476
|
+
# client_id: "ClientId",
|
4477
|
+
# client_secret: "ClientSecret",
|
4478
|
+
# access_token: "AccessToken",
|
4479
|
+
# refresh_token: "RefreshToken",
|
4480
|
+
# o_auth_request: {
|
4481
|
+
# auth_code: "AuthCode",
|
4482
|
+
# redirect_uri: "RedirectUri",
|
4483
|
+
# },
|
4484
|
+
# }
|
4485
|
+
#
|
4486
|
+
# @!attribute [rw] client_id
|
4487
|
+
# The identifier for the desired client.
|
4488
|
+
# @return [String]
|
4489
|
+
#
|
4490
|
+
# @!attribute [rw] client_secret
|
4491
|
+
# The client secret used by the OAuth client to authenticate to the
|
4492
|
+
# authorization server.
|
4493
|
+
# @return [String]
|
4494
|
+
#
|
4495
|
+
# @!attribute [rw] access_token
|
4496
|
+
# The access token used to access the connector on your behalf.
|
4497
|
+
# @return [String]
|
4498
|
+
#
|
4499
|
+
# @!attribute [rw] refresh_token
|
4500
|
+
# The refresh token used to refresh an expired access token.
|
4501
|
+
# @return [String]
|
4502
|
+
#
|
4503
|
+
# @!attribute [rw] o_auth_request
|
4504
|
+
# Used by select connectors for which the OAuth workflow is supported,
|
4505
|
+
# such as Salesforce, Google Analytics, Marketo, Zendesk, and Slack.
|
4506
|
+
# @return [Types::ConnectorOAuthRequest]
|
4507
|
+
#
|
4508
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/OAuth2Credentials AWS API Documentation
|
4509
|
+
#
|
4510
|
+
class OAuth2Credentials < Struct.new(
|
4511
|
+
:client_id,
|
4512
|
+
:client_secret,
|
4513
|
+
:access_token,
|
4514
|
+
:refresh_token,
|
4515
|
+
:o_auth_request)
|
4516
|
+
SENSITIVE = [:client_secret, :access_token]
|
4517
|
+
include Aws::Structure
|
4518
|
+
end
|
4519
|
+
|
4520
|
+
# Contains the default values required for OAuth 2.0 authentication.
|
4521
|
+
#
|
4522
|
+
# @!attribute [rw] oauth_scopes
|
4523
|
+
# OAuth 2.0 scopes that the connector supports.
|
4524
|
+
# @return [Array<String>]
|
4525
|
+
#
|
4526
|
+
# @!attribute [rw] token_urls
|
4527
|
+
# Token URLs that can be used for OAuth 2.0 authentication.
|
4528
|
+
# @return [Array<String>]
|
4529
|
+
#
|
4530
|
+
# @!attribute [rw] auth_code_urls
|
4531
|
+
# Auth code URLs that can be used for OAuth 2.0 authentication.
|
4532
|
+
# @return [Array<String>]
|
4533
|
+
#
|
4534
|
+
# @!attribute [rw] oauth2_grant_types_supported
|
4535
|
+
# OAuth 2.0 grant types supported by the connector.
|
4536
|
+
# @return [Array<String>]
|
4537
|
+
#
|
4538
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/OAuth2Defaults AWS API Documentation
|
4539
|
+
#
|
4540
|
+
class OAuth2Defaults < Struct.new(
|
4541
|
+
:oauth_scopes,
|
4542
|
+
:token_urls,
|
4543
|
+
:auth_code_urls,
|
4544
|
+
:oauth2_grant_types_supported)
|
4545
|
+
SENSITIVE = []
|
4546
|
+
include Aws::Structure
|
4547
|
+
end
|
4548
|
+
|
4549
|
+
# The OAuth 2.0 properties required for OAuth 2.0 authentication.
|
4550
|
+
#
|
4551
|
+
# @note When making an API call, you may pass OAuth2Properties
|
4552
|
+
# data as a hash:
|
4553
|
+
#
|
4554
|
+
# {
|
4555
|
+
# token_url: "TokenUrl", # required
|
4556
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
4557
|
+
# }
|
4558
|
+
#
|
4559
|
+
# @!attribute [rw] token_url
|
4560
|
+
# The token URL required for OAuth 2.0 authentication.
|
4561
|
+
# @return [String]
|
4562
|
+
#
|
4563
|
+
# @!attribute [rw] o_auth_2_grant_type
|
4564
|
+
# The OAuth 2.0 grant type used by connector for OAuth 2.0
|
4565
|
+
# authentication.
|
4566
|
+
# @return [String]
|
4567
|
+
#
|
4568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/OAuth2Properties AWS API Documentation
|
4569
|
+
#
|
4570
|
+
class OAuth2Properties < Struct.new(
|
4571
|
+
:token_url,
|
4572
|
+
:o_auth_2_grant_type)
|
4573
|
+
SENSITIVE = []
|
4574
|
+
include Aws::Structure
|
4575
|
+
end
|
4576
|
+
|
3478
4577
|
# The OAuth credentials required for OAuth type authentication.
|
3479
4578
|
#
|
3480
4579
|
# @note When making an API call, you may pass OAuthCredentials
|
@@ -3615,6 +4714,25 @@ module Aws::Appflow
|
|
3615
4714
|
include Aws::Structure
|
3616
4715
|
end
|
3617
4716
|
|
4717
|
+
# The range of values that the property supports.
|
4718
|
+
#
|
4719
|
+
# @!attribute [rw] maximum
|
4720
|
+
# Maximum value supported by the field.
|
4721
|
+
# @return [Float]
|
4722
|
+
#
|
4723
|
+
# @!attribute [rw] minimum
|
4724
|
+
# Minimum value supported by the field.
|
4725
|
+
# @return [Float]
|
4726
|
+
#
|
4727
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/Range AWS API Documentation
|
4728
|
+
#
|
4729
|
+
class Range < Struct.new(
|
4730
|
+
:maximum,
|
4731
|
+
:minimum)
|
4732
|
+
SENSITIVE = []
|
4733
|
+
include Aws::Structure
|
4734
|
+
end
|
4735
|
+
|
3618
4736
|
# The connector-specific profile credentials required when using Amazon
|
3619
4737
|
# Redshift.
|
3620
4738
|
#
|
@@ -3740,6 +4858,62 @@ module Aws::Appflow
|
|
3740
4858
|
#
|
3741
4859
|
class RedshiftMetadata < Aws::EmptyStructure; end
|
3742
4860
|
|
4861
|
+
# @note When making an API call, you may pass RegisterConnectorRequest
|
4862
|
+
# data as a hash:
|
4863
|
+
#
|
4864
|
+
# {
|
4865
|
+
# connector_label: "ConnectorLabel",
|
4866
|
+
# description: "Description",
|
4867
|
+
# connector_provisioning_type: "LAMBDA", # accepts LAMBDA
|
4868
|
+
# connector_provisioning_config: {
|
4869
|
+
# lambda: {
|
4870
|
+
# lambda_arn: "ARN", # required
|
4871
|
+
# },
|
4872
|
+
# },
|
4873
|
+
# }
|
4874
|
+
#
|
4875
|
+
# @!attribute [rw] connector_label
|
4876
|
+
# The name of the connector. The name is unique for each
|
4877
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
4878
|
+
# @return [String]
|
4879
|
+
#
|
4880
|
+
# @!attribute [rw] description
|
4881
|
+
# A description about the connector that's being registered.
|
4882
|
+
# @return [String]
|
4883
|
+
#
|
4884
|
+
# @!attribute [rw] connector_provisioning_type
|
4885
|
+
# The provisioning type of the connector. Currently the only supported
|
4886
|
+
# value is LAMBDA.
|
4887
|
+
# @return [String]
|
4888
|
+
#
|
4889
|
+
# @!attribute [rw] connector_provisioning_config
|
4890
|
+
# The provisioning type of the connector. Currently the only supported
|
4891
|
+
# value is LAMBDA.
|
4892
|
+
# @return [Types::ConnectorProvisioningConfig]
|
4893
|
+
#
|
4894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/RegisterConnectorRequest AWS API Documentation
|
4895
|
+
#
|
4896
|
+
class RegisterConnectorRequest < Struct.new(
|
4897
|
+
:connector_label,
|
4898
|
+
:description,
|
4899
|
+
:connector_provisioning_type,
|
4900
|
+
:connector_provisioning_config)
|
4901
|
+
SENSITIVE = []
|
4902
|
+
include Aws::Structure
|
4903
|
+
end
|
4904
|
+
|
4905
|
+
# @!attribute [rw] connector_arn
|
4906
|
+
# The ARN of the connector being registered.
|
4907
|
+
# @return [String]
|
4908
|
+
#
|
4909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/RegisterConnectorResponse AWS API Documentation
|
4910
|
+
#
|
4911
|
+
class RegisterConnectorResponse < Struct.new(
|
4912
|
+
:connector_arn)
|
4913
|
+
SENSITIVE = []
|
4914
|
+
include Aws::Structure
|
4915
|
+
end
|
4916
|
+
|
3743
4917
|
# The resource specified in the request (such as the source or
|
3744
4918
|
# destination connector profile) is not found.
|
3745
4919
|
#
|
@@ -4128,7 +5302,7 @@ module Aws::Appflow
|
|
4128
5302
|
# bucket_prefix: "BucketPrefix",
|
4129
5303
|
# bucket_name: "BucketName",
|
4130
5304
|
# },
|
4131
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
5305
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
4132
5306
|
# }
|
4133
5307
|
#
|
4134
5308
|
# @!attribute [rw] object
|
@@ -4391,7 +5565,7 @@ module Aws::Appflow
|
|
4391
5565
|
#
|
4392
5566
|
class SingularConnectorProfileCredentials < Struct.new(
|
4393
5567
|
:api_key)
|
4394
|
-
SENSITIVE = []
|
5568
|
+
SENSITIVE = [:api_key]
|
4395
5569
|
include Aws::Structure
|
4396
5570
|
end
|
4397
5571
|
|
@@ -4751,6 +5925,12 @@ module Aws::Appflow
|
|
4751
5925
|
# sapo_data: {
|
4752
5926
|
# object_path: "Object",
|
4753
5927
|
# },
|
5928
|
+
# custom_connector: {
|
5929
|
+
# entity_name: "EntityName", # required
|
5930
|
+
# custom_properties: {
|
5931
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
5932
|
+
# },
|
5933
|
+
# },
|
4754
5934
|
# }
|
4755
5935
|
#
|
4756
5936
|
# @!attribute [rw] amplitude
|
@@ -4815,6 +5995,11 @@ module Aws::Appflow
|
|
4815
5995
|
# source.
|
4816
5996
|
# @return [Types::SAPODataSourceProperties]
|
4817
5997
|
#
|
5998
|
+
# @!attribute [rw] custom_connector
|
5999
|
+
# The properties that are applied when the custom connector is being
|
6000
|
+
# used as a source.
|
6001
|
+
# @return [Types::CustomConnectorSourceProperties]
|
6002
|
+
#
|
4818
6003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/SourceConnectorProperties AWS API Documentation
|
4819
6004
|
#
|
4820
6005
|
class SourceConnectorProperties < Struct.new(
|
@@ -4832,7 +6017,8 @@ module Aws::Appflow
|
|
4832
6017
|
:trendmicro,
|
4833
6018
|
:veeva,
|
4834
6019
|
:zendesk,
|
4835
|
-
:sapo_data
|
6020
|
+
:sapo_data,
|
6021
|
+
:custom_connector)
|
4836
6022
|
SENSITIVE = []
|
4837
6023
|
include Aws::Structure
|
4838
6024
|
end
|
@@ -4848,11 +6034,17 @@ module Aws::Appflow
|
|
4848
6034
|
# Indicates if the field can be queried.
|
4849
6035
|
# @return [Boolean]
|
4850
6036
|
#
|
6037
|
+
# @!attribute [rw] is_timestamp_field_for_incremental_queries
|
6038
|
+
# Indicates if this timestamp field can be used for incremental
|
6039
|
+
# queries.
|
6040
|
+
# @return [Boolean]
|
6041
|
+
#
|
4851
6042
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/SourceFieldProperties AWS API Documentation
|
4852
6043
|
#
|
4853
6044
|
class SourceFieldProperties < Struct.new(
|
4854
6045
|
:is_retrievable,
|
4855
|
-
:is_queryable
|
6046
|
+
:is_queryable,
|
6047
|
+
:is_timestamp_field_for_incremental_queries)
|
4856
6048
|
SENSITIVE = []
|
4857
6049
|
include Aws::Structure
|
4858
6050
|
end
|
@@ -4864,7 +6056,8 @@ module Aws::Appflow
|
|
4864
6056
|
# data as a hash:
|
4865
6057
|
#
|
4866
6058
|
# {
|
4867
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
6059
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
6060
|
+
# api_version: "ApiVersion",
|
4868
6061
|
# connector_profile_name: "ConnectorProfileName",
|
4869
6062
|
# source_connector_properties: { # required
|
4870
6063
|
# amplitude: {
|
@@ -4922,6 +6115,12 @@ module Aws::Appflow
|
|
4922
6115
|
# sapo_data: {
|
4923
6116
|
# object_path: "Object",
|
4924
6117
|
# },
|
6118
|
+
# custom_connector: {
|
6119
|
+
# entity_name: "EntityName", # required
|
6120
|
+
# custom_properties: {
|
6121
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
6122
|
+
# },
|
6123
|
+
# },
|
4925
6124
|
# },
|
4926
6125
|
# incremental_pull_config: {
|
4927
6126
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
@@ -4932,6 +6131,11 @@ module Aws::Appflow
|
|
4932
6131
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
4933
6132
|
# @return [String]
|
4934
6133
|
#
|
6134
|
+
# @!attribute [rw] api_version
|
6135
|
+
# The API version of the connector when it's used as a source in the
|
6136
|
+
# flow.
|
6137
|
+
# @return [String]
|
6138
|
+
#
|
4935
6139
|
# @!attribute [rw] connector_profile_name
|
4936
6140
|
# The name of the connector profile. This name must be unique for each
|
4937
6141
|
# connector profile in the Amazon Web Services account.
|
@@ -4952,6 +6156,7 @@ module Aws::Appflow
|
|
4952
6156
|
#
|
4953
6157
|
class SourceFlowConfig < Struct.new(
|
4954
6158
|
:connector_type,
|
6159
|
+
:api_version,
|
4955
6160
|
:connector_profile_name,
|
4956
6161
|
:source_connector_properties,
|
4957
6162
|
:incremental_pull_config)
|
@@ -5111,6 +6316,7 @@ module Aws::Appflow
|
|
5111
6316
|
# veeva: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5112
6317
|
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5113
6318
|
# sapo_data: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
6319
|
+
# custom_connector: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5114
6320
|
# },
|
5115
6321
|
# destination_field: "DestinationField",
|
5116
6322
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
@@ -5154,6 +6360,20 @@ module Aws::Appflow
|
|
5154
6360
|
include Aws::Structure
|
5155
6361
|
end
|
5156
6362
|
|
6363
|
+
# API calls have exceeded the maximum allowed API request rate per
|
6364
|
+
# account and per Region.
|
6365
|
+
#
|
6366
|
+
# @!attribute [rw] message
|
6367
|
+
# @return [String]
|
6368
|
+
#
|
6369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ThrottlingException AWS API Documentation
|
6370
|
+
#
|
6371
|
+
class ThrottlingException < Struct.new(
|
6372
|
+
:message)
|
6373
|
+
SENSITIVE = []
|
6374
|
+
include Aws::Structure
|
6375
|
+
end
|
6376
|
+
|
5157
6377
|
# The connector-specific profile credentials required when using Trend
|
5158
6378
|
# Micro.
|
5159
6379
|
#
|
@@ -5286,6 +6506,38 @@ module Aws::Appflow
|
|
5286
6506
|
include Aws::Structure
|
5287
6507
|
end
|
5288
6508
|
|
6509
|
+
# @note When making an API call, you may pass UnregisterConnectorRequest
|
6510
|
+
# data as a hash:
|
6511
|
+
#
|
6512
|
+
# {
|
6513
|
+
# connector_label: "ConnectorLabel", # required
|
6514
|
+
# force_delete: false,
|
6515
|
+
# }
|
6516
|
+
#
|
6517
|
+
# @!attribute [rw] connector_label
|
6518
|
+
# The label of the connector. The label is unique for each
|
6519
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
6520
|
+
# @return [String]
|
6521
|
+
#
|
6522
|
+
# @!attribute [rw] force_delete
|
6523
|
+
# Indicates whether Amazon AppFlow should unregister the connector,
|
6524
|
+
# even if it is currently in use in one or more connector profiles.
|
6525
|
+
# The default value is false.
|
6526
|
+
# @return [Boolean]
|
6527
|
+
#
|
6528
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/UnregisterConnectorRequest AWS API Documentation
|
6529
|
+
#
|
6530
|
+
class UnregisterConnectorRequest < Struct.new(
|
6531
|
+
:connector_label,
|
6532
|
+
:force_delete)
|
6533
|
+
SENSITIVE = []
|
6534
|
+
include Aws::Structure
|
6535
|
+
end
|
6536
|
+
|
6537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/UnregisterConnectorResponse AWS API Documentation
|
6538
|
+
#
|
6539
|
+
class UnregisterConnectorResponse < Aws::EmptyStructure; end
|
6540
|
+
|
5289
6541
|
# The requested operation is not supported for the current flow.
|
5290
6542
|
#
|
5291
6543
|
# @!attribute [rw] message
|
@@ -5403,6 +6655,15 @@ module Aws::Appflow
|
|
5403
6655
|
# o_auth_scopes: ["OAuthScope"], # required
|
5404
6656
|
# },
|
5405
6657
|
# },
|
6658
|
+
# custom_connector: {
|
6659
|
+
# profile_properties: {
|
6660
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
6661
|
+
# },
|
6662
|
+
# o_auth_2_properties: {
|
6663
|
+
# token_url: "TokenUrl", # required
|
6664
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
6665
|
+
# },
|
6666
|
+
# },
|
5406
6667
|
# },
|
5407
6668
|
# connector_profile_credentials: { # required
|
5408
6669
|
# amplitude: {
|
@@ -5514,6 +6775,33 @@ module Aws::Appflow
|
|
5514
6775
|
# },
|
5515
6776
|
# },
|
5516
6777
|
# },
|
6778
|
+
# custom_connector: {
|
6779
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
6780
|
+
# basic: {
|
6781
|
+
# username: "Username", # required
|
6782
|
+
# password: "Password", # required
|
6783
|
+
# },
|
6784
|
+
# oauth2: {
|
6785
|
+
# client_id: "ClientId",
|
6786
|
+
# client_secret: "ClientSecret",
|
6787
|
+
# access_token: "AccessToken",
|
6788
|
+
# refresh_token: "RefreshToken",
|
6789
|
+
# o_auth_request: {
|
6790
|
+
# auth_code: "AuthCode",
|
6791
|
+
# redirect_uri: "RedirectUri",
|
6792
|
+
# },
|
6793
|
+
# },
|
6794
|
+
# api_key: {
|
6795
|
+
# api_key: "ApiKey", # required
|
6796
|
+
# api_secret_key: "ApiSecretKey",
|
6797
|
+
# },
|
6798
|
+
# custom: {
|
6799
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
6800
|
+
# credentials_map: {
|
6801
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
6802
|
+
# },
|
6803
|
+
# },
|
6804
|
+
# },
|
5517
6805
|
# },
|
5518
6806
|
# },
|
5519
6807
|
# }
|
@@ -5575,7 +6863,8 @@ module Aws::Appflow
|
|
5575
6863
|
# },
|
5576
6864
|
# },
|
5577
6865
|
# source_flow_config: { # required
|
5578
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
6866
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
6867
|
+
# api_version: "ApiVersion",
|
5579
6868
|
# connector_profile_name: "ConnectorProfileName",
|
5580
6869
|
# source_connector_properties: { # required
|
5581
6870
|
# amplitude: {
|
@@ -5633,6 +6922,12 @@ module Aws::Appflow
|
|
5633
6922
|
# sapo_data: {
|
5634
6923
|
# object_path: "Object",
|
5635
6924
|
# },
|
6925
|
+
# custom_connector: {
|
6926
|
+
# entity_name: "EntityName", # required
|
6927
|
+
# custom_properties: {
|
6928
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
6929
|
+
# },
|
6930
|
+
# },
|
5636
6931
|
# },
|
5637
6932
|
# incremental_pull_config: {
|
5638
6933
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
@@ -5640,7 +6935,8 @@ module Aws::Appflow
|
|
5640
6935
|
# },
|
5641
6936
|
# destination_flow_config_list: [ # required
|
5642
6937
|
# {
|
5643
|
-
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData
|
6938
|
+
# connector_type: "Salesforce", # required, accepts Salesforce, Singular, Slack, Redshift, S3, Marketo, Googleanalytics, Zendesk, Servicenow, Datadog, Trendmicro, Snowflake, Dynatrace, Infornexus, Amplitude, Veeva, EventBridge, LookoutMetrics, Upsolver, Honeycode, CustomerProfiles, SAPOData, CustomConnector
|
6939
|
+
# api_version: "ApiVersion",
|
5644
6940
|
# connector_profile_name: "ConnectorProfileName",
|
5645
6941
|
# destination_connector_properties: { # required
|
5646
6942
|
# redshift: {
|
@@ -5675,7 +6971,7 @@ module Aws::Appflow
|
|
5675
6971
|
# bucket_prefix: "BucketPrefix",
|
5676
6972
|
# bucket_name: "BucketName",
|
5677
6973
|
# },
|
5678
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
6974
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
5679
6975
|
# },
|
5680
6976
|
# snowflake: {
|
5681
6977
|
# object: "Object", # required
|
@@ -5731,7 +7027,20 @@ module Aws::Appflow
|
|
5731
7027
|
# bucket_prefix: "BucketPrefix",
|
5732
7028
|
# bucket_name: "BucketName",
|
5733
7029
|
# },
|
5734
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
7030
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
7031
|
+
# },
|
7032
|
+
# custom_connector: {
|
7033
|
+
# entity_name: "EntityName", # required
|
7034
|
+
# error_handling_config: {
|
7035
|
+
# fail_on_first_destination_error: false,
|
7036
|
+
# bucket_prefix: "BucketPrefix",
|
7037
|
+
# bucket_name: "BucketName",
|
7038
|
+
# },
|
7039
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
7040
|
+
# id_field_names: ["Name"],
|
7041
|
+
# custom_properties: {
|
7042
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
7043
|
+
# },
|
5735
7044
|
# },
|
5736
7045
|
# },
|
5737
7046
|
# },
|
@@ -5755,6 +7064,7 @@ module Aws::Appflow
|
|
5755
7064
|
# veeva: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5756
7065
|
# zendesk: "PROJECTION", # accepts PROJECTION, GREATER_THAN, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5757
7066
|
# sapo_data: "PROJECTION", # accepts PROJECTION, LESS_THAN, CONTAINS, GREATER_THAN, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
7067
|
+
# custom_connector: "PROJECTION", # accepts PROJECTION, LESS_THAN, GREATER_THAN, CONTAINS, BETWEEN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN_OR_EQUAL_TO, EQUAL_TO, NOT_EQUAL_TO, ADDITION, MULTIPLICATION, DIVISION, SUBTRACTION, MASK_ALL, MASK_FIRST_N, MASK_LAST_N, VALIDATE_NON_NULL, VALIDATE_NON_ZERO, VALIDATE_NON_NEGATIVE, VALIDATE_NUMERIC, NO_OP
|
5758
7068
|
# },
|
5759
7069
|
# destination_field: "DestinationField",
|
5760
7070
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
@@ -6107,7 +7417,7 @@ module Aws::Appflow
|
|
6107
7417
|
# bucket_prefix: "BucketPrefix",
|
6108
7418
|
# bucket_name: "BucketName",
|
6109
7419
|
# },
|
6110
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
7420
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
6111
7421
|
# }
|
6112
7422
|
#
|
6113
7423
|
# @!attribute [rw] object
|