Appflow / Client / list_connectors

list_connectors#

Appflow.Client.list_connectors(**kwargs)#

Returns the list of all registered custom connectors in your Amazon Web Services account. This API lists only custom connectors registered in this account, not the Amazon Web Services authored connectors.

See also: AWS API Documentation

Request Syntax

response = client.list_connectors(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • 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

{
    'connectors': [
        {
            'connectorDescription': 'string',
            'connectorName': 'string',
            'connectorOwner': 'string',
            'connectorVersion': 'string',
            'applicationType': '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',
            'registeredAt': datetime(2015, 1, 1),
            'registeredBy': 'string',
            'connectorProvisioningType': 'LAMBDA',
            'connectorModes': [
                'string',
            ],
            'supportedDataTransferTypes': [
                'RECORD'|'FILE',
            ]
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • connectors (list) –

      Contains information about the connectors supported by Amazon AppFlow.

      • (dict) –

        Information about the registered connector.

        • connectorDescription (string) –

          A description about the registered connector.

        • connectorName (string) –

          The name of the connector.

        • connectorOwner (string) –

          The owner of the connector.

        • connectorVersion (string) –

          The connector version.

        • applicationType (string) –

          The application type of the connector.

        • connectorType (string) –

          The connector type.

        • connectorLabel (string) –

          A label used for the connector.

        • registeredAt (datetime) –

          The time at which the connector was registered.

        • registeredBy (string) –

          The user who registered the connector.

        • connectorProvisioningType (string) –

          The provisioning type that the connector uses.

        • connectorModes (list) –

          The connection mode that the connector supports.

          • (string) –

        • supportedDataTransferTypes (list) –

          The data transfer types that the connector supports.

          RECORD

          Structured records.

          FILE

          Files or binary data.

          • (string) –

    • nextToken (string) –

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

Exceptions