---
title: "POST /describe-connector-entity"
method: POST
path: "/describe-connector-entity"
---

# POST /describe-connector-entity

`POST /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.

## Request body

- object
  - `connectorEntityName` string, required — The entity name for that 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 application, such as Salesforce, Amplitude, and so on.
  - `connectorProfileName` string — The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account.
  - `apiVersion` string — The version of the API that's used by the connector.

## Response `200`

Success

- DescribeConnectorEntityResponse
  - `connectorEntityFields` ConnectorEntityField[], required — Describes the fields for that connector entity. For example, for an <i>account</i> entity, the fields would be <i>account name</i>, <i>account ID</i>, and so on.
    - `identifier` string, required — The unique identifier of the connector field.
    - `parentIdentifier` string — The parent identifier of the connector field.
    - `label` string — The label applied to a connector entity field.
    - `isPrimaryKey` boolean — Booelan value that indicates whether this field can be used as a primary key.
    - `defaultValue` string — Default value that can be assigned to this field.
    - `isDeprecated` boolean — Booelan value that indicates whether this field is deprecated or not.
    - `supportedFieldTypeDetails` object — Contains details regarding the supported <code>FieldType</code>, including the corresponding <code>filterOperators</code> and <code>supportedValues</code>.
      - `v1` object, required — The initial supported version for <code>fieldType</code>. If this is later changed to a different version, v2 will be introduced.
        - `fieldType` string, required — The type of field, such as string, integer, date, and so on.
        - `filterOperators` Operator[], required — The list of operators supported by a field.
        - `supportedValues` Value[] — The list of values that a field can contain. For example, a Boolean <code>fieldType</code> can have two values: "true" and "false".
        - `valueRegexPattern` string — The regular expression pattern for the field name.
        - `supportedDateFormat` string — The date format that the field supports.
        - `fieldValueRange` object — The range of values this field can hold.
          - `maximum` number, double — Maximum value supported by the field.
          - `minimum` number, double — Minimum value supported by the field.
        - `fieldLengthRange` object — This is the allowable length range for this field's value.
          - `maximum` number, double — Maximum value supported by the field.
          - `minimum` number, double — Minimum value supported by the field.
    - `description` string — A description of the connector entity field.
    - `sourceProperties` object — The properties that can be applied to a field when the connector is being used as a source.
      - `isRetrievable` boolean — Indicates whether the field can be returned in a search result.
      - `isQueryable` boolean — Indicates if the field can be queried.
      - `isTimestampFieldForIncrementalQueries` boolean — Indicates if this timestamp field can be used for incremental queries.
    - `destinationProperties` object — The properties applied to a field when the connector is being used as a destination.
      - `isCreatable` boolean — Specifies if the destination field can be created by the current user.
      - `isNullable` boolean — Specifies if the destination field can have a null value.
      - `isUpsertable` boolean — Specifies if the flow run can either insert new rows in the destination field if they do not already exist, or update them if they do.
      - `isUpdatable` boolean — Specifies whether the field can be updated during an <code>UPDATE</code> or <code>UPSERT</code> write operation.
      - `isDefaultedOnCreate` boolean — Specifies whether the field can use the default value during a Create operation.
      - `supportedWriteOperations` WriteOperationType[] — A list of supported write operations. For each write operation listed, this field can be used in <code>idFieldNames</code> when that write operation is present as a destination option.
    - `customProperties` object — A map that has specific properties related to the ConnectorEntityField.

## Other responses

- `480` — ValidationException
- `481` — ResourceNotFoundException
- `482` — ConnectorAuthenticationException
- `483` — ConnectorServerException
- `484` — InternalServerException

---

[API](https://skmtc.net/aws/apis/appflow.md) · [All operations](https://skmtc.net/aws/apis/appflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/appflow/versions/a56dde8bf1e0/schema)