Skip to content
AWS for Query.Farm

aws.appflow.describe_connector_profiles

Example SQL Queries

SELECT * FROM
aws.appflow.describe_connector_profiles;

Description

Returns a list of connector-profile details matching the provided connector-profile names and connector-types. Both input lists are optional, and you can use them to filter the result.

If no names or connector-types are provided, returns all connector profiles in a paginated form. If there is no match, this operation returns an empty list.

Table Definition

Column NameColumn Data Type
connector_label Input Column

The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.

VARCHAR
connector_profile_names Input Column

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account. 

VARCHAR[]
Show child fields
connector_profile_names[]
connector_type Input Column

The type of connector, such as Salesforce, Amplitude, and so on. 

VARCHAR
max_results Input Column

Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations). 

BIGINT
next_token Input Column

The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched. 

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_profile_details

Returns information about the connector profiles associated with the flow. 

STRUCT(
    "connector_profile_arn" VARCHAR,
    "connector_profile_name" VARCHAR,
    "connector_type" VARCHAR,
    "connector_label" VARCHAR,
    "connection_mode" VARCHAR,
    "credentials_arn" VARCHAR,
    "connector_profile_properties" STRUCT(
        "amplitude" BOOLEAN,
        "datadog" STRUCT(
            "instance_url" VARCHAR
        ),
        "dynatrace" STRUCT(
            "instance_url" VARCHAR
        ),
        "google_analytics" BOOLEAN,
        "honeycode" BOOLEAN,
        "infor_nexus" STRUCT(
            "instance_url" VARCHAR
        ),
        "marketo" STRUCT(
            "instance_url" VARCHAR
        ),
        "redshift" STRUCT(
            "database_url" VARCHAR,
            "bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "role_arn" VARCHAR,
            "data_api_role_arn" VARCHAR,
            "is_redshift_serverless" BOOLEAN,
            "cluster_identifier" VARCHAR,
            "workgroup_name" VARCHAR,
            "database_name" VARCHAR
        ),
        "salesforce" STRUCT(
            "instance_url" VARCHAR,
            "is_sandbox_environment" BOOLEAN,
            "use_private_link_for_metadata_and_authorization" BOOLEAN
        ),
        "service_now" STRUCT(
            "instance_url" VARCHAR
        ),
        "singular" BOOLEAN,
        "slack" STRUCT(
            "instance_url" VARCHAR
        ),
        "snowflake" STRUCT(
            "warehouse" VARCHAR,
            "stage" VARCHAR,
            "bucket_name" VARCHAR,
            "bucket_prefix" VARCHAR,
            "private_link_service_name" VARCHAR,
            "account_name" VARCHAR,
            "region" VARCHAR
        ),
        "trendmicro" BOOLEAN,
        "veeva" STRUCT(
            "instance_url" VARCHAR
        ),
        "zendesk" STRUCT(
            "instance_url" VARCHAR
        ),
        "sapo_data" STRUCT(
            "application_host_url" VARCHAR,
            "application_service_path" VARCHAR,
            "port_number" BIGINT,
            "client_number" VARCHAR,
            "logon_language" VARCHAR,
            "private_link_service_name" VARCHAR,
            "o_auth_properties" STRUCT(
                "token_url" VARCHAR,
                "auth_code_url" VARCHAR,
                "o_auth_scopes" VARCHAR[]
            ),
            "disable_sso" BOOLEAN
        ),
        "custom_connector" STRUCT(
            "profile_properties" MAP(VARCHAR, VARCHAR),
            "o_auth2_properties" STRUCT(
                "token_url" VARCHAR,
                "o_auth2_grant_type" VARCHAR,
                "token_url_custom_properties" MAP(VARCHAR, VARCHAR)
            )
        ),
        "pardot" STRUCT(
            "instance_url" VARCHAR,
            "is_sandbox_environment" BOOLEAN,
            "business_unit_id" VARCHAR
        )
    ),
    "created_at" TIMESTAMP_S,
    "last_updated_at" TIMESTAMP_S,
    "private_connection_provisioning_state" STRUCT(
        "status" VARCHAR,
        "failure_message" VARCHAR,
        "failure_cause" VARCHAR
    )
)[]
Show child fields
connector_profile_details[]
Show child fields
connector_profile_details[].connection_mode

Indicates the connection mode and if it is public or private.

connector_profile_details[].connector_label

The label for the connector profile being created.

connector_profile_details[].connector_profile_arn

The Amazon Resource Name (ARN) of the connector profile.

connector_profile_details[].connector_profile_name

The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account.

connector_profile_details[].connector_profile_properties

The connector-specific properties of the profile configuration.

Show child fields
connector_profile_details[].connector_profile_properties.amplitude

The connector-specific properties required by Amplitude.

connector_profile_details[].connector_profile_properties.custom_connector

The properties required by the custom connector.

Show child fields
connector_profile_details[].connector_profile_properties.custom_connector.o_auth2_properties

The OAuth 2.0 properties required for OAuth 2.0 authentication.

Show child fields
connector_profile_details[].connector_profile_properties.custom_connector.o_auth2_properties.o_auth2_grant_type

