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

RegisterConnector

Registers a new custom connector with your AWS account. Before you can register the connector, you must deploy the associated AWS lambda function in your account.

Request Syntax


POST /register-connector HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "connectorLabel": "string",
   "connectorProvisioningConfig": { 
      "lambda": { 
         "lambdaArn": "string"
      }
   },
   "connectorProvisioningType": "string",
   "description": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

clientToken

The clientToken parameter is an idempotency token. It ensures that your RegisterConnector request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same clientToken parameter value.

If you omit a clientToken value, the AWS SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.

If you specify input parameters that differ from your first request, an error occurs. If you use a different value for clientToken, Amazon AppFlow considers it a new call to RegisterConnector. The token is active for 8 hours.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [ -~]+

Required: No

connectorLabel

The name of the connector. The name is unique for each ConnectorRegistration in your AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: [a-zA-Z0-9][\w!@#.-]+

Required: No

connectorProvisioningConfig

The provisioning type of the connector. Currently the only supported value is LAMBDA.

Type: ConnectorProvisioningConfig object

Required: No

connectorProvisioningType

The provisioning type of the connector. Currently the only supported value is LAMBDA.

Type: String

Valid Values: LAMBDA

Required: No

description

A description about the connector that's being registered.

Type: String

Length Constraints: Maximum length of 1024.

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

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "connectorArn": "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.

connectorArn

The ARN of the connector being registered.

Type: String

Length Constraints: Maximum length of 512.

Pattern: arn:aws:.*:.*:[0-9]+:.*

Errors

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

AccessDeniedException

AppFlow/Requester has invalid or missing permissions.

HTTP Status Code: 403

ConflictException

There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The request would cause a service quota (such as the number of flows) to be exceeded.

HTTP Status Code: 402

ThrottlingException

API calls have exceeded the maximum allowed API request rate per account and per Region.

HTTP Status Code: 429

ValidationException

The request has invalid or missing parameters.

HTTP Status Code: 400

Examples

Registering a connector

This example shows a sample request for the RegisterConnector API and a sample response.

Sample Request


{
  "connectorLabel": "Connector_Label_Value",
  "connectorProvisioningType": "LAMBDA",
  "connectorProvisioningConfig":
  {
    "lambda":
    {
      "lambdaArn": "lambda arn"
    }
  }
}

Sample Response


{
  "connectorArn": "arn:aws:appflow:region:<AccountId>:connector/Connector_Label"
}