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",
Examples
{ "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"
Examples
}, {
"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"
},
See Also
{
"hasNestedEntities": false, "label": "infra",
"name": "conversations/C013KP5TQ2J"
}, {
"hasNestedEntities": false, "label": "pets",
"name": "conversations/C013NTC2L0G"
}, {
"hasNestedEntities": false, "label": "founders",
"name": "conversations/C014M9JBWCU"
} ] }}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListConnectors
ListConnectors
Returns the list of all registered custom connectors in your AWS account. This API lists only custom connectors registered in this account, not the AWS authored connectors.
Request Syntax
POST /list-connectors HTTP/1.1 Content-type: application/json {
"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.
maxResults (p. 107)
Specifies the maximum number of items that should be returned in the result set. The default for maxResults is 20 (for all paginated API operations).
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 107)
The pagination token for the next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: \S+
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json { "connectors": [
{
"applicationType": "string", "connectorDescription": "string",
Response Elements
"connectorLabel": "string", "connectorModes": [ "string" ], "connectorName": "string", "connectorOwner": "string",
"connectorProvisioningType": "string", "connectorType": "string",
"connectorVersion": "string", "registeredAt": number, "registeredBy": "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.
connectors (p. 107)
Contains information about the connectors supported by Amazon AppFlow.
Type: Array of ConnectorDetail (p. 171) objects nextToken (p. 107)
The pagination token for the next page of data. If nextToken=null, this means that all records have been fetched.
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 (p. 347).
InternalServerException
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500 ValidationException
The request has invalid or missing parameters.
HTTP Status Code: 400
Examples
Listing connectors
This example shows a sample request for the ListConnector API and a sample response.
See Also
Sample Request
{
"maxResults": 1 //(Some number between 1 to 100) "nextToken":"nextToken_value"
}
"connectorDescription":"Some Sample Connector1", "connectorName":"Salesforce custom connector1", "connectorOwner":"AppFlow",
"connectorVersion":"1.0", "applicationType":"Salesforce", "connectorType":"CUSTOMCONNECTOR", "connectorLabel":"MyCustomConnector", "registeredAt":1.628732168132E9,
"connectorProvisioningType":"LAMBDA"
}, {
"connectorArn":"Arn of connector2",
"connectorDescription":"Some Sample Connector2", "connectorName":"Salesforce custom connector2", "connectorOwner":"AppFlow",
"connectorVersion":"1.0", "applicationType":"Salesforce", "connectorType":"CUSTOMCONNECTOR", "connectorLabel":"MyCustomConnector", "registeredAt":1.628732168132E9, "registeredBy":"CUSTOM",
"connectorProvisioningType":"LAMBDA"
} ],
"nextToken":null }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
See Also
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
ListFlows
ListFlows
Lists all of the flows associated with your account.
Request Syntax
POST /list-flows HTTP/1.1 Content-type: application/json { "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.
maxResults (p. 111)
Specifies the maximum number of items that should be returned in the result set.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No nextToken (p. 111)
The pagination token for next page of data.
Type: String
Length Constraints: Maximum length of 2048.
Pattern: \S+
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json {
"flows": [ {
"createdAt": number, "createdBy": "string", "description": "string",
Response Elements
"destinationConnectorLabel": "string", "destinationConnectorType": "string", "flowArn": "string",
"flowName": "string", "flowStatus": "string", "lastRunExecutionDetails": {
"mostRecentExecutionMessage": "string", "mostRecentExecutionStatus": "string", "mostRecentExecutionTime": number },
"lastUpdatedAt": number, "lastUpdatedBy": "string",
"sourceConnectorLabel": "string", "sourceConnectorType": "string", "tags": {
"string" : "string"
},
"triggerType": "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.
flows (p. 111)
The list of flows associated with your account.
Type: Array of FlowDefinition (p. 231) objects nextToken (p. 111)
The pagination token for next page of data.
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 (p. 347).
InternalServerException
An internal service error occurred during the processing of your request. Try again later.
HTTP Status Code: 500 ValidationException
The request has invalid or missing parameters.
HTTP Status Code: 400
Examples