Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListConnectorEntities

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.

Request Syntax


POST /list-connector-entities HTTP/1.1
Content-type: application/json

{
   "apiVersion": "string",
   "connectorProfileName": "string",
   "connectorType": "string",
   "entitiesPath": "string",
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

apiVersion

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: \S+

Required: No

connectorProfileName

The name of the connector profile. The name is unique for each ConnectorProfile in the AWS account, and is used to query the downstream connector.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\w/!@#+=.-]+

Required: No

connectorType

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

Type: String

Required: No

entitiesPath

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: [\s\w/!@#+=,.-]*

Required: No

maxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

nextToken

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

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "connectorEntityMap": { 
      "string" : [ 
         { 
            "hasNestedEntities": boolean,
            "label": "string",
            "name": "string"
         }
      ]
   },
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

connectorEntityMap

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.

Type: String to array of ConnectorEntity objects map

Key Length Constraints: Maximum length of 128.

Key Pattern: \S+

nextToken

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.

Type: String

Length Constraints: Maximum length of 2048.

Pattern: \S+

Errors

For information about the errors that are common to all actions, see Common Errors.

ConnectorAuthenticationException

An error occurred when authenticating with the connector endpoint.

HTTP Status Code: 401

ConnectorServerException

An error occurred when retrieving data from the connector endpoint.

HTTP Status Code: 400

InternalServerException

An internal service error occurred during the processing of your request. Try again later.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request (such as the source or destination connector profile) is not found.

HTTP Status Code: 404

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

ListConnectorEntities example

This example shows sample requests and a sample response for the ListConnectorEntities API. The second sample request shows a request without the optional connectorType).

Sample Request


{
  "connectorType": "Slack",
  "connectorProfileName": "vmSlackProfile"
}

Sample Request


{
  "connectorProfileName": "vmSlackProfile"
}

Sample Response


{
  "connectorEntityMap":
  {
    "Objects": 
    [
        {"hasNestedEntities": true,
        "label": "Conversations","name": "conversations"}
    ]
  }
}

Sample Request


{
  "connectorProfileName": "vmSlackProfile",
  "connectorType": "Slack",
  "entitiesPath": "conversations"
}

Sample Response


{
  "connectorEntityMap":
  {
    "Channels": [
      {
        "hasNestedEntities": false,
        "label": "new-to-slack",
        "name": "conversations/CQCFDC534"
      },
      {
        "hasNestedEntities": false,
        "label": "advising",
        "name": "conversations/CQDSNS2AX"
      },
      {
        "hasNestedEntities": false,
        "label": "general",
        "name": "conversations/CQTFBK48N"
      },
      {
        "hasNestedEntities": false,
        "label": "random",
        "name": "conversations/CQTFBK6CE"
      },
      {
        "hasNestedEntities": false,
        "label": "investing",
        "name": "conversations/CQTFBKDT8"
      },
      {
        "hasNestedEntities": false,
        "label": "memories",
        "name": "conversations/CS44VCEC9"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-nyc",
        "name": "conversations/CV84P3D7A"
      },
      {
        "hasNestedEntities": false,
        "label": "marketing",
        "name": "conversations/C012DDQRU95"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-phi",
        "name": "conversations/C012DTFRBL7"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-philadelphia",
        "name": "conversations/C012N003VU6"
      },
      {
        "hasNestedEntities": false,
        "label": "lol",
        "name": "conversations/C012NJTMZEJ"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-atlanta",
        "name": "conversations/C012P2739BQ"
      },
      {
        "hasNestedEntities": false,
        "label": "it-support",
        "name": "conversations/C012SRQMLRH"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-nashville",
        "name": "conversations/C012U9TM5DZ"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-texas",
        "name": "conversations/C012VHLB63X"
      },
      {
        "hasNestedEntities": false,
        "label": "data",
        "name": "conversations/C012Z3VMA7N"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-san-francisco",
        "name": "conversations/C01308U07HA"
      },
      {
        "hasNestedEntities": false,
        "label": "slack-feedback",
        "name": "conversations/C0131PCV93N"
      },
      {
        "hasNestedEntities": false,
        "label": "home-of-seattle",
        "name": "conversations/C0136MRRQHX"
      },
      {
        "hasNestedEntities": false,
        "label": "operations",
        "name": "conversations/C0136QPJ1KK"
      },
      {
        "hasNestedEntities": false,
        "label": "product",
        "name": "conversations/C0137S730KT"
      },
      {
        "hasNestedEntities": false,
        "label": "dev",
        "name": "conversations/C013HUHSRGQ"
      },
      {
        "hasNestedEntities": false,
        "label": "infra",
        "name": "conversations/C013KP5TQ2J"
      },
      {
        "hasNestedEntities": false,
        "label": "pets",
        "name": "conversations/C013NTC2L0G"
      },
      {
        "hasNestedEntities": false,
        "label": "founders",
        "name": "conversations/C014M9JBWCU"
      }
    ]
  }
}