Appflow / Client / list_connector_entities

list_connector_entities#

Appflow.Client.list_connector_entities(**kwargs)#

Returns the list of available connector entities supported by Amazon AppFlow. For example, you can query Salesforce for Account and Opportunity entities, or query ServiceNow for the Incident entity.

See also: AWS API Documentation

Request Syntax

response = client.list_connector_entities(
    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',
    entitiesPath='string',
    apiVersion='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • connectorProfileName (string) – The name of the connector profile. The name is unique for each ConnectorProfile in the Amazon Web Services account, and is used to query the downstream connector.

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

  • entitiesPath (string) – This optional parameter is specific to connector implementation. Some connectors support multiple levels or categories of entities. You can find out the list of roots for such providers by sending a request without the entitiesPath parameter. If the connector supports entities at different roots, this initial request returns the list of roots. Otherwise, this request returns all entities supported by the provider.

  • apiVersion (string) – The version of the API that’s used by the connector.

  • maxResults (integer) – The maximum number of items that the operation returns in the response.

  • nextToken (string) – A token that was provided by your prior ListConnectorEntities operation if the response was too big for the page size. You specify this token to get the next page of results in paginated response.

Return type:

dict

Returns:

Response Syntax

{
    'connectorEntityMap': {
        'string': [
            {
                'name': 'string',
                'label': 'string',
                'hasNestedEntities': True|False
            },
        ]
    },
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • connectorEntityMap (dict) –

      The response of ListConnectorEntities lists entities grouped by category. This map’s key represents the group name, and its value contains the list of entities belonging to that group.

      • (string) –

        • (list) –

          • (dict) –

            The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.

            • name (string) –

              The name of the connector entity.

            • label (string) –

              The label applied to the connector entity.

            • hasNestedEntities (boolean) –

              Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

    • nextToken (string) –

      A token that you specify in your next ListConnectorEntities operation to get the next page of results in paginated response. The ListConnectorEntities operation provides this token if the response is too big for the page size.

Exceptions

  • Appflow.Client.exceptions.ValidationException

  • Appflow.Client.exceptions.ResourceNotFoundException

  • Appflow.Client.exceptions.ConnectorAuthenticationException

  • Appflow.Client.exceptions.ConnectorServerException

  • Appflow.Client.exceptions.InternalServerException