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'
        }
    }
)
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.

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