Appflow / Client / describe_connector_profiles

describe_connector_profiles#

Appflow.Client.describe_connector_profiles(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_connector_profiles(
    connectorProfileNames=[
        'string',
    ],
    connectorType='Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
    connectorLabel='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • connectorProfileNames (list) –

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

    • (string) –

  • connectorType (string) – The type of connector, such as Salesforce, Amplitude, and so on.

  • connectorLabel (string) – 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/.

  • maxResults (integer) – 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).

  • nextToken (string) – The pagination token for the next page of data.

Return type:

dict

Returns:

Response Syntax

{
    'connectorProfileDetails': [
        {
            'connectorProfileArn': 'string',
            'connectorProfileName': 'string',
            'connectorType': 'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
            'connectorLabel': 'string',
            'connectionMode': 'Public'|'Private',
            'credentialsArn': 'string',
            'connectorProfileProperties': {
                'Amplitude': {},
                'Datadog': {
                    'instanceUrl': 'string'
                },
                'Dynatrace': {
                    'instanceUrl': 'string'
                },
                'GoogleAnalytics': {},
                'Honeycode': {},
                'InforNexus': {
                    'instanceUrl': 'string'
                },
                'Marketo': {
                    'instanceUrl': 'string'
                },
                'Redshift': {
                    'databaseUrl': 'string',
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    'roleArn': 'string',
                    'dataApiRoleArn': 'string',
                    'isRedshiftServerless': True|False,
                    'clusterIdentifier': 'string',
                    'workgroupName': 'string',
                    'databaseName': 'string'
                },
                'Salesforce': {
                    'instanceUrl': 'string',
                    'isSandboxEnvironment': True|False,
                    'usePrivateLinkForMetadataAndAuthorization': True|False
                },
                'ServiceNow': {
                    'instanceUrl': 'string'
                },
                'Singular': {},
                'Slack': {
                    'instanceUrl': 'string'
                },
                'Snowflake': {
                    'warehouse': 'string',
                    'stage': 'string',
                    'bucketName': 'string',
                    'bucketPrefix': 'string',
                    'privateLinkServiceName': 'string',
                    'accountName': 'string',
                    'region': 'string'
                },
                'Trendmicro': {},
                'Veeva': {
                    'instanceUrl': 'string'
                },
                'Zendesk': {
                    'instanceUrl': 'string'
                },
                'SAPOData': {
                    'applicationHostUrl': 'string',
                    'applicationServicePath': 'string',
                    'portNumber': 123,
                    'clientNumber': 'string',
                    'logonLanguage': 'string',
                    'privateLinkServiceName': 'string',
                    'oAuthProperties': {
                        'tokenUrl': 'string',
                        'authCodeUrl': 'string',
                        'oAuthScopes': [
                            'string',
                        ]
                    },
                    'disableSSO': True|False
                },
                'CustomConnector': {
                    'profileProperties': {
                        'string': 'string'
                    },
                    'oAuth2Properties': {
                        'tokenUrl': 'string',
                        'oAuth2GrantType': 'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
                        'tokenUrlCustomProperties': {
                            'string': 'string'
                        }
                    }
                },
                'Pardot': {
                    'instanceUrl': 'string',
                    'isSandboxEnvironment': True|False,
                    'businessUnitId': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'privateConnectionProvisioningState': {
                'status': 'FAILED'|'PENDING'|'CREATED',
                'failureMessage': 'string',
                'failureCause': 'CONNECTOR_AUTHENTICATION'|'CONNECTOR_SERVER'|'INTERNAL_SERVER'|'ACCESS_DENIED'|'VALIDATION'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • connectorProfileDetails (list) –

      Returns information about the connector profiles associated with the flow.

      • (dict) –

        Describes an instance of a connector. This includes the provided name, credentials ARN, connection-mode, and so on. To keep the API intuitive and extensible, the fields that are common to all types of connector profiles are explicitly specified at the top level. The rest of the connector-specific properties are available via the connectorProfileProperties field.

        • connectorProfileArn (string) –

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

        • connectorProfileName (string) –

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

        • connectorType (string) –

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

        • connectorLabel (string) –

          The label for the connector profile being created.

        • connectionMode (string) –

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

        • credentialsArn (string) –

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

        • connectorProfileProperties (dict) –

          The connector-specific properties of the profile configuration.

          • Amplitude (dict) –

            The connector-specific properties required by Amplitude.

          • Datadog (dict) –

            The connector-specific properties required by Datadog.

            • instanceUrl (string) –

              The location of the Datadog resource.

          • Dynatrace (dict) –

            The connector-specific properties required by Dynatrace.

            • instanceUrl (string) –

              The location of the Dynatrace resource.

          • GoogleAnalytics (dict) –

            The connector-specific properties required Google Analytics.

          • Honeycode (dict) –

            The connector-specific properties required by Amazon Honeycode.

          • InforNexus (dict) –

            The connector-specific properties required by Infor Nexus.

            • instanceUrl (string) –

              The location of the Infor Nexus resource.

          • Marketo (dict) –

            The connector-specific properties required by Marketo.

            • instanceUrl (string) –

              The location of the Marketo resource.

          • Redshift (dict) –

            The connector-specific properties required by Amazon Redshift.

            • databaseUrl (string) –

              The JDBC URL of the Amazon Redshift cluster.

            • bucketName (string) –

              A name for the associated Amazon S3 bucket.

            • bucketPrefix (string) –

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

            • roleArn (string) –

              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.

            • dataApiRoleArn (string) –

              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.

            • isRedshiftServerless (boolean) –

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

            • clusterIdentifier (string) –

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

            • workgroupName (string) –

              The name of an Amazon Redshift workgroup.

            • databaseName (string) –

              The name of an Amazon Redshift database.

          • Salesforce (dict) –

            The connector-specific properties required by Salesforce.

            • instanceUrl (string) –

              The location of the Salesforce resource.

            • isSandboxEnvironment (boolean) –

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

            • usePrivateLinkForMetadataAndAuthorization (boolean) –

              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.

          • ServiceNow (dict) –

            The connector-specific properties required by serviceNow.

            • instanceUrl (string) –

              The location of the ServiceNow resource.

          • Singular (dict) –

            The connector-specific properties required by Singular.

          • Slack (dict) –

            The connector-specific properties required by Slack.

            • instanceUrl (string) –

              The location of the Slack resource.

          • Snowflake (dict) –

            The connector-specific properties required by Snowflake.

            • warehouse (string) –

              The name of the Snowflake warehouse.

            • stage (string) –

              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>.

            • bucketName (string) –

              The name of the Amazon S3 bucket associated with Snowflake.

            • bucketPrefix (string) –

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

            • privateLinkServiceName (string) –

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

            • accountName (string) –

              The name of the account.

            • region (string) –

              The Amazon Web Services Region of the Snowflake account.

          • Trendmicro (dict) –

            The connector-specific properties required by Trend Micro.

          • Veeva (dict) –

            The connector-specific properties required by Veeva.

            • instanceUrl (string) –

              The location of the Veeva resource.

          • Zendesk (dict) –

            The connector-specific properties required by Zendesk.

            • instanceUrl (string) –

              The location of the Zendesk resource.

          • SAPOData (dict) –

            The connector-specific profile properties required when using SAPOData.

            • applicationHostUrl (string) –

              The location of the SAPOData resource.

            • applicationServicePath (string) –

              The application path to catalog service.

            • portNumber (integer) –

              The port number of the SAPOData instance.

            • clientNumber (string) –

              The client number for the client creating the connection.

            • logonLanguage (string) –

              The logon language of SAPOData instance.

            • privateLinkServiceName (string) –

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

            • oAuthProperties (dict) –

              The SAPOData OAuth properties required for OAuth type authentication.

              • tokenUrl (string) –

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

              • authCodeUrl (string) –

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

              • oAuthScopes (list) –

                The OAuth scopes required for OAuth type authentication.

                • (string) –

            • disableSSO (boolean) –

              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.

          • CustomConnector (dict) –

            The properties required by the custom connector.

            • profileProperties (dict) –

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

              • (string) –

                • (string) –

            • oAuth2Properties (dict) –

              The OAuth 2.0 properties required for OAuth 2.0 authentication.

              • tokenUrl (string) –

                The token URL required for OAuth 2.0 authentication.

              • oAuth2GrantType (string) –

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

              • tokenUrlCustomProperties (dict) –

                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.

                • (string) –

                  • (string) –

          • Pardot (dict) –

            The connector-specific properties required by Salesforce Pardot.

            • instanceUrl (string) –

              The location of the Salesforce Pardot resource.

            • isSandboxEnvironment (boolean) –

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

            • businessUnitId (string) –

              The business unit id of Salesforce Pardot instance.

        • createdAt (datetime) –

          Specifies when the connector profile was created.

        • lastUpdatedAt (datetime) –

          Specifies when the connector profile was last updated.

        • privateConnectionProvisioningState (dict) –

          Specifies the private connection provisioning state.

          • status (string) –

            Specifies the private connection provisioning status.

          • failureMessage (string) –

            Specifies the private connection provisioning failure reason.

          • failureCause (string) –

            Specifies the private connection provisioning failure cause.

    • nextToken (string) –

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

Exceptions