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

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

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

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",
         "connectorLabel": "string",
         "connectorModes": [ "string" ],
         "connectorName": "string",
         "connectorOwner": "string",
         "connectorProvisioningType": "string",
         "connectorType": "string",
         "connectorVersion": "string",
         "registeredAt": number,
         "registeredBy": "string",
         "supportedDataTransferTypes": [ "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

Contains information about the connectors supported by Amazon AppFlow.

Type: Array of ConnectorDetail objects

nextToken

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.

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.

Sample Request


{
  "maxResults": 1,
  "nextToken": "nextToken_value"
}

Sample Response


{
  "connectors":
  [
    {
      "connectorArn": "Arn of connector1",
      "connectorDescription": "Some Sample Connector1",
      "connectorName": "Salesforce custom connector1",
      "connectorOwner": "AppFlow",
      "connectorVersion": "1.0",
      "applicationType": "Salesforce",
      "connectorType": "CUSTOMCONNECTOR",
      "connectorLabel": "MyCustomConnector",
      "registeredAt": 1628732168.132,
      "registeredBy": "CUSTOM",
      "tags": null,
      "connectorModes":
      [
        "SOURCE",
        "DESTINATION"
      ],
      "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": 1628732168.132,
      "registeredBy": "CUSTOM",
      "tags": null,
      "connectorModes":
      [
        "SOURCE",
        "DESTINATION"
      ],
      "connectorProvisioningType": "LAMBDA"
    }
  ],
  "nextToken": null
}