Skip to content

DescribeConnectorEntity

Source: src/AWS/AppFlow/DescribeConnectorEntity.ts

Runtime binding for appflow:DescribeConnectorEntity.

Bind this operation to a ConnectorProfile in the function’s init phase to get a callable that describes one entity’s fields (the data model of a Salesforce object, a database table, etc.). The connector profile name is injected automatically and appflow:DescribeConnectorEntity is granted on the profile. Provide the implementation with Effect.provide(AWS.AppFlow.DescribeConnectorEntityHttp).

// init — bind the operation to the connector profile
const describeConnectorEntity =
yield* AWS.AppFlow.DescribeConnectorEntity(profile);
// runtime — read the entity's field metadata
const result = yield* describeConnectorEntity({
connectorEntityName: "Account",
});
// result.connectorEntityFields lists each field with its type