Appflow / Client / update_connector_registration

update_connector_registration#

Appflow.Client.update_connector_registration(**kwargs)#

Updates a custom connector that you’ve previously registered. This operation updates the connector with one of the following:

  • The latest version of the AWS Lambda function that’s assigned to the connector

  • A new AWS Lambda function that you specify

See also: AWS API Documentation

Request Syntax

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

  • connectorLabel (string) –

    [REQUIRED]

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

  • description (string) – A description about the update that you’re applying to the connector.

  • connectorProvisioningConfig (dict) –

    Contains information about the configuration of the connector being registered.

    • 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 UpdateConnectorRegistration 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 UpdateConnectorRegistration. 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 updated.

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