:doc:`Appflow <../../appflow>` / Client / register_connector

******************
register_connector
******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/appflow-2020-08-23/RegisterConnector>`_  


  **Request Syntax**
  ::

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

    The name of the connector. The name is unique for each ``ConnectorRegistration`` in your Amazon Web Services account.

    

  
  :type description: string
  :param description: 

    A description about the connector that's being registered.

    

  
  :type connectorProvisioningType: string
  :param connectorProvisioningType: 

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

    

  
  :type connectorProvisioningConfig: dict
  :param connectorProvisioningConfig: 

    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.

        

      
    
  
  :type clientToken: string
  :param 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 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.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'connectorArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **connectorArn** *(string) --* 

        The ARN of the connector being registered.

        
  
  **Exceptions**
  
  *   :py:class:`Appflow.Client.exceptions.ValidationException`

  
  *   :py:class:`Appflow.Client.exceptions.ConflictException`

  
  *   :py:class:`Appflow.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Appflow.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Appflow.Client.exceptions.ServiceQuotaExceededException`

  
  *   :py:class:`Appflow.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Appflow.Client.exceptions.InternalServerException`

  
  *   :py:class:`Appflow.Client.exceptions.ConnectorServerException`

  
  *   :py:class:`Appflow.Client.exceptions.ConnectorAuthenticationException`

  