The OAuth 2.0 grant type used by connector for OAuth 2.0 authentication.

connector_profile_details[].connector_profile_properties.custom_connector.o_auth2_properties.token_url

The token URL required for OAuth 2.0 authentication.

connector_profile_details[].connector_profile_properties.custom_connector.o_auth2_properties.token_url_custom_properties

Associates your token URL with a map of properties that you define. Use this parameter to provide any additional details that the connector requires to authenticate your request.

connector_profile_details[].connector_profile_properties.custom_connector.profile_properties

A map of properties that are required to create a profile for the custom connector.

connector_profile_details[].connector_profile_properties.datadog

The connector-specific properties required by Datadog.

Show child fields
connector_profile_details[].connector_profile_properties.datadog.instance_url

The location of the Datadog resource.

connector_profile_details[].connector_profile_properties.dynatrace

The connector-specific properties required by Dynatrace.

Show child fields
connector_profile_details[].connector_profile_properties.dynatrace.instance_url

The location of the Dynatrace resource.

connector_profile_details[].connector_profile_properties.google_analytics

The connector-specific properties required Google Analytics.

connector_profile_details[].connector_profile_properties.honeycode

The connector-specific properties required by Amazon Honeycode.

connector_profile_details[].connector_profile_properties.infor_nexus

The connector-specific properties required by Infor Nexus.

Show child fields
connector_profile_details[].connector_profile_properties.infor_nexus.instance_url

The location of the Infor Nexus resource.

connector_profile_details[].connector_profile_properties.marketo

The connector-specific properties required by Marketo.

Show child fields
connector_profile_details[].connector_profile_properties.marketo.instance_url

The location of the Marketo resource.

connector_profile_details[].connector_profile_properties.pardot

The connector-specific properties required by Salesforce Pardot.

Show child fields
connector_profile_details[].connector_profile_properties.pardot.business_unit_id

The business unit id of Salesforce Pardot instance.

connector_profile_details[].connector_profile_properties.pardot.instance_url

The location of the Salesforce Pardot resource.

connector_profile_details[].connector_profile_properties.pardot.is_sandbox_environment

Indicates whether the connector profile applies to a sandbox or production environment.

connector_profile_details[].connector_profile_properties.redshift

The connector-specific properties required by Amazon Redshift.

Show child fields
connector_profile_details[].connector_profile_properties.redshift.bucket_name

A name for the associated Amazon S3 bucket.

connector_profile_details[].connector_profile_properties.redshift.bucket_prefix

The object key for the destination bucket in which Amazon AppFlow places the files.

connector_profile_details[].connector_profile_properties.redshift.cluster_identifier

The unique ID that's assigned to an Amazon Redshift cluster.

connector_profile_details[].connector_profile_properties.redshift.data_api_role_arn

The Amazon Resource Name (ARN) of an IAM role that permits Amazon AppFlow to access your Amazon Redshift database through the Data API. For more information, and for the polices that you attach to this role, see Allow Amazon AppFlow to access Amazon Redshift databases with the Data API.

connector_profile_details[].connector_profile_properties.redshift.database_name

The name of an Amazon Redshift database.

connector_profile_details[].connector_profile_properties.redshift.database_url

The JDBC URL of the Amazon Redshift cluster.

connector_profile_details[].connector_profile_properties.redshift.is_redshift_serverless

Indicates whether the connector profile defines a connection to an Amazon Redshift Serverless data warehouse.

connector_profile_details[].connector_profile_properties.redshift.role_arn

The Amazon Resource Name (ARN) of IAM role that grants Amazon Redshift read-only access to Amazon S3. For more information, and for the polices that you attach to this role, see Allow Amazon Redshift to access your Amazon AppFlow data in Amazon S3.

connector_profile_details[].connector_profile_properties.redshift.workgroup_name

The name of an Amazon Redshift workgroup.

connector_profile_details[].connector_profile_properties.salesforce

The connector-specific properties required by Salesforce.

Show child fields
connector_profile_details[].connector_profile_properties.salesforce.instance_url

The location of the Salesforce resource.

connector_profile_details[].connector_profile_properties.salesforce.is_sandbox_environment

Indicates whether the connector profile applies to a sandbox or production environment.

connector_profile_details[].connector_profile_properties.salesforce.use_private_link_for_metadata_and_authorization

If the connection mode for the connector profile is private, this parameter sets whether Amazon AppFlow uses the private network to send metadata and authorization calls to Salesforce. Amazon AppFlow sends private calls through Amazon Web Services PrivateLink. These calls travel through Amazon Web Services infrastructure without being exposed to the public internet.

Set either of the following values:

true

Amazon AppFlow sends all calls to Salesforce over the private network.

These private calls are:

  • Calls to get metadata about your Salesforce records. This metadata describes your Salesforce objects and their fields.

  • Calls to get or refresh access tokens that allow Amazon AppFlow to access your Salesforce records.

  • Calls to transfer your Salesforce records as part of a flow run.

false

The default value. Amazon AppFlow sends some calls to Salesforce privately and other calls over the public internet.

