connector_entities

Creates, updates, deletes, gets or lists a connector_entities resource.

Overview

Name	connector_entities
Type	Resource
Id	aws.appflow.connector_entities

Fields

The following fields are returned by SELECT queries:

describe_connector_entity

Name	Datatype	Description
connector_entity_fields	array	Describes the fields for that connector entity. For example, for an account entity, the fields would be account name, account ID, and so on.

list_connector_entities

Name	Datatype	Description
connector_entity_map	object	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.
next_token	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. (pattern: <code>\S+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_connector_entity	select	region		Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.
list_connector_entities	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_connector_entity

Provides details regarding the entity used with the connector, with a description of the data model for each field in that entity.

SELECT
connector_entity_fields
FROM aws.appflow.connector_entities
WHERE region = '{{ region }}' -- required
;

list_connector_entities

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.

SELECT
connector_entity_map,
next_token
FROM aws.appflow.connector_entities
WHERE region = '{{ region }}' -- required
;