Appflow / Client / describe_connector

describe_connector#

Appflow.Client.describe_connector(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_connector(
    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'
)
Parameters:

  • connectorType (string) –

    [REQUIRED]

    The connector type, such as CUSTOMCONNECTOR, Saleforce, Marketo. Please choose CUSTOMCONNECTOR for Lambda based custom connectors.

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

Return type:

dict

Returns:

Response Syntax

{
    'connectorConfiguration': {
        'canUseAsSource': True|False,
        'canUseAsDestination': True|False,
        'supportedDestinationConnectors': [
            'Salesforce'|'Singular'|'Slack'|'Redshift'|'S3'|'Marketo'|'Googleanalytics'|'Zendesk'|'Servicenow'|'Datadog'|'Trendmicro'|'Snowflake'|'Dynatrace'|'Infornexus'|'Amplitude'|'Veeva'|'EventBridge'|'LookoutMetrics'|'Upsolver'|'Honeycode'|'CustomerProfiles'|'SAPOData'|'CustomConnector'|'Pardot',
        ],
        'supportedSchedulingFrequencies': [
            'BYMINUTE'|'HOURLY'|'DAILY'|'WEEKLY'|'MONTHLY'|'ONCE',
        ],
        'isPrivateLinkEnabled': True|False,
        'isPrivateLinkEndpointUrlRequired': True|False,
        'supportedTriggerTypes': [
            'Scheduled'|'Event'|'OnDemand',
        ],
        'connectorMetadata': {
            'Amplitude': {},
            'Datadog': {},
            'Dynatrace': {},
            'GoogleAnalytics': {
                'oAuthScopes': [
                    'string',
                ]
            },
            'InforNexus': {},
            'Marketo': {},
            'Redshift': {},
            'S3': {},
            'Salesforce': {
                'oAuthScopes': [
                    'string',
                ],
                'dataTransferApis': [
                    'AUTOMATIC'|'BULKV2'|'REST_SYNC',
                ],
                'oauth2GrantTypesSupported': [
                    'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
                ]
            },
            'ServiceNow': {},
            'Singular': {},
            'Slack': {
                'oAuthScopes': [
                    'string',
                ]
            },
            'Snowflake': {
                'supportedRegions': [
                    'string',
                ]
            },
            'Trendmicro': {},
            'Veeva': {},
            'Zendesk': {
                'oAuthScopes': [
                    'string',
                ]
            },
            'EventBridge': {},
            'Upsolver': {},
            'CustomerProfiles': {},
            'Honeycode': {
                'oAuthScopes': [
                    'string',
                ]
            },
            'SAPOData': {},
            'Pardot': {}
        },
        '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',
        'connectorDescription': 'string',
        'connectorOwner': 'string',
        'connectorName': 'string',
        'connectorVersion': 'string',
        'connectorArn': 'string',
        'connectorModes': [
            'string',
        ],
        'authenticationConfig': {
            'isBasicAuthSupported': True|False,
            'isApiKeyAuthSupported': True|False,
            'isOAuth2Supported': True|False,
            'isCustomAuthSupported': True|False,
            'oAuth2Defaults': {
                'oauthScopes': [
                    'string',
                ],
                'tokenUrls': [
                    'string',
                ],
                'authCodeUrls': [
                    'string',
                ],
                'oauth2GrantTypesSupported': [
                    'CLIENT_CREDENTIALS'|'AUTHORIZATION_CODE'|'JWT_BEARER',
                ],
                'oauth2CustomProperties': [
                    {
                        'key': 'string',
                        'isRequired': True|False,
                        'label': 'string',
                        'description': 'string',
                        'isSensitiveField': True|False,
                        'connectorSuppliedValues': [
                            'string',
                        ],
                        'type': 'TOKEN_URL'|'AUTH_URL'
                    },
                ]
            },
            'customAuthConfigs': [
                {
                    'customAuthenticationType': 'string',
                    'authParameters': [
                        {
                            'key': 'string',
                            'isRequired': True|False,
                            'label': 'string',
                            'description': 'string',
                            'isSensitiveField': True|False,
                            'connectorSuppliedValues': [
                                'string',
                            ]
                        },
                    ]
                },
            ]
        },
        'connectorRuntimeSettings': [
            {
                'key': 'string',
                'dataType': 'string',
                'isRequired': True|False,
                'label': 'string',
                'description': 'string',
                'scope': 'string',
                'connectorSuppliedValueOptions': [
                    'string',
                ]
            },
        ],
        'supportedApiVersions': [
            'string',
        ],
        'supportedOperators': [
            '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',
        ],
        'supportedWriteOperations': [
            'INSERT'|'UPSERT'|'UPDATE'|'DELETE',
        ],
        'connectorProvisioningType': 'LAMBDA',
        'connectorProvisioningConfig': {
            'lambda': {
                'lambdaArn': 'string'
            }
        },
        'logoURL': 'string',
        'registeredAt': datetime(2015, 1, 1),
        'registeredBy': 'string',
        'supportedDataTransferTypes': [
            'RECORD'|'FILE',
        ],
        'supportedDataTransferApis': [
            {
                'Name': 'string',
                'Type': 'SYNC'|'ASYNC'|'AUTOMATIC'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • connectorConfiguration (dict) –

      Configuration info of all the connectors that the user requested.

      • canUseAsSource (boolean) –

        Specifies whether the connector can be used as a source.

      • canUseAsDestination (boolean) –

        Specifies whether the connector can be used as a destination.

      • supportedDestinationConnectors (list) –

        Lists the connectors that are available for use as destinations.

        • (string) –

      • supportedSchedulingFrequencies (list) –

        Specifies the supported flow frequency for that connector.

        • (string) –

      • isPrivateLinkEnabled (boolean) –

        Specifies if PrivateLink is enabled for that connector.

      • isPrivateLinkEndpointUrlRequired (boolean) –

        Specifies if a PrivateLink endpoint URL is required.

      • supportedTriggerTypes (list) –

        Specifies the supported trigger types for the flow.

        • (string) –

      • connectorMetadata (dict) –

        Specifies connector-specific metadata such as oAuthScopes, supportedRegions, privateLinkServiceUrl, and so on.

        • Amplitude (dict) –

          The connector metadata specific to Amplitude.

        • Datadog (dict) –

          The connector metadata specific to Datadog.

        • Dynatrace (dict) –

          The connector metadata specific to Dynatrace.

        • GoogleAnalytics (dict) –

          The connector metadata specific to Google Analytics.

          • oAuthScopes (list) –

            The desired authorization scope for the Google Analytics account.

            • (string) –

        • InforNexus (dict) –

          The connector metadata specific to Infor Nexus.

        • Marketo (dict) –

          The connector metadata specific to Marketo.

        • Redshift (dict) –

          The connector metadata specific to Amazon Redshift.

        • S3 (dict) –

          The connector metadata specific to Amazon S3.

        • Salesforce (dict) –

          The connector metadata specific to Salesforce.

          • oAuthScopes (list) –

            The desired authorization scope for the Salesforce account.

            • (string) –

          • dataTransferApis (list) –

            The Salesforce APIs that you can have Amazon AppFlow use when your flows transfers data to or from Salesforce.

            • (string) –

          • oauth2GrantTypesSupported (list) –

            The OAuth 2.0 grant types that Amazon AppFlow can use when it requests an access token from Salesforce. Amazon AppFlow requires an access token each time it attempts to access your Salesforce records.

            AUTHORIZATION_CODE

            Amazon AppFlow passes an authorization code when it requests the access token from Salesforce. Amazon AppFlow receives the authorization code from Salesforce after you log in to your Salesforce account and authorize Amazon AppFlow to access your records.

            JWT_BEARER

            Amazon AppFlow passes a JSON web token (JWT) when it requests the access token from Salesforce. You provide the JWT to Amazon AppFlow when you define the connection to your Salesforce account. When you use this grant type, you don’t need to log in to your Salesforce account to authorize Amazon AppFlow to access your records.

            Note

            The CLIENT_CREDENTIALS value is not supported for Salesforce.

            • (string) –

        • ServiceNow (dict) –

          The connector metadata specific to ServiceNow.

        • Singular (dict) –

          The connector metadata specific to Singular.

        • Slack (dict) –

          The connector metadata specific to Slack.

          • oAuthScopes (list) –

            The desired authorization scope for the Slack account.

            • (string) –

        • Snowflake (dict) –

          The connector metadata specific to Snowflake.

          • supportedRegions (list) –

            Specifies the supported Amazon Web Services Regions when using Snowflake.

            • (string) –

        • Trendmicro (dict) –

          The connector metadata specific to Trend Micro.

        • Veeva (dict) –

          The connector metadata specific to Veeva.

        • Zendesk (dict) –

          The connector metadata specific to Zendesk.

          • oAuthScopes (list) –

            The desired authorization scope for the Zendesk account.

            • (string) –

        • EventBridge (dict) –

          The connector metadata specific to Amazon EventBridge.

        • Upsolver (dict) –

          The connector metadata specific to Upsolver.

        • CustomerProfiles (dict) –

          The connector metadata specific to Amazon Connect Customer Profiles.

        • Honeycode (dict) –

          The connector metadata specific to Amazon Honeycode.

          • oAuthScopes (list) –

            The desired authorization scope for the Amazon Honeycode account.

            • (string) –

        • SAPOData (dict) –

          The connector metadata specific to SAPOData.

        • Pardot (dict) –

          The connector metadata specific to Salesforce Pardot.

      • connectorType (string) –

        The connector type.

      • connectorLabel (string) –

        The label used for registering the connector.

      • connectorDescription (string) –

        A description about the connector.

      • connectorOwner (string) –

        The owner who developed the connector.

      • connectorName (string) –

        The connector name.

      • connectorVersion (string) –

        The connector version.

      • connectorArn (string) –

        The Amazon Resource Name (ARN) for the registered connector.

      • connectorModes (list) –

        The connection modes that the connector supports.

        • (string) –

      • authenticationConfig (dict) –

        The authentication config required for the connector.

        • isBasicAuthSupported (boolean) –

          Indicates whether basic authentication is supported by the connector.

        • isApiKeyAuthSupported (boolean) –

          Indicates whether API key authentication is supported by the connector

        • isOAuth2Supported (boolean) –

          Indicates whether OAuth 2.0 authentication is supported by the connector.

        • isCustomAuthSupported (boolean) –

          Indicates whether custom authentication is supported by the connector

        • oAuth2Defaults (dict) –

          Contains the default values required for OAuth 2.0 authentication.

          • oauthScopes (list) –

            OAuth 2.0 scopes that the connector supports.

            • (string) –

          • tokenUrls (list) –

            Token URLs that can be used for OAuth 2.0 authentication.

            • (string) –

          • authCodeUrls (list) –

            Auth code URLs that can be used for OAuth 2.0 authentication.

            • (string) –

          • oauth2GrantTypesSupported (list) –

            OAuth 2.0 grant types supported by the connector.

            • (string) –

          • oauth2CustomProperties (list) –

            List of custom parameters required for OAuth 2.0 authentication.

            • (dict) –

              Custom parameter required for OAuth 2.0 authentication.

              • key (string) –

                The key of the custom parameter required for OAuth 2.0 authentication.

              • isRequired (boolean) –

                Indicates whether the custom parameter for OAuth 2.0 authentication is required.

              • label (string) –

                The label of the custom parameter used for OAuth 2.0 authentication.

              • description (string) –

                A description about the custom parameter used for OAuth 2.0 authentication.

              • isSensitiveField (boolean) –

                Indicates whether this authentication custom parameter is a sensitive field.

              • connectorSuppliedValues (list) –

                Contains default values for this authentication parameter that are supplied by the connector.

                • (string) –

              • type (string) –

                Indicates whether custom parameter is used with TokenUrl or AuthUrl.

        • customAuthConfigs (list) –

          Contains information required for custom authentication.

          • (dict) –

            Configuration information required for custom authentication.

            • customAuthenticationType (string) –

              The authentication type that the custom connector uses.

            • authParameters (list) –

              Information about authentication parameters required for authentication.

              • (dict) –

                Information about required authentication parameters.

                • key (string) –

                  The authentication key required to authenticate with the connector.

                • isRequired (boolean) –

                  Indicates whether this authentication parameter is required.

                • label (string) –

                  Label used for authentication parameter.

                • description (string) –

                  A description about the authentication parameter.

                • isSensitiveField (boolean) –

                  Indicates whether this authentication parameter is a sensitive field.

                • connectorSuppliedValues (list) –

                  Contains default values for this authentication parameter that are supplied by the connector.

                  • (string) –

      • connectorRuntimeSettings (list) –

        The required connector runtime settings.

        • (dict) –

          Contains information about the connector runtime settings that are required for flow execution.

          • key (string) –

            Contains value information about the connector runtime setting.

          • dataType (string) –

            Data type of the connector runtime setting.

          • isRequired (boolean) –

            Indicates whether this connector runtime setting is required.

          • label (string) –

            A label used for connector runtime setting.

          • description (string) –

            A description about the connector runtime setting.

          • scope (string) –

            Indicates the scope of the connector runtime setting.

          • connectorSuppliedValueOptions (list) –

            Contains default values for the connector runtime setting that are supplied by the connector.

            • (string) –

      • supportedApiVersions (list) –

        A list of API versions that are supported by the connector.

        • (string) –

      • supportedOperators (list) –

        A list of operators supported by the connector.

        • (string) –

      • supportedWriteOperations (list) –

        A list of write operations supported by the connector.

        • (string) –

          The possible write operations in the destination connector. When this value is not provided, this defaults to the INSERT operation.

      • connectorProvisioningType (string) –

        The provisioning type used to register the connector.

      • connectorProvisioningConfig (dict) –

        The configuration required for registering the connector.

        • lambda (dict) –

          Contains information about the configuration of the lambda which is being registered as the connector.

          • lambdaArn (string) –

            Lambda ARN of the connector being registered.

      • logoURL (string) –

        Logo URL of the connector.

      • registeredAt (datetime) –

        The date on which the connector was registered.

      • registeredBy (string) –

        Information about who registered the connector.

      • supportedDataTransferTypes (list) –

        The data transfer types that the connector supports.

        RECORD

        Structured records.

        FILE

        Files or binary data.

        • (string) –

      • supportedDataTransferApis (list) –

        The APIs of the connector application that Amazon AppFlow can use to transfer your data.

        • (dict) –

          The API of the connector application that Amazon AppFlow uses to transfer your data.

          • Name (string) –

            The name of the connector application API.

          • Type (string) –

            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.

Exceptions