The public calls are:

  • Calls to get metadata about your Salesforce records.

  • Calls to get or refresh access tokens.

The private calls are:

  • Calls to transfer your Salesforce records as part of a flow run.

connector_profile_details[].connector_profile_properties.sapo_data

The connector-specific profile properties required when using SAPOData.

Show child fields
connector_profile_details[].connector_profile_properties.sapo_data.application_host_url

The location of the SAPOData resource.

connector_profile_details[].connector_profile_properties.sapo_data.application_service_path

The application path to catalog service.

connector_profile_details[].connector_profile_properties.sapo_data.client_number

The client number for the client creating the connection.

connector_profile_details[].connector_profile_properties.sapo_data.disable_sso

If you set this parameter to true, Amazon AppFlow bypasses the single sign-on (SSO) settings in your SAP account when it accesses your SAP OData instance.

Whether you need this option depends on the types of credentials that you applied to your SAP OData connection profile. If your profile uses basic authentication credentials, SAP SSO can prevent Amazon AppFlow from connecting to your account with your username and password. In this case, bypassing SSO makes it possible for Amazon AppFlow to connect successfully. However, if your profile uses OAuth credentials, this parameter has no affect.

connector_profile_details[].connector_profile_properties.sapo_data.logon_language

The logon language of SAPOData instance.

connector_profile_details[].connector_profile_properties.sapo_data.o_auth_properties

The SAPOData OAuth properties required for OAuth type authentication.

Show child fields
connector_profile_details[].connector_profile_properties.sapo_data.o_auth_properties.auth_code_url

The authorization code url required to redirect to SAP Login Page to fetch authorization code for OAuth type authentication.

connector_profile_details[].connector_profile_properties.sapo_data.o_auth_properties.o_auth_scopes[]
connector_profile_details[].connector_profile_properties.sapo_data.o_auth_properties.token_url

The token url required to fetch access/refresh tokens using authorization code and also to refresh expired access token using refresh token.

connector_profile_details[].connector_profile_properties.sapo_data.port_number

The port number of the SAPOData instance.

connector_profile_details[].connector_profile_properties.sapo_data.private_link_service_name

The SAPOData Private Link service name to be used for private data transfers.

connector_profile_details[].connector_profile_properties.service_now

The connector-specific properties required by serviceNow.

Show child fields
connector_profile_details[].connector_profile_properties.service_now.instance_url

The location of the ServiceNow resource.

connector_profile_details[].connector_profile_properties.singular

The connector-specific properties required by Singular.

connector_profile_details[].connector_profile_properties.slack

The connector-specific properties required by Slack.

Show child fields
connector_profile_details[].connector_profile_properties.slack.instance_url

The location of the Slack resource.

connector_profile_details[].connector_profile_properties.snowflake

The connector-specific properties required by Snowflake.

Show child fields
connector_profile_details[].connector_profile_properties.snowflake.account_name

The name of the account.

connector_profile_details[].connector_profile_properties.snowflake.bucket_name

The name of the Amazon S3 bucket associated with Snowflake.

connector_profile_details[].connector_profile_properties.snowflake.bucket_prefix

The bucket path that refers to the Amazon S3 bucket associated with Snowflake.

connector_profile_details[].connector_profile_properties.snowflake.private_link_service_name

The Snowflake Private Link service name to be used for private data transfers.

connector_profile_details[].connector_profile_properties.snowflake.region

The Amazon Web Services Region of the Snowflake account.

connector_profile_details[].connector_profile_properties.snowflake.stage

The name of the Amazon S3 stage that was created while setting up an Amazon S3 stage in the Snowflake account. This is written in the following format: < Database>< Schema><Stage Name>.

connector_profile_details[].connector_profile_properties.snowflake.warehouse

The name of the Snowflake warehouse.

connector_profile_details[].connector_profile_properties.trendmicro

The connector-specific properties required by Trend Micro.

connector_profile_details[].connector_profile_properties.veeva

The connector-specific properties required by Veeva.

Show child fields
connector_profile_details[].connector_profile_properties.veeva.instance_url

The location of the Veeva resource.

connector_profile_details[].connector_profile_properties.zendesk

The connector-specific properties required by Zendesk.

Show child fields
connector_profile_details[].connector_profile_properties.zendesk.instance_url

The location of the Zendesk resource.

connector_profile_details[].connector_type

The type of connector, such as Salesforce, Amplitude, and so on.

connector_profile_details[].created_at

Specifies when the connector profile was created.

connector_profile_details[].credentials_arn

The Amazon Resource Name (ARN) of the connector profile credentials.

connector_profile_details[].last_updated_at

Specifies when the connector profile was last updated.

connector_profile_details[].private_connection_provisioning_state

Specifies the private connection provisioning state.

Show child fields
connector_profile_details[].private_connection_provisioning_state.failure_cause

Specifies the private connection provisioning failure cause.

connector_profile_details[].private_connection_provisioning_state.failure_message

Specifies the private connection provisioning failure reason.

connector_profile_details[].private_connection_provisioning_state.status

Specifies the private connection provisioning status.