aws.appflow.describe_connector

Example SQL Queries

SELECT * FROM
aws.appflow.describe_connector
WHERE
"connector_type" = 'VALUE';

Description

Describes the given custom connector registered in your Amazon Web Services account. This API can be used for custom connectors that are registered in your account and also for Amazon authored connectors.

• View All Appflow Tables
• Boto3 Reference

Table Definition

Column Name	Column Data Type
connector_type Required Input Column The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.	VARCHAR
connector_label Input Column The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.	VARCHAR
_aws_profile Input Column The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.	STRUCT( "type" VARCHAR, "name" VARCHAR, "account_id" VARCHAR, "via_profile_name" VARCHAR, "assumed_role_arn" VARCHAR, "organization" STRUCT( "account_name" VARCHAR, "id" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[], "master_account" STRUCT( "id" VARCHAR, "email" VARCHAR ), "parents" STRUCT( "type" VARCHAR, "id" VARCHAR, "name" VARCHAR, "tags" STRUCT( "key" VARCHAR, "value" VARCHAR )[] )[] ) )
Show child fields _aws_profile.account_id The AWS account id _aws_profile.assumed_role_arn The ARN of the assumed role _aws_profile.name The unique name of the profile. _aws_profile.organization Information about this profile's membership in the AWS organization. Show child fields _aws_profile.organization.account_name The name of account speciifed by the organization _aws_profile.organization.id The organization id _aws_profile.organization.master_account Show child fields _aws_profile.organization.master_account.email The organization master account email address _aws_profile.organization.master_account.id The organization master account id _aws_profile.organization.parents[] Show child fields _aws_profile.organization.parents[].id The id of the parent _aws_profile.organization.parents[].name The name of the parent _aws_profile.organization.parents[].tags[] Show child fields _aws_profile.organization.parents[].tags[].key _aws_profile.organization.parents[].tags[].value _aws_profile.organization.parents[].type The type of parent can be an organization unit or a root _aws_profile.organization.tags[] Show child fields _aws_profile.organization.tags[].key _aws_profile.organization.tags[].value _aws_profile.type The type of profile, either 'credentials' or 'assumed_role' _aws_profile.via_profile_name This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
_aws_region Input Column The AWS region to use.	VARCHAR
connector_configuration Configuration info of all the connectors that the user requested.	STRUCT( "can_use_as_source" BOOLEAN, "can_use_as_destination" BOOLEAN, "supported_destination_connectors" VARCHAR[], "supported_scheduling_frequencies" VARCHAR[], "is_private_link_enabled" BOOLEAN, "is_private_link_endpoint_url_required" BOOLEAN, "supported_trigger_types" VARCHAR[], "connector_metadata" STRUCT( "amplitude" BOOLEAN, "datadog" BOOLEAN, "dynatrace" BOOLEAN, "google_analytics" STRUCT( "o_auth_scopes" VARCHAR[] ), "infor_nexus" BOOLEAN, "marketo" BOOLEAN, "redshift" BOOLEAN, "s3" BOOLEAN, "salesforce" STRUCT( "o_auth_scopes" VARCHAR[], "data_transfer_apis" VARCHAR[], "oauth2_grant_types_supported" VARCHAR[] ), "service_now" BOOLEAN, "singular" BOOLEAN, "slack" STRUCT( "o_auth_scopes" VARCHAR[] ), "snowflake" STRUCT( "supported_regions" VARCHAR[] ), "trendmicro" BOOLEAN, "veeva" BOOLEAN, "zendesk" STRUCT( "o_auth_scopes" VARCHAR[] ), "event_bridge" BOOLEAN, "upsolver" BOOLEAN, "customer_profiles" BOOLEAN, "honeycode" STRUCT( "o_auth_scopes" VARCHAR[] ), "sapo_data" BOOLEAN, "pardot" BOOLEAN ), "connector_type" VARCHAR, "connector_label" VARCHAR, "connector_description" VARCHAR, "connector_owner" VARCHAR, "connector_name" VARCHAR, "connector_version" VARCHAR, "connector_arn" VARCHAR, "connector_modes" VARCHAR[], "authentication_config" STRUCT( "is_basic_auth_supported" BOOLEAN, "is_api_key_auth_supported" BOOLEAN, "is_o_auth2_supported" BOOLEAN, "is_custom_auth_supported" BOOLEAN, "o_auth2_defaults" STRUCT( "oauth_scopes" VARCHAR[], "token_urls" VARCHAR[], "auth_code_urls" VARCHAR[], "oauth2_grant_types_supported" VARCHAR[], "oauth2_custom_properties" STRUCT( "key" VARCHAR, "is_required" BOOLEAN, "label" VARCHAR, "description" VARCHAR, "is_sensitive_field" BOOLEAN, "connector_supplied_values" VARCHAR[], "type" VARCHAR )[] ), "custom_auth_configs" STRUCT( "custom_authentication_type" VARCHAR, "auth_parameters" STRUCT( "key" VARCHAR, "is_required" BOOLEAN, "label" VARCHAR, "description" VARCHAR, "is_sensitive_field" BOOLEAN, "connector_supplied_values" VARCHAR[] )[] )[] ), "connector_runtime_settings" STRUCT( "key" VARCHAR, "data_type" VARCHAR, "is_required" BOOLEAN, "label" VARCHAR, "description" VARCHAR, "scope" VARCHAR, "connector_supplied_value_options" VARCHAR[] )[], "supported_api_versions" VARCHAR[], "supported_operators" VARCHAR[], "supported_write_operations" VARCHAR[], "connector_provisioning_type" VARCHAR, "connector_provisioning_config" STRUCT( "lambda" STRUCT( "lambda_arn" VARCHAR ) ), "logo_url" VARCHAR, "registered_at" TIMESTAMP_S, "registered_by" VARCHAR, "supported_data_transfer_types" VARCHAR[], "supported_data_transfer_apis" STRUCT( "name" VARCHAR, "type" VARCHAR )[] )
Show child fields connector_configuration.authentication_config The authentication config required for the connector. Show child fields connector_configuration.authentication_config.custom_auth_configs[] Show child fields connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[] Show child fields connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].connector_supplied_values[] connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].description A description about the authentication parameter. connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].is_required Indicates whether this authentication parameter is required. connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].is_sensitive_field Indicates whether this authentication parameter is a sensitive field. connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].key The authentication key required to authenticate with the connector. connector_configuration.authentication_config.custom_auth_configs[].auth_parameters[].label Label used for authentication parameter. connector_configuration.authentication_config.custom_auth_configs[].custom_authentication_type The authentication type that the custom connector uses. connector_configuration.authentication_config.is_api_key_auth_supported Indicates whether API key authentication is supported by the connector connector_configuration.authentication_config.is_basic_auth_supported Indicates whether basic authentication is supported by the connector. connector_configuration.authentication_config.is_custom_auth_supported Indicates whether custom authentication is supported by the connector connector_configuration.authentication_config.is_o_auth2_supported Indicates whether OAuth 2.0 authentication is supported by the connector. connector_configuration.authentication_config.o_auth2_defaults Contains the default values required for OAuth 2.0 authentication. Show child fields connector_configuration.authentication_config.o_auth2_defaults.auth_code_urls[] connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[] Show child fields connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].connector_supplied_values[] connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].description A description about the custom parameter used for OAuth 2.0 authentication. connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].is_required Indicates whether the custom parameter for OAuth 2.0 authentication is required. connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].is_sensitive_field Indicates whether this authentication custom parameter is a sensitive field. connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].key The key of the custom parameter required for OAuth 2.0 authentication. connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].label The label of the custom parameter used for OAuth 2.0 authentication. connector_configuration.authentication_config.o_auth2_defaults.oauth2_custom_properties[].type Indicates whether custom parameter is used with TokenUrl or AuthUrl. connector_configuration.authentication_config.o_auth2_defaults.oauth2_grant_types_supported[] connector_configuration.authentication_config.o_auth2_defaults.oauth_scopes[] connector_configuration.authentication_config.o_auth2_defaults.token_urls[] connector_configuration.can_use_as_destination Specifies whether the connector can be used as a destination. connector_configuration.can_use_as_source Specifies whether the connector can be used as a source. connector_configuration.connector_arn The Amazon Resource Name (ARN) for the registered connector. connector_configuration.connector_description A description about the connector. connector_configuration.connector_label The label used for registering the connector. connector_configuration.connector_metadata Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on. Show child fields connector_configuration.connector_metadata.amplitude The connector metadata specific to Amplitude. connector_configuration.connector_metadata.customer_profiles The connector metadata specific to Amazon Connect Customer Profiles. connector_configuration.connector_metadata.datadog The connector metadata specific to Datadog. connector_configuration.connector_metadata.dynatrace The connector metadata specific to Dynatrace. connector_configuration.connector_metadata.event_bridge The connector metadata specific to Amazon EventBridge. connector_configuration.connector_metadata.google_analytics The connector metadata specific to Google Analytics. Show child fields connector_configuration.connector_metadata.google_analytics.o_auth_scopes[] connector_configuration.connector_metadata.honeycode The connector metadata specific to Amazon Honeycode. Show child fields connector_configuration.connector_metadata.honeycode.o_auth_scopes[] connector_configuration.connector_metadata.infor_nexus The connector metadata specific to Infor Nexus. connector_configuration.connector_metadata.marketo The connector metadata specific to Marketo. connector_configuration.connector_metadata.pardot The connector metadata specific to Salesforce Pardot. connector_configuration.connector_metadata.redshift The connector metadata specific to Amazon Redshift. connector_configuration.connector_metadata.s3 The connector metadata specific to Amazon S3. connector_configuration.connector_metadata.salesforce The connector metadata specific to Salesforce. Show child fields connector_configuration.connector_metadata.salesforce.data_transfer_apis[] connector_configuration.connector_metadata.salesforce.o_auth_scopes[] connector_configuration.connector_metadata.salesforce.oauth2_grant_types_supported[] connector_configuration.connector_metadata.sapo_data The connector metadata specific to SAPOData. connector_configuration.connector_metadata.service_now The connector metadata specific to ServiceNow. connector_configuration.connector_metadata.singular The connector metadata specific to Singular. connector_configuration.connector_metadata.slack The connector metadata specific to Slack. Show child fields connector_configuration.connector_metadata.slack.o_auth_scopes[] connector_configuration.connector_metadata.snowflake The connector metadata specific to Snowflake. Show child fields connector_configuration.connector_metadata.snowflake.supported_regions[] connector_configuration.connector_metadata.trendmicro The connector metadata specific to Trend Micro. connector_configuration.connector_metadata.upsolver The connector metadata specific to Upsolver. connector_configuration.connector_metadata.veeva The connector metadata specific to Veeva. connector_configuration.connector_metadata.zendesk The connector metadata specific to Zendesk. Show child fields connector_configuration.connector_metadata.zendesk.o_auth_scopes[] connector_configuration.connector_modes[] connector_configuration.connector_name The connector name. connector_configuration.connector_owner The owner who developed the connector. connector_configuration.connector_provisioning_config The configuration required for registering the connector. Show child fields connector_configuration.connector_provisioning_config.lambda Contains information about the configuration of the lambda which is being registered as the connector. Show child fields connector_configuration.connector_provisioning_config.lambda.lambda_arn Lambda ARN of the connector being registered. connector_configuration.connector_provisioning_type The provisioning type used to register the connector. connector_configuration.connector_runtime_settings[] Show child fields connector_configuration.connector_runtime_settings[].connector_supplied_value_options[] connector_configuration.connector_runtime_settings[].data_type Data type of the connector runtime setting. connector_configuration.connector_runtime_settings[].description A description about the connector runtime setting. connector_configuration.connector_runtime_settings[].is_required Indicates whether this connector runtime setting is required. connector_configuration.connector_runtime_settings[].key Contains value information about the connector runtime setting. connector_configuration.connector_runtime_settings[].label A label used for connector runtime setting. connector_configuration.connector_runtime_settings[].scope Indicates the scope of the connector runtime setting. connector_configuration.connector_type The connector type. connector_configuration.connector_version The connector version. connector_configuration.is_private_link_enabled Specifies if PrivateLink is enabled for that connector. connector_configuration.is_private_link_endpoint_url_required Specifies if a PrivateLink endpoint URL is required. connector_configuration.logo_url Logo URL of the connector. connector_configuration.registered_at The date on which the connector was registered. connector_configuration.registered_by Information about who registered the connector. connector_configuration.supported_api_versions[] connector_configuration.supported_data_transfer_apis[] Show child fields connector_configuration.supported_data_transfer_apis[].name The name of the connector application API. connector_configuration.supported_data_transfer_apis[].type You can specify one of the following types: AUTOMATIC The default. Optimizes a flow for datasets that fluctuate in size from small to large. For each flow run, Amazon AppFlow chooses to use the SYNC or ASYNC API type based on the amount of data that the run transfers. SYNC A synchronous API. This type of API optimizes a flow for small to medium-sized datasets. ASYNC An asynchronous API. This type of API optimizes a flow for large datasets. connector_configuration.supported_data_transfer_types[] connector_configuration.supported_destination_connectors[] connector_configuration.supported_operators[] connector_configuration.supported_scheduling_frequencies[] connector_configuration.supported_trigger_types[] connector_configuration.supported_write_operations[]

Note

Tables may require input columns to have values specified before the table can return it’s rows. The values for input parameters are set in the where clause of the query typically using = or IN.