Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1423398235.2 KB

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

post/list-connector-entities

Request body

connectorProfileNamestring

The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account, and is used to query the downstream 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'

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

entitiesPathstring

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 <code>entitiesPath</code> 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.

apiVersionstring

The version of the API that's used by the connector.

maxResultsinteger

The maximum number of items that the operation returns in the response.

nextTokenstring

A token that was provided by your prior <code>ListConnectorEntities</code> 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.

Response

Success

connectorEntityMapobject required

The response of <code>ListConnectorEntities</code> 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.

nextTokenstring

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