aws-sdk-appflow 1.18.0 → 1.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-appflow/client.rb +521 -26
- 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 +4 -4
|
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
32
34
|
|
|
@@ -73,6 +75,8 @@ module Aws::Appflow
|
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
|
78
82
|
|
|
@@ -119,7 +123,9 @@ module Aws::Appflow
|
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
|
122
|
-
# enable retries and extended timeouts.
|
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
|
128
|
+
# to true.
|
|
123
129
|
#
|
|
124
130
|
# @option options [required, String] :region
|
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
|
@@ -173,6 +179,10 @@ module Aws::Appflow
|
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
|
175
181
|
#
|
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
|
185
|
+
#
|
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
|
178
188
|
# to default service endpoint when available.
|
|
@@ -295,7 +305,7 @@ module Aws::Appflow
|
|
|
295
305
|
# seconds to wait when opening a HTTP session before raising a
|
|
296
306
|
# `Timeout::Error`.
|
|
297
307
|
#
|
|
298
|
-
# @option options [
|
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
|
299
309
|
# number of seconds to wait for response data. This value can
|
|
300
310
|
# safely be set per-request on the session.
|
|
301
311
|
#
|
|
@@ -311,6 +321,9 @@ module Aws::Appflow
|
|
|
311
321
|
# disables this behaviour. This value can safely be set per
|
|
312
322
|
# request on the session.
|
|
313
323
|
#
|
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
|
325
|
+
# in seconds.
|
|
326
|
+
#
|
|
314
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
|
315
328
|
# HTTP debug output will be sent to the `:logger`.
|
|
316
329
|
#
|
|
@@ -355,6 +368,11 @@ module Aws::Appflow
|
|
|
355
368
|
# @option params [required, String] :connector_type
|
|
356
369
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
357
370
|
#
|
|
371
|
+
# @option params [String] :connector_label
|
|
372
|
+
# The label of the connector. The label is unique for each
|
|
373
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
374
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
375
|
+
#
|
|
358
376
|
# @option params [required, String] :connection_mode
|
|
359
377
|
# Indicates the connection mode and specifies whether it is public or
|
|
360
378
|
# private. Private flows use Amazon Web Services PrivateLink to route
|
|
@@ -373,7 +391,8 @@ module Aws::Appflow
|
|
|
373
391
|
# resp = client.create_connector_profile({
|
|
374
392
|
# connector_profile_name: "ConnectorProfileName", # required
|
|
375
393
|
# kms_arn: "KMSArn",
|
|
376
|
-
# 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
|
|
394
|
+
# 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
|
|
395
|
+
# connector_label: "ConnectorLabel",
|
|
377
396
|
# connection_mode: "Public", # required, accepts Public, Private
|
|
378
397
|
# connector_profile_config: { # required
|
|
379
398
|
# connector_profile_properties: { # required
|
|
@@ -443,6 +462,15 @@ module Aws::Appflow
|
|
|
443
462
|
# o_auth_scopes: ["OAuthScope"], # required
|
|
444
463
|
# },
|
|
445
464
|
# },
|
|
465
|
+
# custom_connector: {
|
|
466
|
+
# profile_properties: {
|
|
467
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
|
468
|
+
# },
|
|
469
|
+
# o_auth_2_properties: {
|
|
470
|
+
# token_url: "TokenUrl", # required
|
|
471
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
|
472
|
+
# },
|
|
473
|
+
# },
|
|
446
474
|
# },
|
|
447
475
|
# connector_profile_credentials: { # required
|
|
448
476
|
# amplitude: {
|
|
@@ -554,6 +582,33 @@ module Aws::Appflow
|
|
|
554
582
|
# },
|
|
555
583
|
# },
|
|
556
584
|
# },
|
|
585
|
+
# custom_connector: {
|
|
586
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
|
587
|
+
# basic: {
|
|
588
|
+
# username: "Username", # required
|
|
589
|
+
# password: "Password", # required
|
|
590
|
+
# },
|
|
591
|
+
# oauth2: {
|
|
592
|
+
# client_id: "ClientId",
|
|
593
|
+
# client_secret: "ClientSecret",
|
|
594
|
+
# access_token: "AccessToken",
|
|
595
|
+
# refresh_token: "RefreshToken",
|
|
596
|
+
# o_auth_request: {
|
|
597
|
+
# auth_code: "AuthCode",
|
|
598
|
+
# redirect_uri: "RedirectUri",
|
|
599
|
+
# },
|
|
600
|
+
# },
|
|
601
|
+
# api_key: {
|
|
602
|
+
# api_key: "ApiKey", # required
|
|
603
|
+
# api_secret_key: "ApiSecretKey",
|
|
604
|
+
# },
|
|
605
|
+
# custom: {
|
|
606
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
|
607
|
+
# credentials_map: {
|
|
608
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
|
609
|
+
# },
|
|
610
|
+
# },
|
|
611
|
+
# },
|
|
557
612
|
# },
|
|
558
613
|
# },
|
|
559
614
|
# })
|
|
@@ -635,7 +690,8 @@ module Aws::Appflow
|
|
|
635
690
|
# },
|
|
636
691
|
# },
|
|
637
692
|
# source_flow_config: { # required
|
|
638
|
-
# 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
|
|
693
|
+
# 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
|
|
694
|
+
# api_version: "ApiVersion",
|
|
639
695
|
# connector_profile_name: "ConnectorProfileName",
|
|
640
696
|
# source_connector_properties: { # required
|
|
641
697
|
# amplitude: {
|
|
@@ -693,6 +749,12 @@ module Aws::Appflow
|
|
|
693
749
|
# sapo_data: {
|
|
694
750
|
# object_path: "Object",
|
|
695
751
|
# },
|
|
752
|
+
# custom_connector: {
|
|
753
|
+
# entity_name: "EntityName", # required
|
|
754
|
+
# custom_properties: {
|
|
755
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
756
|
+
# },
|
|
757
|
+
# },
|
|
696
758
|
# },
|
|
697
759
|
# incremental_pull_config: {
|
|
698
760
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
|
@@ -700,7 +762,8 @@ module Aws::Appflow
|
|
|
700
762
|
# },
|
|
701
763
|
# destination_flow_config_list: [ # required
|
|
702
764
|
# {
|
|
703
|
-
# 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
|
|
765
|
+
# 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
|
|
766
|
+
# api_version: "ApiVersion",
|
|
704
767
|
# connector_profile_name: "ConnectorProfileName",
|
|
705
768
|
# destination_connector_properties: { # required
|
|
706
769
|
# redshift: {
|
|
@@ -735,7 +798,7 @@ module Aws::Appflow
|
|
|
735
798
|
# bucket_prefix: "BucketPrefix",
|
|
736
799
|
# bucket_name: "BucketName",
|
|
737
800
|
# },
|
|
738
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
801
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
739
802
|
# },
|
|
740
803
|
# snowflake: {
|
|
741
804
|
# object: "Object", # required
|
|
@@ -791,7 +854,20 @@ module Aws::Appflow
|
|
|
791
854
|
# bucket_prefix: "BucketPrefix",
|
|
792
855
|
# bucket_name: "BucketName",
|
|
793
856
|
# },
|
|
794
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
857
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
858
|
+
# },
|
|
859
|
+
# custom_connector: {
|
|
860
|
+
# entity_name: "EntityName", # required
|
|
861
|
+
# error_handling_config: {
|
|
862
|
+
# fail_on_first_destination_error: false,
|
|
863
|
+
# bucket_prefix: "BucketPrefix",
|
|
864
|
+
# bucket_name: "BucketName",
|
|
865
|
+
# },
|
|
866
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
867
|
+
# id_field_names: ["Name"],
|
|
868
|
+
# custom_properties: {
|
|
869
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
870
|
+
# },
|
|
795
871
|
# },
|
|
796
872
|
# },
|
|
797
873
|
# },
|
|
@@ -815,6 +891,7 @@ module Aws::Appflow
|
|
|
815
891
|
# 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
|
|
816
892
|
# 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
|
|
817
893
|
# 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
|
|
894
|
+
# 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
|
|
818
895
|
# },
|
|
819
896
|
# destination_field: "DestinationField",
|
|
820
897
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
|
@@ -900,6 +977,115 @@ module Aws::Appflow
|
|
|
900
977
|
req.send_request(options)
|
|
901
978
|
end
|
|
902
979
|
|
|
980
|
+
# Describes the given custom connector registered in your Amazon Web
|
|
981
|
+
# Services account. This API can be used for custom connectors that are
|
|
982
|
+
# registered in your account and also for Amazon authored connectors.
|
|
983
|
+
#
|
|
984
|
+
# @option params [required, String] :connector_type
|
|
985
|
+
# The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo.
|
|
986
|
+
# Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
|
|
987
|
+
#
|
|
988
|
+
# @option params [String] :connector_label
|
|
989
|
+
# The label of the connector. The label is unique for each
|
|
990
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
991
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
992
|
+
#
|
|
993
|
+
# @return [Types::DescribeConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
994
|
+
#
|
|
995
|
+
# * {Types::DescribeConnectorResponse#connector_configuration #connector_configuration} => Types::ConnectorConfiguration
|
|
996
|
+
#
|
|
997
|
+
# @example Request syntax with placeholder values
|
|
998
|
+
#
|
|
999
|
+
# resp = client.describe_connector({
|
|
1000
|
+
# 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
|
|
1001
|
+
# connector_label: "ConnectorLabel",
|
|
1002
|
+
# })
|
|
1003
|
+
#
|
|
1004
|
+
# @example Response structure
|
|
1005
|
+
#
|
|
1006
|
+
# resp.connector_configuration.can_use_as_source #=> Boolean
|
|
1007
|
+
# resp.connector_configuration.can_use_as_destination #=> Boolean
|
|
1008
|
+
# resp.connector_configuration.supported_destination_connectors #=> Array
|
|
1009
|
+
# resp.connector_configuration.supported_destination_connectors[0] #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1010
|
+
# resp.connector_configuration.supported_scheduling_frequencies #=> Array
|
|
1011
|
+
# resp.connector_configuration.supported_scheduling_frequencies[0] #=> String, one of "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE"
|
|
1012
|
+
# resp.connector_configuration.is_private_link_enabled #=> Boolean
|
|
1013
|
+
# resp.connector_configuration.is_private_link_endpoint_url_required #=> Boolean
|
|
1014
|
+
# resp.connector_configuration.supported_trigger_types #=> Array
|
|
1015
|
+
# resp.connector_configuration.supported_trigger_types[0] #=> String, one of "Scheduled", "Event", "OnDemand"
|
|
1016
|
+
# resp.connector_configuration.connector_metadata.google_analytics.o_auth_scopes #=> Array
|
|
1017
|
+
# resp.connector_configuration.connector_metadata.google_analytics.o_auth_scopes[0] #=> String
|
|
1018
|
+
# resp.connector_configuration.connector_metadata.salesforce.o_auth_scopes #=> Array
|
|
1019
|
+
# resp.connector_configuration.connector_metadata.salesforce.o_auth_scopes[0] #=> String
|
|
1020
|
+
# resp.connector_configuration.connector_metadata.slack.o_auth_scopes #=> Array
|
|
1021
|
+
# resp.connector_configuration.connector_metadata.slack.o_auth_scopes[0] #=> String
|
|
1022
|
+
# resp.connector_configuration.connector_metadata.snowflake.supported_regions #=> Array
|
|
1023
|
+
# resp.connector_configuration.connector_metadata.snowflake.supported_regions[0] #=> String
|
|
1024
|
+
# resp.connector_configuration.connector_metadata.zendesk.o_auth_scopes #=> Array
|
|
1025
|
+
# resp.connector_configuration.connector_metadata.zendesk.o_auth_scopes[0] #=> String
|
|
1026
|
+
# resp.connector_configuration.connector_metadata.honeycode.o_auth_scopes #=> Array
|
|
1027
|
+
# resp.connector_configuration.connector_metadata.honeycode.o_auth_scopes[0] #=> String
|
|
1028
|
+
# resp.connector_configuration.connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1029
|
+
# resp.connector_configuration.connector_label #=> String
|
|
1030
|
+
# resp.connector_configuration.connector_description #=> String
|
|
1031
|
+
# resp.connector_configuration.connector_owner #=> String
|
|
1032
|
+
# resp.connector_configuration.connector_name #=> String
|
|
1033
|
+
# resp.connector_configuration.connector_version #=> String
|
|
1034
|
+
# resp.connector_configuration.connector_arn #=> String
|
|
1035
|
+
# resp.connector_configuration.connector_modes #=> Array
|
|
1036
|
+
# resp.connector_configuration.connector_modes[0] #=> String
|
|
1037
|
+
# resp.connector_configuration.authentication_config.is_basic_auth_supported #=> Boolean
|
|
1038
|
+
# resp.connector_configuration.authentication_config.is_api_key_auth_supported #=> Boolean
|
|
1039
|
+
# resp.connector_configuration.authentication_config.is_o_auth_2_supported #=> Boolean
|
|
1040
|
+
# resp.connector_configuration.authentication_config.is_custom_auth_supported #=> Boolean
|
|
1041
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth_scopes #=> Array
|
|
1042
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth_scopes[0] #=> String
|
|
1043
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.token_urls #=> Array
|
|
1044
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.token_urls[0] #=> String
|
|
1045
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.auth_code_urls #=> Array
|
|
1046
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.auth_code_urls[0] #=> String
|
|
1047
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth2_grant_types_supported #=> Array
|
|
1048
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth2_grant_types_supported[0] #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE"
|
|
1049
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs #=> Array
|
|
1050
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].custom_authentication_type #=> String
|
|
1051
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters #=> Array
|
|
1052
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].key #=> String
|
|
1053
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].is_required #=> Boolean
|
|
1054
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].label #=> String
|
|
1055
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].description #=> String
|
|
1056
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].is_sensitive_field #=> Boolean
|
|
1057
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values #=> Array
|
|
1058
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values[0] #=> String
|
|
1059
|
+
# resp.connector_configuration.connector_runtime_settings #=> Array
|
|
1060
|
+
# resp.connector_configuration.connector_runtime_settings[0].key #=> String
|
|
1061
|
+
# resp.connector_configuration.connector_runtime_settings[0].data_type #=> String
|
|
1062
|
+
# resp.connector_configuration.connector_runtime_settings[0].is_required #=> Boolean
|
|
1063
|
+
# resp.connector_configuration.connector_runtime_settings[0].label #=> String
|
|
1064
|
+
# resp.connector_configuration.connector_runtime_settings[0].description #=> String
|
|
1065
|
+
# resp.connector_configuration.connector_runtime_settings[0].scope #=> String
|
|
1066
|
+
# resp.connector_configuration.connector_runtime_settings[0].connector_supplied_value_options #=> Array
|
|
1067
|
+
# resp.connector_configuration.connector_runtime_settings[0].connector_supplied_value_options[0] #=> String
|
|
1068
|
+
# resp.connector_configuration.supported_api_versions #=> Array
|
|
1069
|
+
# resp.connector_configuration.supported_api_versions[0] #=> String
|
|
1070
|
+
# resp.connector_configuration.supported_operators #=> Array
|
|
1071
|
+
# resp.connector_configuration.supported_operators[0] #=> String, one of "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"
|
|
1072
|
+
# resp.connector_configuration.supported_write_operations #=> Array
|
|
1073
|
+
# resp.connector_configuration.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1074
|
+
# resp.connector_configuration.connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1075
|
+
# resp.connector_configuration.connector_provisioning_config.lambda.lambda_arn #=> String
|
|
1076
|
+
# resp.connector_configuration.logo_url #=> String
|
|
1077
|
+
# resp.connector_configuration.registered_at #=> Time
|
|
1078
|
+
# resp.connector_configuration.registered_by #=> String
|
|
1079
|
+
#
|
|
1080
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnector AWS API Documentation
|
|
1081
|
+
#
|
|
1082
|
+
# @overload describe_connector(params = {})
|
|
1083
|
+
# @param [Hash] params ({})
|
|
1084
|
+
def describe_connector(params = {}, options = {})
|
|
1085
|
+
req = build_request(:describe_connector, params)
|
|
1086
|
+
req.send_request(options)
|
|
1087
|
+
end
|
|
1088
|
+
|
|
903
1089
|
# Provides details regarding the entity used with the connector, with a
|
|
904
1090
|
# description of the data model for each entity.
|
|
905
1091
|
#
|
|
@@ -914,6 +1100,9 @@ module Aws::Appflow
|
|
|
914
1100
|
# The name of the connector profile. The name is unique for each
|
|
915
1101
|
# `ConnectorProfile` in the Amazon Web Services account.
|
|
916
1102
|
#
|
|
1103
|
+
# @option params [String] :api_version
|
|
1104
|
+
# The version of the API that's used by the connector.
|
|
1105
|
+
#
|
|
917
1106
|
# @return [Types::DescribeConnectorEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
918
1107
|
#
|
|
919
1108
|
# * {Types::DescribeConnectorEntityResponse#connector_entity_fields #connector_entity_fields} => Array<Types::ConnectorEntityField>
|
|
@@ -921,30 +1110,45 @@ module Aws::Appflow
|
|
|
921
1110
|
# @example Request syntax with placeholder values
|
|
922
1111
|
#
|
|
923
1112
|
# resp = client.describe_connector_entity({
|
|
924
|
-
# connector_entity_name: "
|
|
925
|
-
# 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
|
|
1113
|
+
# connector_entity_name: "EntityName", # required
|
|
1114
|
+
# 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
|
|
926
1115
|
# connector_profile_name: "ConnectorProfileName",
|
|
1116
|
+
# api_version: "ApiVersion",
|
|
927
1117
|
# })
|
|
928
1118
|
#
|
|
929
1119
|
# @example Response structure
|
|
930
1120
|
#
|
|
931
1121
|
# resp.connector_entity_fields #=> Array
|
|
932
1122
|
# resp.connector_entity_fields[0].identifier #=> String
|
|
1123
|
+
# resp.connector_entity_fields[0].parent_identifier #=> String
|
|
933
1124
|
# resp.connector_entity_fields[0].label #=> String
|
|
1125
|
+
# resp.connector_entity_fields[0].is_primary_key #=> Boolean
|
|
1126
|
+
# resp.connector_entity_fields[0].default_value #=> String
|
|
1127
|
+
# resp.connector_entity_fields[0].is_deprecated #=> Boolean
|
|
934
1128
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_type #=> String
|
|
935
1129
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.filter_operators #=> Array
|
|
936
1130
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.filter_operators[0] #=> String, one of "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"
|
|
937
1131
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_values #=> Array
|
|
938
1132
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_values[0] #=> String
|
|
1133
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.value_regex_pattern #=> String
|
|
1134
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_date_format #=> String
|
|
1135
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_value_range.maximum #=> Float
|
|
1136
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_value_range.minimum #=> Float
|
|
1137
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_length_range.maximum #=> Float
|
|
1138
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_length_range.minimum #=> Float
|
|
939
1139
|
# resp.connector_entity_fields[0].description #=> String
|
|
940
1140
|
# resp.connector_entity_fields[0].source_properties.is_retrievable #=> Boolean
|
|
941
1141
|
# resp.connector_entity_fields[0].source_properties.is_queryable #=> Boolean
|
|
1142
|
+
# resp.connector_entity_fields[0].source_properties.is_timestamp_field_for_incremental_queries #=> Boolean
|
|
942
1143
|
# resp.connector_entity_fields[0].destination_properties.is_creatable #=> Boolean
|
|
943
1144
|
# resp.connector_entity_fields[0].destination_properties.is_nullable #=> Boolean
|
|
944
1145
|
# resp.connector_entity_fields[0].destination_properties.is_upsertable #=> Boolean
|
|
945
1146
|
# resp.connector_entity_fields[0].destination_properties.is_updatable #=> Boolean
|
|
1147
|
+
# resp.connector_entity_fields[0].destination_properties.is_defaulted_on_create #=> Boolean
|
|
946
1148
|
# resp.connector_entity_fields[0].destination_properties.supported_write_operations #=> Array
|
|
947
|
-
# resp.connector_entity_fields[0].destination_properties.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1149
|
+
# resp.connector_entity_fields[0].destination_properties.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1150
|
+
# resp.connector_entity_fields[0].custom_properties #=> Hash
|
|
1151
|
+
# resp.connector_entity_fields[0].custom_properties["CustomPropertyKey"] #=> String
|
|
948
1152
|
#
|
|
949
1153
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectorEntity AWS API Documentation
|
|
950
1154
|
#
|
|
@@ -970,6 +1174,11 @@ module Aws::Appflow
|
|
|
970
1174
|
# @option params [String] :connector_type
|
|
971
1175
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
972
1176
|
#
|
|
1177
|
+
# @option params [String] :connector_label
|
|
1178
|
+
# The name of the connector. The name is unique for each
|
|
1179
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
1180
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
1181
|
+
#
|
|
973
1182
|
# @option params [Integer] :max_results
|
|
974
1183
|
# Specifies the maximum number of items that should be returned in the
|
|
975
1184
|
# result set. The default for `maxResults` is 20 (for all paginated API
|
|
@@ -989,7 +1198,8 @@ module Aws::Appflow
|
|
|
989
1198
|
#
|
|
990
1199
|
# resp = client.describe_connector_profiles({
|
|
991
1200
|
# connector_profile_names: ["ConnectorProfileName"],
|
|
992
|
-
# 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
|
|
1201
|
+
# 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
|
|
1202
|
+
# connector_label: "ConnectorLabel",
|
|
993
1203
|
# max_results: 1,
|
|
994
1204
|
# next_token: "NextToken",
|
|
995
1205
|
# })
|
|
@@ -999,7 +1209,8 @@ module Aws::Appflow
|
|
|
999
1209
|
# resp.connector_profile_details #=> Array
|
|
1000
1210
|
# resp.connector_profile_details[0].connector_profile_arn #=> String
|
|
1001
1211
|
# resp.connector_profile_details[0].connector_profile_name #=> String
|
|
1002
|
-
# resp.connector_profile_details[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData"
|
|
1212
|
+
# resp.connector_profile_details[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1213
|
+
# resp.connector_profile_details[0].connector_label #=> String
|
|
1003
1214
|
# resp.connector_profile_details[0].connection_mode #=> String, one of "Public", "Private"
|
|
1004
1215
|
# resp.connector_profile_details[0].credentials_arn #=> String
|
|
1005
1216
|
# resp.connector_profile_details[0].connector_profile_properties.datadog.instance_url #=> String
|
|
@@ -1033,6 +1244,10 @@ module Aws::Appflow
|
|
|
1033
1244
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.auth_code_url #=> String
|
|
1034
1245
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.o_auth_scopes #=> Array
|
|
1035
1246
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.o_auth_scopes[0] #=> String
|
|
1247
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.profile_properties #=> Hash
|
|
1248
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.profile_properties["ProfilePropertyKey"] #=> String
|
|
1249
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.o_auth_2_properties.token_url #=> String
|
|
1250
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.o_auth_2_properties.o_auth_2_grant_type #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE"
|
|
1036
1251
|
# resp.connector_profile_details[0].created_at #=> Time
|
|
1037
1252
|
# resp.connector_profile_details[0].last_updated_at #=> Time
|
|
1038
1253
|
# resp.connector_profile_details[0].private_connection_provisioning_state.status #=> String, one of "FAILED", "PENDING", "CREATED"
|
|
@@ -1060,12 +1275,17 @@ module Aws::Appflow
|
|
|
1060
1275
|
# @option params [Array<String>] :connector_types
|
|
1061
1276
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
1062
1277
|
#
|
|
1278
|
+
# @option params [Integer] :max_results
|
|
1279
|
+
# The maximum number of items that should be returned in the result set.
|
|
1280
|
+
# The default is 20.
|
|
1281
|
+
#
|
|
1063
1282
|
# @option params [String] :next_token
|
|
1064
1283
|
# The pagination token for the next page of data.
|
|
1065
1284
|
#
|
|
1066
1285
|
# @return [Types::DescribeConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1067
1286
|
#
|
|
1068
1287
|
# * {Types::DescribeConnectorsResponse#connector_configurations #connector_configurations} => Hash<String,Types::ConnectorConfiguration>
|
|
1288
|
+
# * {Types::DescribeConnectorsResponse#connectors #connectors} => Array<Types::ConnectorDetail>
|
|
1069
1289
|
# * {Types::DescribeConnectorsResponse#next_token #next_token} => String
|
|
1070
1290
|
#
|
|
1071
1291
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
@@ -1073,7 +1293,8 @@ module Aws::Appflow
|
|
|
1073
1293
|
# @example Request syntax with placeholder values
|
|
1074
1294
|
#
|
|
1075
1295
|
# resp = client.describe_connectors({
|
|
1076
|
-
# 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
|
|
1296
|
+
# 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
|
|
1297
|
+
# max_results: 1,
|
|
1077
1298
|
# next_token: "NextToken",
|
|
1078
1299
|
# })
|
|
1079
1300
|
#
|
|
@@ -1083,7 +1304,7 @@ module Aws::Appflow
|
|
|
1083
1304
|
# resp.connector_configurations["ConnectorType"].can_use_as_source #=> Boolean
|
|
1084
1305
|
# resp.connector_configurations["ConnectorType"].can_use_as_destination #=> Boolean
|
|
1085
1306
|
# resp.connector_configurations["ConnectorType"].supported_destination_connectors #=> Array
|
|
1086
|
-
# resp.connector_configurations["ConnectorType"].supported_destination_connectors[0] #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData"
|
|
1307
|
+
# resp.connector_configurations["ConnectorType"].supported_destination_connectors[0] #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1087
1308
|
# resp.connector_configurations["ConnectorType"].supported_scheduling_frequencies #=> Array
|
|
1088
1309
|
# resp.connector_configurations["ConnectorType"].supported_scheduling_frequencies[0] #=> String, one of "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE"
|
|
1089
1310
|
# resp.connector_configurations["ConnectorType"].is_private_link_enabled #=> Boolean
|
|
@@ -1102,6 +1323,70 @@ module Aws::Appflow
|
|
|
1102
1323
|
# resp.connector_configurations["ConnectorType"].connector_metadata.zendesk.o_auth_scopes[0] #=> String
|
|
1103
1324
|
# resp.connector_configurations["ConnectorType"].connector_metadata.honeycode.o_auth_scopes #=> Array
|
|
1104
1325
|
# resp.connector_configurations["ConnectorType"].connector_metadata.honeycode.o_auth_scopes[0] #=> String
|
|
1326
|
+
# resp.connector_configurations["ConnectorType"].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1327
|
+
# resp.connector_configurations["ConnectorType"].connector_label #=> String
|
|
1328
|
+
# resp.connector_configurations["ConnectorType"].connector_description #=> String
|
|
1329
|
+
# resp.connector_configurations["ConnectorType"].connector_owner #=> String
|
|
1330
|
+
# resp.connector_configurations["ConnectorType"].connector_name #=> String
|
|
1331
|
+
# resp.connector_configurations["ConnectorType"].connector_version #=> String
|
|
1332
|
+
# resp.connector_configurations["ConnectorType"].connector_arn #=> String
|
|
1333
|
+
# resp.connector_configurations["ConnectorType"].connector_modes #=> Array
|
|
1334
|
+
# resp.connector_configurations["ConnectorType"].connector_modes[0] #=> String
|
|
1335
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_basic_auth_supported #=> Boolean
|
|
1336
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_api_key_auth_supported #=> Boolean
|
|
1337
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_o_auth_2_supported #=> Boolean
|
|
1338
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_custom_auth_supported #=> Boolean
|
|
1339
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth_scopes #=> Array
|
|
1340
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth_scopes[0] #=> String
|
|
1341
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.token_urls #=> Array
|
|
1342
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.token_urls[0] #=> String
|
|
1343
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.auth_code_urls #=> Array
|
|
1344
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.auth_code_urls[0] #=> String
|
|
1345
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth2_grant_types_supported #=> Array
|
|
1346
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth2_grant_types_supported[0] #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE"
|
|
1347
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs #=> Array
|
|
1348
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].custom_authentication_type #=> String
|
|
1349
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters #=> Array
|
|
1350
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].key #=> String
|
|
1351
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].is_required #=> Boolean
|
|
1352
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].label #=> String
|
|
1353
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].description #=> String
|
|
1354
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].is_sensitive_field #=> Boolean
|
|
1355
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values #=> Array
|
|
1356
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values[0] #=> String
|
|
1357
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings #=> Array
|
|
1358
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].key #=> String
|
|
1359
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].data_type #=> String
|
|
1360
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].is_required #=> Boolean
|
|
1361
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].label #=> String
|
|
1362
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].description #=> String
|
|
1363
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].scope #=> String
|
|
1364
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].connector_supplied_value_options #=> Array
|
|
1365
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].connector_supplied_value_options[0] #=> String
|
|
1366
|
+
# resp.connector_configurations["ConnectorType"].supported_api_versions #=> Array
|
|
1367
|
+
# resp.connector_configurations["ConnectorType"].supported_api_versions[0] #=> String
|
|
1368
|
+
# resp.connector_configurations["ConnectorType"].supported_operators #=> Array
|
|
1369
|
+
# resp.connector_configurations["ConnectorType"].supported_operators[0] #=> String, one of "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"
|
|
1370
|
+
# resp.connector_configurations["ConnectorType"].supported_write_operations #=> Array
|
|
1371
|
+
# resp.connector_configurations["ConnectorType"].supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1372
|
+
# resp.connector_configurations["ConnectorType"].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1373
|
+
# resp.connector_configurations["ConnectorType"].connector_provisioning_config.lambda.lambda_arn #=> String
|
|
1374
|
+
# resp.connector_configurations["ConnectorType"].logo_url #=> String
|
|
1375
|
+
# resp.connector_configurations["ConnectorType"].registered_at #=> Time
|
|
1376
|
+
# resp.connector_configurations["ConnectorType"].registered_by #=> String
|
|
1377
|
+
# resp.connectors #=> Array
|
|
1378
|
+
# resp.connectors[0].connector_description #=> String
|
|
1379
|
+
# resp.connectors[0].connector_name #=> String
|
|
1380
|
+
# resp.connectors[0].connector_owner #=> String
|
|
1381
|
+
# resp.connectors[0].connector_version #=> String
|
|
1382
|
+
# resp.connectors[0].application_type #=> String
|
|
1383
|
+
# resp.connectors[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1384
|
+
# resp.connectors[0].connector_label #=> String
|
|
1385
|
+
# resp.connectors[0].registered_at #=> Time
|
|
1386
|
+
# resp.connectors[0].registered_by #=> String
|
|
1387
|
+
# resp.connectors[0].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1388
|
+
# resp.connectors[0].connector_modes #=> Array
|
|
1389
|
+
# resp.connectors[0].connector_modes[0] #=> String
|
|
1105
1390
|
# resp.next_token #=> String
|
|
1106
1391
|
#
|
|
1107
1392
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectors AWS API Documentation
|
|
@@ -1152,7 +1437,8 @@ module Aws::Appflow
|
|
|
1152
1437
|
# resp.kms_arn #=> String
|
|
1153
1438
|
# resp.flow_status #=> String, one of "Active", "Deprecated", "Deleted", "Draft", "Errored", "Suspended"
|
|
1154
1439
|
# resp.flow_status_message #=> String
|
|
1155
|
-
# resp.source_flow_config.connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData"
|
|
1440
|
+
# resp.source_flow_config.connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1441
|
+
# resp.source_flow_config.api_version #=> String
|
|
1156
1442
|
# resp.source_flow_config.connector_profile_name #=> String
|
|
1157
1443
|
# resp.source_flow_config.source_connector_properties.amplitude.object #=> String
|
|
1158
1444
|
# resp.source_flow_config.source_connector_properties.datadog.object #=> String
|
|
@@ -1177,9 +1463,13 @@ module Aws::Appflow
|
|
|
1177
1463
|
# resp.source_flow_config.source_connector_properties.veeva.include_all_versions #=> Boolean
|
|
1178
1464
|
# resp.source_flow_config.source_connector_properties.zendesk.object #=> String
|
|
1179
1465
|
# resp.source_flow_config.source_connector_properties.sapo_data.object_path #=> String
|
|
1466
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.entity_name #=> String
|
|
1467
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.custom_properties #=> Hash
|
|
1468
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.custom_properties["CustomPropertyKey"] #=> String
|
|
1180
1469
|
# resp.source_flow_config.incremental_pull_config.datetime_type_field_name #=> String
|
|
1181
1470
|
# resp.destination_flow_config_list #=> Array
|
|
1182
|
-
# resp.destination_flow_config_list[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData"
|
|
1471
|
+
# resp.destination_flow_config_list[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1472
|
+
# resp.destination_flow_config_list[0].api_version #=> String
|
|
1183
1473
|
# resp.destination_flow_config_list[0].connector_profile_name #=> String
|
|
1184
1474
|
# resp.destination_flow_config_list[0].destination_connector_properties.redshift.object #=> String
|
|
1185
1475
|
# resp.destination_flow_config_list[0].destination_connector_properties.redshift.intermediate_bucket_name #=> String
|
|
@@ -1199,7 +1489,7 @@ module Aws::Appflow
|
|
|
1199
1489
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1200
1490
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.bucket_prefix #=> String
|
|
1201
1491
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.bucket_name #=> String
|
|
1202
|
-
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1492
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1203
1493
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.object #=> String
|
|
1204
1494
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.intermediate_bucket_name #=> String
|
|
1205
1495
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.bucket_prefix #=> String
|
|
@@ -1228,7 +1518,16 @@ module Aws::Appflow
|
|
|
1228
1518
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1229
1519
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.bucket_prefix #=> String
|
|
1230
1520
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.bucket_name #=> String
|
|
1231
|
-
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1521
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1522
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.entity_name #=> String
|
|
1523
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1524
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.bucket_prefix #=> String
|
|
1525
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.bucket_name #=> String
|
|
1526
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1527
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.id_field_names #=> Array
|
|
1528
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.id_field_names[0] #=> String
|
|
1529
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.custom_properties #=> Hash
|
|
1530
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.custom_properties["CustomPropertyKey"] #=> String
|
|
1232
1531
|
# resp.last_run_execution_details.most_recent_execution_message #=> String
|
|
1233
1532
|
# resp.last_run_execution_details.most_recent_execution_time #=> Time
|
|
1234
1533
|
# resp.last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error"
|
|
@@ -1258,6 +1557,7 @@ module Aws::Appflow
|
|
|
1258
1557
|
# resp.tasks[0].connector_operator.veeva #=> String, one of "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"
|
|
1259
1558
|
# resp.tasks[0].connector_operator.zendesk #=> String, one of "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"
|
|
1260
1559
|
# resp.tasks[0].connector_operator.sapo_data #=> String, one of "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"
|
|
1560
|
+
# resp.tasks[0].connector_operator.custom_connector #=> String, one of "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"
|
|
1261
1561
|
# resp.tasks[0].destination_field #=> String
|
|
1262
1562
|
# resp.tasks[0].task_type #=> String, one of "Arithmetic", "Filter", "Map", "Map_all", "Mask", "Merge", "Truncate", "Validate"
|
|
1263
1563
|
# resp.tasks[0].task_properties #=> Hash
|
|
@@ -1353,6 +1653,9 @@ module Aws::Appflow
|
|
|
1353
1653
|
# roots. Otherwise, this request returns all entities supported by the
|
|
1354
1654
|
# provider.
|
|
1355
1655
|
#
|
|
1656
|
+
# @option params [String] :api_version
|
|
1657
|
+
# The version of the API that's used by the connector.
|
|
1658
|
+
#
|
|
1356
1659
|
# @return [Types::ListConnectorEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1357
1660
|
#
|
|
1358
1661
|
# * {Types::ListConnectorEntitiesResponse#connector_entity_map #connector_entity_map} => Hash<String,Array<Types::ConnectorEntity>>
|
|
@@ -1361,8 +1664,9 @@ module Aws::Appflow
|
|
|
1361
1664
|
#
|
|
1362
1665
|
# resp = client.list_connector_entities({
|
|
1363
1666
|
# connector_profile_name: "ConnectorProfileName",
|
|
1364
|
-
# 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
|
|
1667
|
+
# 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
|
|
1365
1668
|
# entities_path: "EntitiesPath",
|
|
1669
|
+
# api_version: "ApiVersion",
|
|
1366
1670
|
# })
|
|
1367
1671
|
#
|
|
1368
1672
|
# @example Response structure
|
|
@@ -1382,6 +1686,58 @@ module Aws::Appflow
|
|
|
1382
1686
|
req.send_request(options)
|
|
1383
1687
|
end
|
|
1384
1688
|
|
|
1689
|
+
# Returns the list of all registered custom connectors in your Amazon
|
|
1690
|
+
# Web Services account. This API lists only custom connectors registered
|
|
1691
|
+
# in this account, not the Amazon Web Services authored connectors.
|
|
1692
|
+
#
|
|
1693
|
+
# @option params [Integer] :max_results
|
|
1694
|
+
# Specifies the maximum number of items that should be returned in the
|
|
1695
|
+
# result set. The default for `maxResults` is 20 (for all paginated API
|
|
1696
|
+
# operations).
|
|
1697
|
+
#
|
|
1698
|
+
# @option params [String] :next_token
|
|
1699
|
+
# The pagination token for the next page of data.
|
|
1700
|
+
#
|
|
1701
|
+
# @return [Types::ListConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1702
|
+
#
|
|
1703
|
+
# * {Types::ListConnectorsResponse#connectors #connectors} => Array<Types::ConnectorDetail>
|
|
1704
|
+
# * {Types::ListConnectorsResponse#next_token #next_token} => String
|
|
1705
|
+
#
|
|
1706
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1707
|
+
#
|
|
1708
|
+
# @example Request syntax with placeholder values
|
|
1709
|
+
#
|
|
1710
|
+
# resp = client.list_connectors({
|
|
1711
|
+
# max_results: 1,
|
|
1712
|
+
# next_token: "NextToken",
|
|
1713
|
+
# })
|
|
1714
|
+
#
|
|
1715
|
+
# @example Response structure
|
|
1716
|
+
#
|
|
1717
|
+
# resp.connectors #=> Array
|
|
1718
|
+
# resp.connectors[0].connector_description #=> String
|
|
1719
|
+
# resp.connectors[0].connector_name #=> String
|
|
1720
|
+
# resp.connectors[0].connector_owner #=> String
|
|
1721
|
+
# resp.connectors[0].connector_version #=> String
|
|
1722
|
+
# resp.connectors[0].application_type #=> String
|
|
1723
|
+
# resp.connectors[0].connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1724
|
+
# resp.connectors[0].connector_label #=> String
|
|
1725
|
+
# resp.connectors[0].registered_at #=> Time
|
|
1726
|
+
# resp.connectors[0].registered_by #=> String
|
|
1727
|
+
# resp.connectors[0].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1728
|
+
# resp.connectors[0].connector_modes #=> Array
|
|
1729
|
+
# resp.connectors[0].connector_modes[0] #=> String
|
|
1730
|
+
# resp.next_token #=> String
|
|
1731
|
+
#
|
|
1732
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListConnectors AWS API Documentation
|
|
1733
|
+
#
|
|
1734
|
+
# @overload list_connectors(params = {})
|
|
1735
|
+
# @param [Hash] params ({})
|
|
1736
|
+
def list_connectors(params = {}, options = {})
|
|
1737
|
+
req = build_request(:list_connectors, params)
|
|
1738
|
+
req.send_request(options)
|
|
1739
|
+
end
|
|
1740
|
+
|
|
1385
1741
|
# Lists all of the flows associated with your account.
|
|
1386
1742
|
#
|
|
1387
1743
|
# @option params [Integer] :max_results
|
|
@@ -1412,8 +1768,10 @@ module Aws::Appflow
|
|
|
1412
1768
|
# resp.flows[0].description #=> String
|
|
1413
1769
|
# resp.flows[0].flow_name #=> String
|
|
1414
1770
|
# resp.flows[0].flow_status #=> String, one of "Active", "Deprecated", "Deleted", "Draft", "Errored", "Suspended"
|
|
1415
|
-
# resp.flows[0].source_connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData"
|
|
1416
|
-
# resp.flows[0].
|
|
1771
|
+
# resp.flows[0].source_connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1772
|
+
# resp.flows[0].source_connector_label #=> String
|
|
1773
|
+
# resp.flows[0].destination_connector_type #=> String, one of "Salesforce", "Singular", "Slack", "Redshift", "S3", "Marketo", "Googleanalytics", "Zendesk", "Servicenow", "Datadog", "Trendmicro", "Snowflake", "Dynatrace", "Infornexus", "Amplitude", "Veeva", "EventBridge", "LookoutMetrics", "Upsolver", "Honeycode", "CustomerProfiles", "SAPOData", "CustomConnector"
|
|
1774
|
+
# resp.flows[0].destination_connector_label #=> String
|
|
1417
1775
|
# resp.flows[0].trigger_type #=> String, one of "Scheduled", "Event", "OnDemand"
|
|
1418
1776
|
# resp.flows[0].created_at #=> Time
|
|
1419
1777
|
# resp.flows[0].last_updated_at #=> Time
|
|
@@ -1464,6 +1822,55 @@ module Aws::Appflow
|
|
|
1464
1822
|
req.send_request(options)
|
|
1465
1823
|
end
|
|
1466
1824
|
|
|
1825
|
+
# Registers a new connector with your Amazon Web Services account.
|
|
1826
|
+
# Before you can register the connector, you must deploy lambda in your
|
|
1827
|
+
# account.
|
|
1828
|
+
#
|
|
1829
|
+
# @option params [String] :connector_label
|
|
1830
|
+
# The name of the connector. The name is unique for each
|
|
1831
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
|
1832
|
+
#
|
|
1833
|
+
# @option params [String] :description
|
|
1834
|
+
# A description about the connector that's being registered.
|
|
1835
|
+
#
|
|
1836
|
+
# @option params [String] :connector_provisioning_type
|
|
1837
|
+
# The provisioning type of the connector. Currently the only supported
|
|
1838
|
+
# value is LAMBDA.
|
|
1839
|
+
#
|
|
1840
|
+
# @option params [Types::ConnectorProvisioningConfig] :connector_provisioning_config
|
|
1841
|
+
# The provisioning type of the connector. Currently the only supported
|
|
1842
|
+
# value is LAMBDA.
|
|
1843
|
+
#
|
|
1844
|
+
# @return [Types::RegisterConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1845
|
+
#
|
|
1846
|
+
# * {Types::RegisterConnectorResponse#connector_arn #connector_arn} => String
|
|
1847
|
+
#
|
|
1848
|
+
# @example Request syntax with placeholder values
|
|
1849
|
+
#
|
|
1850
|
+
# resp = client.register_connector({
|
|
1851
|
+
# connector_label: "ConnectorLabel",
|
|
1852
|
+
# description: "Description",
|
|
1853
|
+
# connector_provisioning_type: "LAMBDA", # accepts LAMBDA
|
|
1854
|
+
# connector_provisioning_config: {
|
|
1855
|
+
# lambda: {
|
|
1856
|
+
# lambda_arn: "ARN", # required
|
|
1857
|
+
# },
|
|
1858
|
+
# },
|
|
1859
|
+
# })
|
|
1860
|
+
#
|
|
1861
|
+
# @example Response structure
|
|
1862
|
+
#
|
|
1863
|
+
# resp.connector_arn #=> String
|
|
1864
|
+
#
|
|
1865
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/RegisterConnector AWS API Documentation
|
|
1866
|
+
#
|
|
1867
|
+
# @overload register_connector(params = {})
|
|
1868
|
+
# @param [Hash] params ({})
|
|
1869
|
+
def register_connector(params = {}, options = {})
|
|
1870
|
+
req = build_request(:register_connector, params)
|
|
1871
|
+
req.send_request(options)
|
|
1872
|
+
end
|
|
1873
|
+
|
|
1467
1874
|
# Activates an existing flow. For on-demand flows, this operation runs
|
|
1468
1875
|
# the flow immediately. For schedule and event-triggered flows, this
|
|
1469
1876
|
# operation activates the flow.
|
|
@@ -1560,6 +1967,36 @@ module Aws::Appflow
|
|
|
1560
1967
|
req.send_request(options)
|
|
1561
1968
|
end
|
|
1562
1969
|
|
|
1970
|
+
# Unregisters the custom connector registered in your account that
|
|
1971
|
+
# matches the connectorLabel provided in the request.
|
|
1972
|
+
#
|
|
1973
|
+
# @option params [required, String] :connector_label
|
|
1974
|
+
# The label of the connector. The label is unique for each
|
|
1975
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
|
1976
|
+
#
|
|
1977
|
+
# @option params [Boolean] :force_delete
|
|
1978
|
+
# Indicates whether Amazon AppFlow should unregister the connector, even
|
|
1979
|
+
# if it is currently in use in one or more connector profiles. The
|
|
1980
|
+
# default value is false.
|
|
1981
|
+
#
|
|
1982
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1983
|
+
#
|
|
1984
|
+
# @example Request syntax with placeholder values
|
|
1985
|
+
#
|
|
1986
|
+
# resp = client.unregister_connector({
|
|
1987
|
+
# connector_label: "ConnectorLabel", # required
|
|
1988
|
+
# force_delete: false,
|
|
1989
|
+
# })
|
|
1990
|
+
#
|
|
1991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/UnregisterConnector AWS API Documentation
|
|
1992
|
+
#
|
|
1993
|
+
# @overload unregister_connector(params = {})
|
|
1994
|
+
# @param [Hash] params ({})
|
|
1995
|
+
def unregister_connector(params = {}, options = {})
|
|
1996
|
+
req = build_request(:unregister_connector, params)
|
|
1997
|
+
req.send_request(options)
|
|
1998
|
+
end
|
|
1999
|
+
|
|
1563
2000
|
# Removes a tag from the specified flow.
|
|
1564
2001
|
#
|
|
1565
2002
|
# @option params [required, String] :resource_arn
|
|
@@ -1676,6 +2113,15 @@ module Aws::Appflow
|
|
|
1676
2113
|
# o_auth_scopes: ["OAuthScope"], # required
|
|
1677
2114
|
# },
|
|
1678
2115
|
# },
|
|
2116
|
+
# custom_connector: {
|
|
2117
|
+
# profile_properties: {
|
|
2118
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
|
2119
|
+
# },
|
|
2120
|
+
# o_auth_2_properties: {
|
|
2121
|
+
# token_url: "TokenUrl", # required
|
|
2122
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
|
2123
|
+
# },
|
|
2124
|
+
# },
|
|
1679
2125
|
# },
|
|
1680
2126
|
# connector_profile_credentials: { # required
|
|
1681
2127
|
# amplitude: {
|
|
@@ -1787,6 +2233,33 @@ module Aws::Appflow
|
|
|
1787
2233
|
# },
|
|
1788
2234
|
# },
|
|
1789
2235
|
# },
|
|
2236
|
+
# custom_connector: {
|
|
2237
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
|
2238
|
+
# basic: {
|
|
2239
|
+
# username: "Username", # required
|
|
2240
|
+
# password: "Password", # required
|
|
2241
|
+
# },
|
|
2242
|
+
# oauth2: {
|
|
2243
|
+
# client_id: "ClientId",
|
|
2244
|
+
# client_secret: "ClientSecret",
|
|
2245
|
+
# access_token: "AccessToken",
|
|
2246
|
+
# refresh_token: "RefreshToken",
|
|
2247
|
+
# o_auth_request: {
|
|
2248
|
+
# auth_code: "AuthCode",
|
|
2249
|
+
# redirect_uri: "RedirectUri",
|
|
2250
|
+
# },
|
|
2251
|
+
# },
|
|
2252
|
+
# api_key: {
|
|
2253
|
+
# api_key: "ApiKey", # required
|
|
2254
|
+
# api_secret_key: "ApiSecretKey",
|
|
2255
|
+
# },
|
|
2256
|
+
# custom: {
|
|
2257
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
|
2258
|
+
# credentials_map: {
|
|
2259
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
|
2260
|
+
# },
|
|
2261
|
+
# },
|
|
2262
|
+
# },
|
|
1790
2263
|
# },
|
|
1791
2264
|
# },
|
|
1792
2265
|
# })
|
|
@@ -1852,7 +2325,8 @@ module Aws::Appflow
|
|
|
1852
2325
|
# },
|
|
1853
2326
|
# },
|
|
1854
2327
|
# source_flow_config: { # required
|
|
1855
|
-
# 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
|
|
2328
|
+
# 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
|
|
2329
|
+
# api_version: "ApiVersion",
|
|
1856
2330
|
# connector_profile_name: "ConnectorProfileName",
|
|
1857
2331
|
# source_connector_properties: { # required
|
|
1858
2332
|
# amplitude: {
|
|
@@ -1910,6 +2384,12 @@ module Aws::Appflow
|
|
|
1910
2384
|
# sapo_data: {
|
|
1911
2385
|
# object_path: "Object",
|
|
1912
2386
|
# },
|
|
2387
|
+
# custom_connector: {
|
|
2388
|
+
# entity_name: "EntityName", # required
|
|
2389
|
+
# custom_properties: {
|
|
2390
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
2391
|
+
# },
|
|
2392
|
+
# },
|
|
1913
2393
|
# },
|
|
1914
2394
|
# incremental_pull_config: {
|
|
1915
2395
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
|
@@ -1917,7 +2397,8 @@ module Aws::Appflow
|
|
|
1917
2397
|
# },
|
|
1918
2398
|
# destination_flow_config_list: [ # required
|
|
1919
2399
|
# {
|
|
1920
|
-
# 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
|
|
2400
|
+
# 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
|
|
2401
|
+
# api_version: "ApiVersion",
|
|
1921
2402
|
# connector_profile_name: "ConnectorProfileName",
|
|
1922
2403
|
# destination_connector_properties: { # required
|
|
1923
2404
|
# redshift: {
|
|
@@ -1952,7 +2433,7 @@ module Aws::Appflow
|
|
|
1952
2433
|
# bucket_prefix: "BucketPrefix",
|
|
1953
2434
|
# bucket_name: "BucketName",
|
|
1954
2435
|
# },
|
|
1955
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
2436
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
1956
2437
|
# },
|
|
1957
2438
|
# snowflake: {
|
|
1958
2439
|
# object: "Object", # required
|
|
@@ -2008,7 +2489,20 @@ module Aws::Appflow
|
|
|
2008
2489
|
# bucket_prefix: "BucketPrefix",
|
|
2009
2490
|
# bucket_name: "BucketName",
|
|
2010
2491
|
# },
|
|
2011
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
2492
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
2493
|
+
# },
|
|
2494
|
+
# custom_connector: {
|
|
2495
|
+
# entity_name: "EntityName", # required
|
|
2496
|
+
# error_handling_config: {
|
|
2497
|
+
# fail_on_first_destination_error: false,
|
|
2498
|
+
# bucket_prefix: "BucketPrefix",
|
|
2499
|
+
# bucket_name: "BucketName",
|
|
2500
|
+
# },
|
|
2501
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
2502
|
+
# id_field_names: ["Name"],
|
|
2503
|
+
# custom_properties: {
|
|
2504
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
2505
|
+
# },
|
|
2012
2506
|
# },
|
|
2013
2507
|
# },
|
|
2014
2508
|
# },
|
|
@@ -2032,6 +2526,7 @@ module Aws::Appflow
|
|
|
2032
2526
|
# 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
|
|
2033
2527
|
# 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
|
|
2034
2528
|
# 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
|
|
2529
|
+
# 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
|
|
2035
2530
|
# },
|
|
2036
2531
|
# destination_field: "DestinationField",
|
|
2037
2532
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
|
@@ -2068,7 +2563,7 @@ module Aws::Appflow
|
|
|
2068
2563
|
params: params,
|
|
2069
2564
|
config: config)
|
|
2070
2565
|
context[:gem_name] = 'aws-sdk-appflow'
|
|
2071
|
-
context[:gem_version] = '1.
|
|
2566
|
+
context[:gem_version] = '1.22.0'
|
|
2072
2567
|
Seahorse::Client::Request.new(handlers, context)
|
|
2073
2568
|
end
|
|
2074
2569
|
|