v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1423398235.2 KB

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

post/register-connector

Request body

connectorLabelstring

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

descriptionstring

A description about the connector that's being registered.

connectorProvisioningType'LAMBDA'

The type of provisioning that the connector supports, such as Lambda.

clientTokenstring
<p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>RegisterConnector</code> 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 <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> value, the Amazon Web Services 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.</p> <p>If you specify input parameters that differ from your first request, an error occurs. If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>RegisterConnector</code>. The token is active for 8 hours.</p>

Response

Success

connectorArnstring

The ARN of the connector being registered.