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
|
@@ -366,6 +366,11 @@ module Aws::Appflow
|
|
|
366
366
|
# @option params [required, String] :connector_type
|
|
367
367
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
368
368
|
#
|
|
369
|
+
# @option params [String] :connector_label
|
|
370
|
+
# The label of the connector. The label is unique for each
|
|
371
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
372
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
373
|
+
#
|
|
369
374
|
# @option params [required, String] :connection_mode
|
|
370
375
|
# Indicates the connection mode and specifies whether it is public or
|
|
371
376
|
# private. Private flows use Amazon Web Services PrivateLink to route
|
|
@@ -384,7 +389,8 @@ module Aws::Appflow
|
|
|
384
389
|
# resp = client.create_connector_profile({
|
|
385
390
|
# connector_profile_name: "ConnectorProfileName", # required
|
|
386
391
|
# kms_arn: "KMSArn",
|
|
387
|
-
# 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
|
|
392
|
+
# 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
|
|
393
|
+
# connector_label: "ConnectorLabel",
|
|
388
394
|
# connection_mode: "Public", # required, accepts Public, Private
|
|
389
395
|
# connector_profile_config: { # required
|
|
390
396
|
# connector_profile_properties: { # required
|
|
@@ -454,6 +460,15 @@ module Aws::Appflow
|
|
|
454
460
|
# o_auth_scopes: ["OAuthScope"], # required
|
|
455
461
|
# },
|
|
456
462
|
# },
|
|
463
|
+
# custom_connector: {
|
|
464
|
+
# profile_properties: {
|
|
465
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
|
466
|
+
# },
|
|
467
|
+
# o_auth_2_properties: {
|
|
468
|
+
# token_url: "TokenUrl", # required
|
|
469
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
|
470
|
+
# },
|
|
471
|
+
# },
|
|
457
472
|
# },
|
|
458
473
|
# connector_profile_credentials: { # required
|
|
459
474
|
# amplitude: {
|
|
@@ -565,6 +580,33 @@ module Aws::Appflow
|
|
|
565
580
|
# },
|
|
566
581
|
# },
|
|
567
582
|
# },
|
|
583
|
+
# custom_connector: {
|
|
584
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
|
585
|
+
# basic: {
|
|
586
|
+
# username: "Username", # required
|
|
587
|
+
# password: "Password", # required
|
|
588
|
+
# },
|
|
589
|
+
# oauth2: {
|
|
590
|
+
# client_id: "ClientId",
|
|
591
|
+
# client_secret: "ClientSecret",
|
|
592
|
+
# access_token: "AccessToken",
|
|
593
|
+
# refresh_token: "RefreshToken",
|
|
594
|
+
# o_auth_request: {
|
|
595
|
+
# auth_code: "AuthCode",
|
|
596
|
+
# redirect_uri: "RedirectUri",
|
|
597
|
+
# },
|
|
598
|
+
# },
|
|
599
|
+
# api_key: {
|
|
600
|
+
# api_key: "ApiKey", # required
|
|
601
|
+
# api_secret_key: "ApiSecretKey",
|
|
602
|
+
# },
|
|
603
|
+
# custom: {
|
|
604
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
|
605
|
+
# credentials_map: {
|
|
606
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
|
607
|
+
# },
|
|
608
|
+
# },
|
|
609
|
+
# },
|
|
568
610
|
# },
|
|
569
611
|
# },
|
|
570
612
|
# })
|
|
@@ -646,7 +688,8 @@ module Aws::Appflow
|
|
|
646
688
|
# },
|
|
647
689
|
# },
|
|
648
690
|
# source_flow_config: { # required
|
|
649
|
-
# 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
|
|
691
|
+
# 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
|
|
692
|
+
# api_version: "ApiVersion",
|
|
650
693
|
# connector_profile_name: "ConnectorProfileName",
|
|
651
694
|
# source_connector_properties: { # required
|
|
652
695
|
# amplitude: {
|
|
@@ -704,6 +747,12 @@ module Aws::Appflow
|
|
|
704
747
|
# sapo_data: {
|
|
705
748
|
# object_path: "Object",
|
|
706
749
|
# },
|
|
750
|
+
# custom_connector: {
|
|
751
|
+
# entity_name: "EntityName", # required
|
|
752
|
+
# custom_properties: {
|
|
753
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
754
|
+
# },
|
|
755
|
+
# },
|
|
707
756
|
# },
|
|
708
757
|
# incremental_pull_config: {
|
|
709
758
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
|
@@ -711,7 +760,8 @@ module Aws::Appflow
|
|
|
711
760
|
# },
|
|
712
761
|
# destination_flow_config_list: [ # required
|
|
713
762
|
# {
|
|
714
|
-
# 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
|
|
763
|
+
# 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
|
|
764
|
+
# api_version: "ApiVersion",
|
|
715
765
|
# connector_profile_name: "ConnectorProfileName",
|
|
716
766
|
# destination_connector_properties: { # required
|
|
717
767
|
# redshift: {
|
|
@@ -746,7 +796,7 @@ module Aws::Appflow
|
|
|
746
796
|
# bucket_prefix: "BucketPrefix",
|
|
747
797
|
# bucket_name: "BucketName",
|
|
748
798
|
# },
|
|
749
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
799
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
750
800
|
# },
|
|
751
801
|
# snowflake: {
|
|
752
802
|
# object: "Object", # required
|
|
@@ -802,7 +852,20 @@ module Aws::Appflow
|
|
|
802
852
|
# bucket_prefix: "BucketPrefix",
|
|
803
853
|
# bucket_name: "BucketName",
|
|
804
854
|
# },
|
|
805
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
855
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
856
|
+
# },
|
|
857
|
+
# custom_connector: {
|
|
858
|
+
# entity_name: "EntityName", # required
|
|
859
|
+
# error_handling_config: {
|
|
860
|
+
# fail_on_first_destination_error: false,
|
|
861
|
+
# bucket_prefix: "BucketPrefix",
|
|
862
|
+
# bucket_name: "BucketName",
|
|
863
|
+
# },
|
|
864
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
865
|
+
# id_field_names: ["Name"],
|
|
866
|
+
# custom_properties: {
|
|
867
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
868
|
+
# },
|
|
806
869
|
# },
|
|
807
870
|
# },
|
|
808
871
|
# },
|
|
@@ -826,6 +889,7 @@ module Aws::Appflow
|
|
|
826
889
|
# 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
|
|
827
890
|
# 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
|
|
828
891
|
# 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
|
|
892
|
+
# 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
|
|
829
893
|
# },
|
|
830
894
|
# destination_field: "DestinationField",
|
|
831
895
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
|
@@ -911,6 +975,115 @@ module Aws::Appflow
|
|
|
911
975
|
req.send_request(options)
|
|
912
976
|
end
|
|
913
977
|
|
|
978
|
+
# Describes the given custom connector registered in your Amazon Web
|
|
979
|
+
# Services account. This API can be used for custom connectors that are
|
|
980
|
+
# registered in your account and also for Amazon authored connectors.
|
|
981
|
+
#
|
|
982
|
+
# @option params [required, String] :connector_type
|
|
983
|
+
# The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo.
|
|
984
|
+
# Please choose CUSTOMCONNECTOR for Lambda based custom connectors.
|
|
985
|
+
#
|
|
986
|
+
# @option params [String] :connector_label
|
|
987
|
+
# The label of the connector. The label is unique for each
|
|
988
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
989
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
990
|
+
#
|
|
991
|
+
# @return [Types::DescribeConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
992
|
+
#
|
|
993
|
+
# * {Types::DescribeConnectorResponse#connector_configuration #connector_configuration} => Types::ConnectorConfiguration
|
|
994
|
+
#
|
|
995
|
+
# @example Request syntax with placeholder values
|
|
996
|
+
#
|
|
997
|
+
# resp = client.describe_connector({
|
|
998
|
+
# 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
|
|
999
|
+
# connector_label: "ConnectorLabel",
|
|
1000
|
+
# })
|
|
1001
|
+
#
|
|
1002
|
+
# @example Response structure
|
|
1003
|
+
#
|
|
1004
|
+
# resp.connector_configuration.can_use_as_source #=> Boolean
|
|
1005
|
+
# resp.connector_configuration.can_use_as_destination #=> Boolean
|
|
1006
|
+
# resp.connector_configuration.supported_destination_connectors #=> Array
|
|
1007
|
+
# 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"
|
|
1008
|
+
# resp.connector_configuration.supported_scheduling_frequencies #=> Array
|
|
1009
|
+
# resp.connector_configuration.supported_scheduling_frequencies[0] #=> String, one of "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE"
|
|
1010
|
+
# resp.connector_configuration.is_private_link_enabled #=> Boolean
|
|
1011
|
+
# resp.connector_configuration.is_private_link_endpoint_url_required #=> Boolean
|
|
1012
|
+
# resp.connector_configuration.supported_trigger_types #=> Array
|
|
1013
|
+
# resp.connector_configuration.supported_trigger_types[0] #=> String, one of "Scheduled", "Event", "OnDemand"
|
|
1014
|
+
# resp.connector_configuration.connector_metadata.google_analytics.o_auth_scopes #=> Array
|
|
1015
|
+
# resp.connector_configuration.connector_metadata.google_analytics.o_auth_scopes[0] #=> String
|
|
1016
|
+
# resp.connector_configuration.connector_metadata.salesforce.o_auth_scopes #=> Array
|
|
1017
|
+
# resp.connector_configuration.connector_metadata.salesforce.o_auth_scopes[0] #=> String
|
|
1018
|
+
# resp.connector_configuration.connector_metadata.slack.o_auth_scopes #=> Array
|
|
1019
|
+
# resp.connector_configuration.connector_metadata.slack.o_auth_scopes[0] #=> String
|
|
1020
|
+
# resp.connector_configuration.connector_metadata.snowflake.supported_regions #=> Array
|
|
1021
|
+
# resp.connector_configuration.connector_metadata.snowflake.supported_regions[0] #=> String
|
|
1022
|
+
# resp.connector_configuration.connector_metadata.zendesk.o_auth_scopes #=> Array
|
|
1023
|
+
# resp.connector_configuration.connector_metadata.zendesk.o_auth_scopes[0] #=> String
|
|
1024
|
+
# resp.connector_configuration.connector_metadata.honeycode.o_auth_scopes #=> Array
|
|
1025
|
+
# resp.connector_configuration.connector_metadata.honeycode.o_auth_scopes[0] #=> String
|
|
1026
|
+
# 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"
|
|
1027
|
+
# resp.connector_configuration.connector_label #=> String
|
|
1028
|
+
# resp.connector_configuration.connector_description #=> String
|
|
1029
|
+
# resp.connector_configuration.connector_owner #=> String
|
|
1030
|
+
# resp.connector_configuration.connector_name #=> String
|
|
1031
|
+
# resp.connector_configuration.connector_version #=> String
|
|
1032
|
+
# resp.connector_configuration.connector_arn #=> String
|
|
1033
|
+
# resp.connector_configuration.connector_modes #=> Array
|
|
1034
|
+
# resp.connector_configuration.connector_modes[0] #=> String
|
|
1035
|
+
# resp.connector_configuration.authentication_config.is_basic_auth_supported #=> Boolean
|
|
1036
|
+
# resp.connector_configuration.authentication_config.is_api_key_auth_supported #=> Boolean
|
|
1037
|
+
# resp.connector_configuration.authentication_config.is_o_auth_2_supported #=> Boolean
|
|
1038
|
+
# resp.connector_configuration.authentication_config.is_custom_auth_supported #=> Boolean
|
|
1039
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth_scopes #=> Array
|
|
1040
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth_scopes[0] #=> String
|
|
1041
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.token_urls #=> Array
|
|
1042
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.token_urls[0] #=> String
|
|
1043
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.auth_code_urls #=> Array
|
|
1044
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.auth_code_urls[0] #=> String
|
|
1045
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth2_grant_types_supported #=> Array
|
|
1046
|
+
# resp.connector_configuration.authentication_config.o_auth_2_defaults.oauth2_grant_types_supported[0] #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE"
|
|
1047
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs #=> Array
|
|
1048
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].custom_authentication_type #=> String
|
|
1049
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters #=> Array
|
|
1050
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].key #=> String
|
|
1051
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].is_required #=> Boolean
|
|
1052
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].label #=> String
|
|
1053
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].description #=> String
|
|
1054
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].is_sensitive_field #=> Boolean
|
|
1055
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values #=> Array
|
|
1056
|
+
# resp.connector_configuration.authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values[0] #=> String
|
|
1057
|
+
# resp.connector_configuration.connector_runtime_settings #=> Array
|
|
1058
|
+
# resp.connector_configuration.connector_runtime_settings[0].key #=> String
|
|
1059
|
+
# resp.connector_configuration.connector_runtime_settings[0].data_type #=> String
|
|
1060
|
+
# resp.connector_configuration.connector_runtime_settings[0].is_required #=> Boolean
|
|
1061
|
+
# resp.connector_configuration.connector_runtime_settings[0].label #=> String
|
|
1062
|
+
# resp.connector_configuration.connector_runtime_settings[0].description #=> String
|
|
1063
|
+
# resp.connector_configuration.connector_runtime_settings[0].scope #=> String
|
|
1064
|
+
# resp.connector_configuration.connector_runtime_settings[0].connector_supplied_value_options #=> Array
|
|
1065
|
+
# resp.connector_configuration.connector_runtime_settings[0].connector_supplied_value_options[0] #=> String
|
|
1066
|
+
# resp.connector_configuration.supported_api_versions #=> Array
|
|
1067
|
+
# resp.connector_configuration.supported_api_versions[0] #=> String
|
|
1068
|
+
# resp.connector_configuration.supported_operators #=> Array
|
|
1069
|
+
# 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"
|
|
1070
|
+
# resp.connector_configuration.supported_write_operations #=> Array
|
|
1071
|
+
# resp.connector_configuration.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1072
|
+
# resp.connector_configuration.connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1073
|
+
# resp.connector_configuration.connector_provisioning_config.lambda.lambda_arn #=> String
|
|
1074
|
+
# resp.connector_configuration.logo_url #=> String
|
|
1075
|
+
# resp.connector_configuration.registered_at #=> Time
|
|
1076
|
+
# resp.connector_configuration.registered_by #=> String
|
|
1077
|
+
#
|
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnector AWS API Documentation
|
|
1079
|
+
#
|
|
1080
|
+
# @overload describe_connector(params = {})
|
|
1081
|
+
# @param [Hash] params ({})
|
|
1082
|
+
def describe_connector(params = {}, options = {})
|
|
1083
|
+
req = build_request(:describe_connector, params)
|
|
1084
|
+
req.send_request(options)
|
|
1085
|
+
end
|
|
1086
|
+
|
|
914
1087
|
# Provides details regarding the entity used with the connector, with a
|
|
915
1088
|
# description of the data model for each entity.
|
|
916
1089
|
#
|
|
@@ -925,6 +1098,9 @@ module Aws::Appflow
|
|
|
925
1098
|
# The name of the connector profile. The name is unique for each
|
|
926
1099
|
# `ConnectorProfile` in the Amazon Web Services account.
|
|
927
1100
|
#
|
|
1101
|
+
# @option params [String] :api_version
|
|
1102
|
+
# The version of the API that's used by the connector.
|
|
1103
|
+
#
|
|
928
1104
|
# @return [Types::DescribeConnectorEntityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
929
1105
|
#
|
|
930
1106
|
# * {Types::DescribeConnectorEntityResponse#connector_entity_fields #connector_entity_fields} => Array<Types::ConnectorEntityField>
|
|
@@ -932,30 +1108,45 @@ module Aws::Appflow
|
|
|
932
1108
|
# @example Request syntax with placeholder values
|
|
933
1109
|
#
|
|
934
1110
|
# resp = client.describe_connector_entity({
|
|
935
|
-
# connector_entity_name: "
|
|
936
|
-
# 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
|
|
1111
|
+
# connector_entity_name: "EntityName", # required
|
|
1112
|
+
# 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
|
|
937
1113
|
# connector_profile_name: "ConnectorProfileName",
|
|
1114
|
+
# api_version: "ApiVersion",
|
|
938
1115
|
# })
|
|
939
1116
|
#
|
|
940
1117
|
# @example Response structure
|
|
941
1118
|
#
|
|
942
1119
|
# resp.connector_entity_fields #=> Array
|
|
943
1120
|
# resp.connector_entity_fields[0].identifier #=> String
|
|
1121
|
+
# resp.connector_entity_fields[0].parent_identifier #=> String
|
|
944
1122
|
# resp.connector_entity_fields[0].label #=> String
|
|
1123
|
+
# resp.connector_entity_fields[0].is_primary_key #=> Boolean
|
|
1124
|
+
# resp.connector_entity_fields[0].default_value #=> String
|
|
1125
|
+
# resp.connector_entity_fields[0].is_deprecated #=> Boolean
|
|
945
1126
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_type #=> String
|
|
946
1127
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.filter_operators #=> Array
|
|
947
1128
|
# 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"
|
|
948
1129
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_values #=> Array
|
|
949
1130
|
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_values[0] #=> String
|
|
1131
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.value_regex_pattern #=> String
|
|
1132
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.supported_date_format #=> String
|
|
1133
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_value_range.maximum #=> Float
|
|
1134
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_value_range.minimum #=> Float
|
|
1135
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_length_range.maximum #=> Float
|
|
1136
|
+
# resp.connector_entity_fields[0].supported_field_type_details.v1.field_length_range.minimum #=> Float
|
|
950
1137
|
# resp.connector_entity_fields[0].description #=> String
|
|
951
1138
|
# resp.connector_entity_fields[0].source_properties.is_retrievable #=> Boolean
|
|
952
1139
|
# resp.connector_entity_fields[0].source_properties.is_queryable #=> Boolean
|
|
1140
|
+
# resp.connector_entity_fields[0].source_properties.is_timestamp_field_for_incremental_queries #=> Boolean
|
|
953
1141
|
# resp.connector_entity_fields[0].destination_properties.is_creatable #=> Boolean
|
|
954
1142
|
# resp.connector_entity_fields[0].destination_properties.is_nullable #=> Boolean
|
|
955
1143
|
# resp.connector_entity_fields[0].destination_properties.is_upsertable #=> Boolean
|
|
956
1144
|
# resp.connector_entity_fields[0].destination_properties.is_updatable #=> Boolean
|
|
1145
|
+
# resp.connector_entity_fields[0].destination_properties.is_defaulted_on_create #=> Boolean
|
|
957
1146
|
# resp.connector_entity_fields[0].destination_properties.supported_write_operations #=> Array
|
|
958
|
-
# resp.connector_entity_fields[0].destination_properties.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1147
|
+
# resp.connector_entity_fields[0].destination_properties.supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1148
|
+
# resp.connector_entity_fields[0].custom_properties #=> Hash
|
|
1149
|
+
# resp.connector_entity_fields[0].custom_properties["CustomPropertyKey"] #=> String
|
|
959
1150
|
#
|
|
960
1151
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectorEntity AWS API Documentation
|
|
961
1152
|
#
|
|
@@ -981,6 +1172,11 @@ module Aws::Appflow
|
|
|
981
1172
|
# @option params [String] :connector_type
|
|
982
1173
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
983
1174
|
#
|
|
1175
|
+
# @option params [String] :connector_label
|
|
1176
|
+
# The name of the connector. The name is unique for each
|
|
1177
|
+
# `ConnectorRegistration` in your Amazon Web Services account. Only
|
|
1178
|
+
# needed if calling for CUSTOMCONNECTOR connector type/.
|
|
1179
|
+
#
|
|
984
1180
|
# @option params [Integer] :max_results
|
|
985
1181
|
# Specifies the maximum number of items that should be returned in the
|
|
986
1182
|
# result set. The default for `maxResults` is 20 (for all paginated API
|
|
@@ -1000,7 +1196,8 @@ module Aws::Appflow
|
|
|
1000
1196
|
#
|
|
1001
1197
|
# resp = client.describe_connector_profiles({
|
|
1002
1198
|
# connector_profile_names: ["ConnectorProfileName"],
|
|
1003
|
-
# 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
|
|
1199
|
+
# 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
|
|
1200
|
+
# connector_label: "ConnectorLabel",
|
|
1004
1201
|
# max_results: 1,
|
|
1005
1202
|
# next_token: "NextToken",
|
|
1006
1203
|
# })
|
|
@@ -1010,7 +1207,8 @@ module Aws::Appflow
|
|
|
1010
1207
|
# resp.connector_profile_details #=> Array
|
|
1011
1208
|
# resp.connector_profile_details[0].connector_profile_arn #=> String
|
|
1012
1209
|
# resp.connector_profile_details[0].connector_profile_name #=> String
|
|
1013
|
-
# 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"
|
|
1210
|
+
# 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"
|
|
1211
|
+
# resp.connector_profile_details[0].connector_label #=> String
|
|
1014
1212
|
# resp.connector_profile_details[0].connection_mode #=> String, one of "Public", "Private"
|
|
1015
1213
|
# resp.connector_profile_details[0].credentials_arn #=> String
|
|
1016
1214
|
# resp.connector_profile_details[0].connector_profile_properties.datadog.instance_url #=> String
|
|
@@ -1044,6 +1242,10 @@ module Aws::Appflow
|
|
|
1044
1242
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.auth_code_url #=> String
|
|
1045
1243
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.o_auth_scopes #=> Array
|
|
1046
1244
|
# resp.connector_profile_details[0].connector_profile_properties.sapo_data.o_auth_properties.o_auth_scopes[0] #=> String
|
|
1245
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.profile_properties #=> Hash
|
|
1246
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.profile_properties["ProfilePropertyKey"] #=> String
|
|
1247
|
+
# resp.connector_profile_details[0].connector_profile_properties.custom_connector.o_auth_2_properties.token_url #=> String
|
|
1248
|
+
# 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"
|
|
1047
1249
|
# resp.connector_profile_details[0].created_at #=> Time
|
|
1048
1250
|
# resp.connector_profile_details[0].last_updated_at #=> Time
|
|
1049
1251
|
# resp.connector_profile_details[0].private_connection_provisioning_state.status #=> String, one of "FAILED", "PENDING", "CREATED"
|
|
@@ -1071,12 +1273,17 @@ module Aws::Appflow
|
|
|
1071
1273
|
# @option params [Array<String>] :connector_types
|
|
1072
1274
|
# The type of connector, such as Salesforce, Amplitude, and so on.
|
|
1073
1275
|
#
|
|
1276
|
+
# @option params [Integer] :max_results
|
|
1277
|
+
# The maximum number of items that should be returned in the result set.
|
|
1278
|
+
# The default is 20.
|
|
1279
|
+
#
|
|
1074
1280
|
# @option params [String] :next_token
|
|
1075
1281
|
# The pagination token for the next page of data.
|
|
1076
1282
|
#
|
|
1077
1283
|
# @return [Types::DescribeConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1078
1284
|
#
|
|
1079
1285
|
# * {Types::DescribeConnectorsResponse#connector_configurations #connector_configurations} => Hash<String,Types::ConnectorConfiguration>
|
|
1286
|
+
# * {Types::DescribeConnectorsResponse#connectors #connectors} => Array<Types::ConnectorDetail>
|
|
1080
1287
|
# * {Types::DescribeConnectorsResponse#next_token #next_token} => String
|
|
1081
1288
|
#
|
|
1082
1289
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
@@ -1084,7 +1291,8 @@ module Aws::Appflow
|
|
|
1084
1291
|
# @example Request syntax with placeholder values
|
|
1085
1292
|
#
|
|
1086
1293
|
# resp = client.describe_connectors({
|
|
1087
|
-
# 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
|
|
1294
|
+
# 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
|
|
1295
|
+
# max_results: 1,
|
|
1088
1296
|
# next_token: "NextToken",
|
|
1089
1297
|
# })
|
|
1090
1298
|
#
|
|
@@ -1094,7 +1302,7 @@ module Aws::Appflow
|
|
|
1094
1302
|
# resp.connector_configurations["ConnectorType"].can_use_as_source #=> Boolean
|
|
1095
1303
|
# resp.connector_configurations["ConnectorType"].can_use_as_destination #=> Boolean
|
|
1096
1304
|
# resp.connector_configurations["ConnectorType"].supported_destination_connectors #=> Array
|
|
1097
|
-
# 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"
|
|
1305
|
+
# 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"
|
|
1098
1306
|
# resp.connector_configurations["ConnectorType"].supported_scheduling_frequencies #=> Array
|
|
1099
1307
|
# resp.connector_configurations["ConnectorType"].supported_scheduling_frequencies[0] #=> String, one of "BYMINUTE", "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "ONCE"
|
|
1100
1308
|
# resp.connector_configurations["ConnectorType"].is_private_link_enabled #=> Boolean
|
|
@@ -1113,6 +1321,70 @@ module Aws::Appflow
|
|
|
1113
1321
|
# resp.connector_configurations["ConnectorType"].connector_metadata.zendesk.o_auth_scopes[0] #=> String
|
|
1114
1322
|
# resp.connector_configurations["ConnectorType"].connector_metadata.honeycode.o_auth_scopes #=> Array
|
|
1115
1323
|
# resp.connector_configurations["ConnectorType"].connector_metadata.honeycode.o_auth_scopes[0] #=> String
|
|
1324
|
+
# 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"
|
|
1325
|
+
# resp.connector_configurations["ConnectorType"].connector_label #=> String
|
|
1326
|
+
# resp.connector_configurations["ConnectorType"].connector_description #=> String
|
|
1327
|
+
# resp.connector_configurations["ConnectorType"].connector_owner #=> String
|
|
1328
|
+
# resp.connector_configurations["ConnectorType"].connector_name #=> String
|
|
1329
|
+
# resp.connector_configurations["ConnectorType"].connector_version #=> String
|
|
1330
|
+
# resp.connector_configurations["ConnectorType"].connector_arn #=> String
|
|
1331
|
+
# resp.connector_configurations["ConnectorType"].connector_modes #=> Array
|
|
1332
|
+
# resp.connector_configurations["ConnectorType"].connector_modes[0] #=> String
|
|
1333
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_basic_auth_supported #=> Boolean
|
|
1334
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_api_key_auth_supported #=> Boolean
|
|
1335
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_o_auth_2_supported #=> Boolean
|
|
1336
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.is_custom_auth_supported #=> Boolean
|
|
1337
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth_scopes #=> Array
|
|
1338
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth_scopes[0] #=> String
|
|
1339
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.token_urls #=> Array
|
|
1340
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.token_urls[0] #=> String
|
|
1341
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.auth_code_urls #=> Array
|
|
1342
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.auth_code_urls[0] #=> String
|
|
1343
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth2_grant_types_supported #=> Array
|
|
1344
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.o_auth_2_defaults.oauth2_grant_types_supported[0] #=> String, one of "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE"
|
|
1345
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs #=> Array
|
|
1346
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].custom_authentication_type #=> String
|
|
1347
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters #=> Array
|
|
1348
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].key #=> String
|
|
1349
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].is_required #=> Boolean
|
|
1350
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].label #=> String
|
|
1351
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].description #=> String
|
|
1352
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].is_sensitive_field #=> Boolean
|
|
1353
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values #=> Array
|
|
1354
|
+
# resp.connector_configurations["ConnectorType"].authentication_config.custom_auth_configs[0].auth_parameters[0].connector_supplied_values[0] #=> String
|
|
1355
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings #=> Array
|
|
1356
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].key #=> String
|
|
1357
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].data_type #=> String
|
|
1358
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].is_required #=> Boolean
|
|
1359
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].label #=> String
|
|
1360
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].description #=> String
|
|
1361
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].scope #=> String
|
|
1362
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].connector_supplied_value_options #=> Array
|
|
1363
|
+
# resp.connector_configurations["ConnectorType"].connector_runtime_settings[0].connector_supplied_value_options[0] #=> String
|
|
1364
|
+
# resp.connector_configurations["ConnectorType"].supported_api_versions #=> Array
|
|
1365
|
+
# resp.connector_configurations["ConnectorType"].supported_api_versions[0] #=> String
|
|
1366
|
+
# resp.connector_configurations["ConnectorType"].supported_operators #=> Array
|
|
1367
|
+
# 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"
|
|
1368
|
+
# resp.connector_configurations["ConnectorType"].supported_write_operations #=> Array
|
|
1369
|
+
# resp.connector_configurations["ConnectorType"].supported_write_operations[0] #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1370
|
+
# resp.connector_configurations["ConnectorType"].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1371
|
+
# resp.connector_configurations["ConnectorType"].connector_provisioning_config.lambda.lambda_arn #=> String
|
|
1372
|
+
# resp.connector_configurations["ConnectorType"].logo_url #=> String
|
|
1373
|
+
# resp.connector_configurations["ConnectorType"].registered_at #=> Time
|
|
1374
|
+
# resp.connector_configurations["ConnectorType"].registered_by #=> String
|
|
1375
|
+
# resp.connectors #=> Array
|
|
1376
|
+
# resp.connectors[0].connector_description #=> String
|
|
1377
|
+
# resp.connectors[0].connector_name #=> String
|
|
1378
|
+
# resp.connectors[0].connector_owner #=> String
|
|
1379
|
+
# resp.connectors[0].connector_version #=> String
|
|
1380
|
+
# resp.connectors[0].application_type #=> String
|
|
1381
|
+
# 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"
|
|
1382
|
+
# resp.connectors[0].connector_label #=> String
|
|
1383
|
+
# resp.connectors[0].registered_at #=> Time
|
|
1384
|
+
# resp.connectors[0].registered_by #=> String
|
|
1385
|
+
# resp.connectors[0].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1386
|
+
# resp.connectors[0].connector_modes #=> Array
|
|
1387
|
+
# resp.connectors[0].connector_modes[0] #=> String
|
|
1116
1388
|
# resp.next_token #=> String
|
|
1117
1389
|
#
|
|
1118
1390
|
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/DescribeConnectors AWS API Documentation
|
|
@@ -1163,7 +1435,8 @@ module Aws::Appflow
|
|
|
1163
1435
|
# resp.kms_arn #=> String
|
|
1164
1436
|
# resp.flow_status #=> String, one of "Active", "Deprecated", "Deleted", "Draft", "Errored", "Suspended"
|
|
1165
1437
|
# resp.flow_status_message #=> String
|
|
1166
|
-
# 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"
|
|
1438
|
+
# 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"
|
|
1439
|
+
# resp.source_flow_config.api_version #=> String
|
|
1167
1440
|
# resp.source_flow_config.connector_profile_name #=> String
|
|
1168
1441
|
# resp.source_flow_config.source_connector_properties.amplitude.object #=> String
|
|
1169
1442
|
# resp.source_flow_config.source_connector_properties.datadog.object #=> String
|
|
@@ -1188,9 +1461,13 @@ module Aws::Appflow
|
|
|
1188
1461
|
# resp.source_flow_config.source_connector_properties.veeva.include_all_versions #=> Boolean
|
|
1189
1462
|
# resp.source_flow_config.source_connector_properties.zendesk.object #=> String
|
|
1190
1463
|
# resp.source_flow_config.source_connector_properties.sapo_data.object_path #=> String
|
|
1464
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.entity_name #=> String
|
|
1465
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.custom_properties #=> Hash
|
|
1466
|
+
# resp.source_flow_config.source_connector_properties.custom_connector.custom_properties["CustomPropertyKey"] #=> String
|
|
1191
1467
|
# resp.source_flow_config.incremental_pull_config.datetime_type_field_name #=> String
|
|
1192
1468
|
# resp.destination_flow_config_list #=> Array
|
|
1193
|
-
# 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"
|
|
1469
|
+
# 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"
|
|
1470
|
+
# resp.destination_flow_config_list[0].api_version #=> String
|
|
1194
1471
|
# resp.destination_flow_config_list[0].connector_profile_name #=> String
|
|
1195
1472
|
# resp.destination_flow_config_list[0].destination_connector_properties.redshift.object #=> String
|
|
1196
1473
|
# resp.destination_flow_config_list[0].destination_connector_properties.redshift.intermediate_bucket_name #=> String
|
|
@@ -1210,7 +1487,7 @@ module Aws::Appflow
|
|
|
1210
1487
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1211
1488
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.bucket_prefix #=> String
|
|
1212
1489
|
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.error_handling_config.bucket_name #=> String
|
|
1213
|
-
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1490
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.salesforce.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1214
1491
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.object #=> String
|
|
1215
1492
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.intermediate_bucket_name #=> String
|
|
1216
1493
|
# resp.destination_flow_config_list[0].destination_connector_properties.snowflake.bucket_prefix #=> String
|
|
@@ -1239,7 +1516,16 @@ module Aws::Appflow
|
|
|
1239
1516
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1240
1517
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.bucket_prefix #=> String
|
|
1241
1518
|
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.error_handling_config.bucket_name #=> String
|
|
1242
|
-
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE"
|
|
1519
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.zendesk.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1520
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.entity_name #=> String
|
|
1521
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.fail_on_first_destination_error #=> Boolean
|
|
1522
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.bucket_prefix #=> String
|
|
1523
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.error_handling_config.bucket_name #=> String
|
|
1524
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.write_operation_type #=> String, one of "INSERT", "UPSERT", "UPDATE", "DELETE"
|
|
1525
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.id_field_names #=> Array
|
|
1526
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.id_field_names[0] #=> String
|
|
1527
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.custom_properties #=> Hash
|
|
1528
|
+
# resp.destination_flow_config_list[0].destination_connector_properties.custom_connector.custom_properties["CustomPropertyKey"] #=> String
|
|
1243
1529
|
# resp.last_run_execution_details.most_recent_execution_message #=> String
|
|
1244
1530
|
# resp.last_run_execution_details.most_recent_execution_time #=> Time
|
|
1245
1531
|
# resp.last_run_execution_details.most_recent_execution_status #=> String, one of "InProgress", "Successful", "Error"
|
|
@@ -1269,6 +1555,7 @@ module Aws::Appflow
|
|
|
1269
1555
|
# 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"
|
|
1270
1556
|
# 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"
|
|
1271
1557
|
# 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"
|
|
1558
|
+
# 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"
|
|
1272
1559
|
# resp.tasks[0].destination_field #=> String
|
|
1273
1560
|
# resp.tasks[0].task_type #=> String, one of "Arithmetic", "Filter", "Map", "Map_all", "Mask", "Merge", "Truncate", "Validate"
|
|
1274
1561
|
# resp.tasks[0].task_properties #=> Hash
|
|
@@ -1364,6 +1651,9 @@ module Aws::Appflow
|
|
|
1364
1651
|
# roots. Otherwise, this request returns all entities supported by the
|
|
1365
1652
|
# provider.
|
|
1366
1653
|
#
|
|
1654
|
+
# @option params [String] :api_version
|
|
1655
|
+
# The version of the API that's used by the connector.
|
|
1656
|
+
#
|
|
1367
1657
|
# @return [Types::ListConnectorEntitiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1368
1658
|
#
|
|
1369
1659
|
# * {Types::ListConnectorEntitiesResponse#connector_entity_map #connector_entity_map} => Hash<String,Array<Types::ConnectorEntity>>
|
|
@@ -1372,8 +1662,9 @@ module Aws::Appflow
|
|
|
1372
1662
|
#
|
|
1373
1663
|
# resp = client.list_connector_entities({
|
|
1374
1664
|
# connector_profile_name: "ConnectorProfileName",
|
|
1375
|
-
# 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
|
|
1665
|
+
# 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
|
|
1376
1666
|
# entities_path: "EntitiesPath",
|
|
1667
|
+
# api_version: "ApiVersion",
|
|
1377
1668
|
# })
|
|
1378
1669
|
#
|
|
1379
1670
|
# @example Response structure
|
|
@@ -1393,6 +1684,58 @@ module Aws::Appflow
|
|
|
1393
1684
|
req.send_request(options)
|
|
1394
1685
|
end
|
|
1395
1686
|
|
|
1687
|
+
# Returns the list of all registered custom connectors in your Amazon
|
|
1688
|
+
# Web Services account. This API lists only custom connectors registered
|
|
1689
|
+
# in this account, not the Amazon Web Services authored connectors.
|
|
1690
|
+
#
|
|
1691
|
+
# @option params [Integer] :max_results
|
|
1692
|
+
# Specifies the maximum number of items that should be returned in the
|
|
1693
|
+
# result set. The default for `maxResults` is 20 (for all paginated API
|
|
1694
|
+
# operations).
|
|
1695
|
+
#
|
|
1696
|
+
# @option params [String] :next_token
|
|
1697
|
+
# The pagination token for the next page of data.
|
|
1698
|
+
#
|
|
1699
|
+
# @return [Types::ListConnectorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1700
|
+
#
|
|
1701
|
+
# * {Types::ListConnectorsResponse#connectors #connectors} => Array<Types::ConnectorDetail>
|
|
1702
|
+
# * {Types::ListConnectorsResponse#next_token #next_token} => String
|
|
1703
|
+
#
|
|
1704
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
1705
|
+
#
|
|
1706
|
+
# @example Request syntax with placeholder values
|
|
1707
|
+
#
|
|
1708
|
+
# resp = client.list_connectors({
|
|
1709
|
+
# max_results: 1,
|
|
1710
|
+
# next_token: "NextToken",
|
|
1711
|
+
# })
|
|
1712
|
+
#
|
|
1713
|
+
# @example Response structure
|
|
1714
|
+
#
|
|
1715
|
+
# resp.connectors #=> Array
|
|
1716
|
+
# resp.connectors[0].connector_description #=> String
|
|
1717
|
+
# resp.connectors[0].connector_name #=> String
|
|
1718
|
+
# resp.connectors[0].connector_owner #=> String
|
|
1719
|
+
# resp.connectors[0].connector_version #=> String
|
|
1720
|
+
# resp.connectors[0].application_type #=> String
|
|
1721
|
+
# 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"
|
|
1722
|
+
# resp.connectors[0].connector_label #=> String
|
|
1723
|
+
# resp.connectors[0].registered_at #=> Time
|
|
1724
|
+
# resp.connectors[0].registered_by #=> String
|
|
1725
|
+
# resp.connectors[0].connector_provisioning_type #=> String, one of "LAMBDA"
|
|
1726
|
+
# resp.connectors[0].connector_modes #=> Array
|
|
1727
|
+
# resp.connectors[0].connector_modes[0] #=> String
|
|
1728
|
+
# resp.next_token #=> String
|
|
1729
|
+
#
|
|
1730
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/ListConnectors AWS API Documentation
|
|
1731
|
+
#
|
|
1732
|
+
# @overload list_connectors(params = {})
|
|
1733
|
+
# @param [Hash] params ({})
|
|
1734
|
+
def list_connectors(params = {}, options = {})
|
|
1735
|
+
req = build_request(:list_connectors, params)
|
|
1736
|
+
req.send_request(options)
|
|
1737
|
+
end
|
|
1738
|
+
|
|
1396
1739
|
# Lists all of the flows associated with your account.
|
|
1397
1740
|
#
|
|
1398
1741
|
# @option params [Integer] :max_results
|
|
@@ -1423,8 +1766,10 @@ module Aws::Appflow
|
|
|
1423
1766
|
# resp.flows[0].description #=> String
|
|
1424
1767
|
# resp.flows[0].flow_name #=> String
|
|
1425
1768
|
# resp.flows[0].flow_status #=> String, one of "Active", "Deprecated", "Deleted", "Draft", "Errored", "Suspended"
|
|
1426
|
-
# 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"
|
|
1427
|
-
# resp.flows[0].
|
|
1769
|
+
# 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"
|
|
1770
|
+
# resp.flows[0].source_connector_label #=> String
|
|
1771
|
+
# 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"
|
|
1772
|
+
# resp.flows[0].destination_connector_label #=> String
|
|
1428
1773
|
# resp.flows[0].trigger_type #=> String, one of "Scheduled", "Event", "OnDemand"
|
|
1429
1774
|
# resp.flows[0].created_at #=> Time
|
|
1430
1775
|
# resp.flows[0].last_updated_at #=> Time
|
|
@@ -1475,6 +1820,55 @@ module Aws::Appflow
|
|
|
1475
1820
|
req.send_request(options)
|
|
1476
1821
|
end
|
|
1477
1822
|
|
|
1823
|
+
# Registers a new connector with your Amazon Web Services account.
|
|
1824
|
+
# Before you can register the connector, you must deploy lambda in your
|
|
1825
|
+
# account.
|
|
1826
|
+
#
|
|
1827
|
+
# @option params [String] :connector_label
|
|
1828
|
+
# The name of the connector. The name is unique for each
|
|
1829
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
|
1830
|
+
#
|
|
1831
|
+
# @option params [String] :description
|
|
1832
|
+
# A description about the connector that's being registered.
|
|
1833
|
+
#
|
|
1834
|
+
# @option params [String] :connector_provisioning_type
|
|
1835
|
+
# The provisioning type of the connector. Currently the only supported
|
|
1836
|
+
# value is LAMBDA.
|
|
1837
|
+
#
|
|
1838
|
+
# @option params [Types::ConnectorProvisioningConfig] :connector_provisioning_config
|
|
1839
|
+
# The provisioning type of the connector. Currently the only supported
|
|
1840
|
+
# value is LAMBDA.
|
|
1841
|
+
#
|
|
1842
|
+
# @return [Types::RegisterConnectorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1843
|
+
#
|
|
1844
|
+
# * {Types::RegisterConnectorResponse#connector_arn #connector_arn} => String
|
|
1845
|
+
#
|
|
1846
|
+
# @example Request syntax with placeholder values
|
|
1847
|
+
#
|
|
1848
|
+
# resp = client.register_connector({
|
|
1849
|
+
# connector_label: "ConnectorLabel",
|
|
1850
|
+
# description: "Description",
|
|
1851
|
+
# connector_provisioning_type: "LAMBDA", # accepts LAMBDA
|
|
1852
|
+
# connector_provisioning_config: {
|
|
1853
|
+
# lambda: {
|
|
1854
|
+
# lambda_arn: "ARN", # required
|
|
1855
|
+
# },
|
|
1856
|
+
# },
|
|
1857
|
+
# })
|
|
1858
|
+
#
|
|
1859
|
+
# @example Response structure
|
|
1860
|
+
#
|
|
1861
|
+
# resp.connector_arn #=> String
|
|
1862
|
+
#
|
|
1863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/RegisterConnector AWS API Documentation
|
|
1864
|
+
#
|
|
1865
|
+
# @overload register_connector(params = {})
|
|
1866
|
+
# @param [Hash] params ({})
|
|
1867
|
+
def register_connector(params = {}, options = {})
|
|
1868
|
+
req = build_request(:register_connector, params)
|
|
1869
|
+
req.send_request(options)
|
|
1870
|
+
end
|
|
1871
|
+
|
|
1478
1872
|
# Activates an existing flow. For on-demand flows, this operation runs
|
|
1479
1873
|
# the flow immediately. For schedule and event-triggered flows, this
|
|
1480
1874
|
# operation activates the flow.
|
|
@@ -1571,6 +1965,36 @@ module Aws::Appflow
|
|
|
1571
1965
|
req.send_request(options)
|
|
1572
1966
|
end
|
|
1573
1967
|
|
|
1968
|
+
# Unregisters the custom connector registered in your account that
|
|
1969
|
+
# matches the connectorLabel provided in the request.
|
|
1970
|
+
#
|
|
1971
|
+
# @option params [required, String] :connector_label
|
|
1972
|
+
# The label of the connector. The label is unique for each
|
|
1973
|
+
# `ConnectorRegistration` in your Amazon Web Services account.
|
|
1974
|
+
#
|
|
1975
|
+
# @option params [Boolean] :force_delete
|
|
1976
|
+
# Indicates whether Amazon AppFlow should unregister the connector, even
|
|
1977
|
+
# if it is currently in use in one or more connector profiles. The
|
|
1978
|
+
# default value is false.
|
|
1979
|
+
#
|
|
1980
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
|
1981
|
+
#
|
|
1982
|
+
# @example Request syntax with placeholder values
|
|
1983
|
+
#
|
|
1984
|
+
# resp = client.unregister_connector({
|
|
1985
|
+
# connector_label: "ConnectorLabel", # required
|
|
1986
|
+
# force_delete: false,
|
|
1987
|
+
# })
|
|
1988
|
+
#
|
|
1989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/UnregisterConnector AWS API Documentation
|
|
1990
|
+
#
|
|
1991
|
+
# @overload unregister_connector(params = {})
|
|
1992
|
+
# @param [Hash] params ({})
|
|
1993
|
+
def unregister_connector(params = {}, options = {})
|
|
1994
|
+
req = build_request(:unregister_connector, params)
|
|
1995
|
+
req.send_request(options)
|
|
1996
|
+
end
|
|
1997
|
+
|
|
1574
1998
|
# Removes a tag from the specified flow.
|
|
1575
1999
|
#
|
|
1576
2000
|
# @option params [required, String] :resource_arn
|
|
@@ -1687,6 +2111,15 @@ module Aws::Appflow
|
|
|
1687
2111
|
# o_auth_scopes: ["OAuthScope"], # required
|
|
1688
2112
|
# },
|
|
1689
2113
|
# },
|
|
2114
|
+
# custom_connector: {
|
|
2115
|
+
# profile_properties: {
|
|
2116
|
+
# "ProfilePropertyKey" => "ProfilePropertyValue",
|
|
2117
|
+
# },
|
|
2118
|
+
# o_auth_2_properties: {
|
|
2119
|
+
# token_url: "TokenUrl", # required
|
|
2120
|
+
# o_auth_2_grant_type: "CLIENT_CREDENTIALS", # required, accepts CLIENT_CREDENTIALS, AUTHORIZATION_CODE
|
|
2121
|
+
# },
|
|
2122
|
+
# },
|
|
1690
2123
|
# },
|
|
1691
2124
|
# connector_profile_credentials: { # required
|
|
1692
2125
|
# amplitude: {
|
|
@@ -1798,6 +2231,33 @@ module Aws::Appflow
|
|
|
1798
2231
|
# },
|
|
1799
2232
|
# },
|
|
1800
2233
|
# },
|
|
2234
|
+
# custom_connector: {
|
|
2235
|
+
# authentication_type: "OAUTH2", # required, accepts OAUTH2, APIKEY, BASIC, CUSTOM
|
|
2236
|
+
# basic: {
|
|
2237
|
+
# username: "Username", # required
|
|
2238
|
+
# password: "Password", # required
|
|
2239
|
+
# },
|
|
2240
|
+
# oauth2: {
|
|
2241
|
+
# client_id: "ClientId",
|
|
2242
|
+
# client_secret: "ClientSecret",
|
|
2243
|
+
# access_token: "AccessToken",
|
|
2244
|
+
# refresh_token: "RefreshToken",
|
|
2245
|
+
# o_auth_request: {
|
|
2246
|
+
# auth_code: "AuthCode",
|
|
2247
|
+
# redirect_uri: "RedirectUri",
|
|
2248
|
+
# },
|
|
2249
|
+
# },
|
|
2250
|
+
# api_key: {
|
|
2251
|
+
# api_key: "ApiKey", # required
|
|
2252
|
+
# api_secret_key: "ApiSecretKey",
|
|
2253
|
+
# },
|
|
2254
|
+
# custom: {
|
|
2255
|
+
# custom_authentication_type: "CustomAuthenticationType", # required
|
|
2256
|
+
# credentials_map: {
|
|
2257
|
+
# "CredentialsMapKey" => "CredentialsMapValue",
|
|
2258
|
+
# },
|
|
2259
|
+
# },
|
|
2260
|
+
# },
|
|
1801
2261
|
# },
|
|
1802
2262
|
# },
|
|
1803
2263
|
# })
|
|
@@ -1863,7 +2323,8 @@ module Aws::Appflow
|
|
|
1863
2323
|
# },
|
|
1864
2324
|
# },
|
|
1865
2325
|
# source_flow_config: { # required
|
|
1866
|
-
# 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
|
|
2326
|
+
# 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
|
|
2327
|
+
# api_version: "ApiVersion",
|
|
1867
2328
|
# connector_profile_name: "ConnectorProfileName",
|
|
1868
2329
|
# source_connector_properties: { # required
|
|
1869
2330
|
# amplitude: {
|
|
@@ -1921,6 +2382,12 @@ module Aws::Appflow
|
|
|
1921
2382
|
# sapo_data: {
|
|
1922
2383
|
# object_path: "Object",
|
|
1923
2384
|
# },
|
|
2385
|
+
# custom_connector: {
|
|
2386
|
+
# entity_name: "EntityName", # required
|
|
2387
|
+
# custom_properties: {
|
|
2388
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
2389
|
+
# },
|
|
2390
|
+
# },
|
|
1924
2391
|
# },
|
|
1925
2392
|
# incremental_pull_config: {
|
|
1926
2393
|
# datetime_type_field_name: "DatetimeTypeFieldName",
|
|
@@ -1928,7 +2395,8 @@ module Aws::Appflow
|
|
|
1928
2395
|
# },
|
|
1929
2396
|
# destination_flow_config_list: [ # required
|
|
1930
2397
|
# {
|
|
1931
|
-
# 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
|
|
2398
|
+
# 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
|
|
2399
|
+
# api_version: "ApiVersion",
|
|
1932
2400
|
# connector_profile_name: "ConnectorProfileName",
|
|
1933
2401
|
# destination_connector_properties: { # required
|
|
1934
2402
|
# redshift: {
|
|
@@ -1963,7 +2431,7 @@ module Aws::Appflow
|
|
|
1963
2431
|
# bucket_prefix: "BucketPrefix",
|
|
1964
2432
|
# bucket_name: "BucketName",
|
|
1965
2433
|
# },
|
|
1966
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
2434
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
1967
2435
|
# },
|
|
1968
2436
|
# snowflake: {
|
|
1969
2437
|
# object: "Object", # required
|
|
@@ -2019,7 +2487,20 @@ module Aws::Appflow
|
|
|
2019
2487
|
# bucket_prefix: "BucketPrefix",
|
|
2020
2488
|
# bucket_name: "BucketName",
|
|
2021
2489
|
# },
|
|
2022
|
-
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE
|
|
2490
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
2491
|
+
# },
|
|
2492
|
+
# custom_connector: {
|
|
2493
|
+
# entity_name: "EntityName", # required
|
|
2494
|
+
# error_handling_config: {
|
|
2495
|
+
# fail_on_first_destination_error: false,
|
|
2496
|
+
# bucket_prefix: "BucketPrefix",
|
|
2497
|
+
# bucket_name: "BucketName",
|
|
2498
|
+
# },
|
|
2499
|
+
# write_operation_type: "INSERT", # accepts INSERT, UPSERT, UPDATE, DELETE
|
|
2500
|
+
# id_field_names: ["Name"],
|
|
2501
|
+
# custom_properties: {
|
|
2502
|
+
# "CustomPropertyKey" => "CustomPropertyValue",
|
|
2503
|
+
# },
|
|
2023
2504
|
# },
|
|
2024
2505
|
# },
|
|
2025
2506
|
# },
|
|
@@ -2043,6 +2524,7 @@ module Aws::Appflow
|
|
|
2043
2524
|
# 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
|
|
2044
2525
|
# 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
|
|
2045
2526
|
# 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
|
|
2527
|
+
# 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
|
|
2046
2528
|
# },
|
|
2047
2529
|
# destination_field: "DestinationField",
|
|
2048
2530
|
# task_type: "Arithmetic", # required, accepts Arithmetic, Filter, Map, Map_all, Mask, Merge, Truncate, Validate
|
|
@@ -2079,7 +2561,7 @@ module Aws::Appflow
|
|
|
2079
2561
|
params: params,
|
|
2080
2562
|
config: config)
|
|
2081
2563
|
context[:gem_name] = 'aws-sdk-appflow'
|
|
2082
|
-
context[:gem_version] = '1.
|
|
2564
|
+
context[:gem_version] = '1.21.0'
|
|
2083
2565
|
Seahorse::Client::Request.new(handlers, context)
|
|
2084
2566
|
end
|
|
2085
2567
|
|