Skip to content

update_connector_profile

update_connector_profile(
    connector_profile_name: ConnectorProfileName,
    connection_mode: ConnectionMode,
    connector_profile_config: ConnectorProfileConfig,
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
    client_token: Optional[ClientToken] = None,
) -> UpdateConnectorProfileResponse

Updates a given connector profile associated with your account.

Parameters:

  • connector_profile_name (ConnectorProfileName) –

    The name of the connector profile and is unique for each ConnectorProfile in the Amazon Web Services account.

  • connection_mode (ConnectionMode) –

    Indicates the connection mode and if it is public or private.

  • connector_profile_config (ConnectorProfileConfig) –

    Defines the connector-specific profile configuration and credentials.

  • client_token (Optional[ClientToken], default: None ) –

    The clientToken parameter is an idempotency token. It ensures that your UpdateConnectorProfile 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 UpdateConnectorProfile. The token is active for 8 hours.

Raises:

  • ConflictException –

    There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again.

  • ConnectorAuthenticationException –

    An error occurred when authenticating with the connector endpoint.

  • InternalServerException –

    An internal service error occurred during the processing of your request. Try again later.

  • ResourceNotFoundException –

    The resource specified in the request (such as the source or destination connector profile) is not found.

  • ValidationException –

    The request has invalid or missing parameters.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_appflow/_services/appflow.py
def update_connector_profile(
    self,
    connector_profile_name: "capo_appflow.types.connector_profile_name.ConnectorProfileName",
    connection_mode: "capo_appflow.types.connection_mode.ConnectionMode",
    connector_profile_config: "capo_appflow.types.connector_profile_config.ConnectorProfileConfig",
    *,
    config_overrides: Optional[AppflowClientConfig] = None,
    client_token: Optional["capo_appflow.types.client_token.ClientToken"] = None,
) -> "capo_appflow.types.update_connector_profile_response.UpdateConnectorProfileResponse":
    """<p> Updates a given connector profile associated with your account. </p>

    Args:
        connector_profile_name: <p> The name of the connector profile and is unique for each <code>ConnectorProfile</code> in the Amazon Web Services account. </p>
        connection_mode: <p> Indicates the connection mode and if it is public or private. </p>
        connector_profile_config: <p> Defines the connector-specific profile configuration and credentials. </p>
        client_token: <p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>UpdateConnectorProfile</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>UpdateConnectorProfile</code>. The token is active for 8 hours.</p>

    Raises:
        capo_appflow.errors.conflict_exception.ConflictException: <p> There was a conflict when processing the request (for example, a flow with the given name already exists within the account. Check for conflicting resource names and try again. </p>
        capo_appflow.errors.connector_authentication_exception.ConnectorAuthenticationException: <p> An error occurred when authenticating with the connector endpoint. </p>
        capo_appflow.errors.internal_server_exception.InternalServerException: <p> An internal service error occurred during the processing of your request. Try again later. </p>
        capo_appflow.errors.resource_not_found_exception.ResourceNotFoundException: <p> The resource specified in the request (such as the source or destination connector profile) is not found. </p>
        capo_appflow.errors.validation_exception.ValidationException: <p> The request has invalid or missing parameters. </p>
        capo_appflow.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_appflow.types.update_connector_profile_request.UpdateConnectorProfileRequest]",
    ) -> OperationResponse[
        "capo_appflow.types.update_connector_profile_response.UpdateConnectorProfileResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.update_connector_profile

        output, http_response = (
            capo_appflow._operations.sandstone_configuration_service_lambda.update_connector_profile.update_connector_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_appflow.types.update_connector_profile_request.UpdateConnectorProfileRequest",
    ) -> dict[str, Any]:
        import capo_appflow.types.update_connector_profile_request

        return capo_appflow.types.update_connector_profile_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateConnectorProfile", redact_input=_redact_input),
    )
    input_: capo_appflow.types.update_connector_profile_request.UpdateConnectorProfileRequest = {
        "connector_profile_name": connector_profile_name,
        "connection_mode": connection_mode,
        "connector_profile_config": connector_profile_config,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output