Appflow / Client / register_connector

register_connector#

Appflow.Client.register_connector(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.register_connector(
    connectorLabel='string',
    description='string',
    connectorProvisioningType='LAMBDA',
    connectorProvisioningConfig={
        'lambda': {
            'lambdaArn': 'string'
        }
    },
    clientToken='string'
)
Parameters:

  • connectorLabel (string) – The name of the connector. The name is unique for each ConnectorRegistration in your Amazon Web Services account.

  • description (string) – A description about the connector that’s being registered.

  • connectorProvisioningType (string) – The provisioning type of the connector. Currently the only supported value is LAMBDA.

  • connectorProvisioningConfig (dict) –

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

    • lambda (dict) –

      Contains information about the configuration of the lambda which is being registered as the connector.

      • lambdaArn (string) – [REQUIRED]

        Lambda ARN of the connector being registered.

  • clientToken (string) –

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

    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.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'connectorArn': 'string'
}

Response Structure

  • (dict) –

    • connectorArn (string) –

      The ARN of the connector being registered.

Exceptions

  • Appflow.Client.exceptions.ValidationException

  • Appflow.Client.exceptions.ConflictException

  • Appflow.Client.exceptions.AccessDeniedException

  • Appflow.Client.exceptions.ResourceNotFoundException

  • Appflow.Client.exceptions.ServiceQuotaExceededException

  • Appflow.Client.exceptions.ThrottlingException

  • Appflow.Client.exceptions.InternalServerException

  • Appflow.Client.exceptions.ConnectorServerException

  • Appflow.Client.exceptions.ConnectorAuthenticationException