POST

/describe-connector-entity

http://appflow.{region}.amazonaws.com/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.

Access Token Required: API Key

Body Params

apiVersionstring

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

connectorTypestring

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

connectorEntityNamestringrequired

The entity name for that connector.

connectorProfileNamestring

The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://appflow.{region}.amazonaws.com/describe-connector-entity' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}