unregister_connector `async` ¶

unregister_connector(
    connector_label: ConnectorLabel,
    *,
    config_overrides: Optional[AsyncAppflowClientConfig] = None,
    force_delete: Optional[Boolean] = None,
) -> UnregisterConnectorResponse

Unregisters the custom connector registered in your account that matches the connector label provided in the request.

Parameters:

connector_label (ConnectorLabel) –

The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web Services account.
force_delete (Optional[Boolean], default: None ) –

Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.

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

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

Source code in docs_src/capo_appflow/_services/async_appflow.py

async def unregister_connector(
    self,
    connector_label: "capo_appflow.types.connector_label.ConnectorLabel",
    *,
    config_overrides: Optional[AsyncAppflowClientConfig] = None,
    force_delete: Optional["capo_appflow.types.boolean.Boolean"] = None,
) -> "capo_appflow.types.unregister_connector_response.UnregisterConnectorResponse":
    """<p>Unregisters the custom connector registered in your account that matches the connector label provided in the request.</p>

    Args:
        connector_label: <p>The label of the connector. The label is unique for each <code>ConnectorRegistration</code> in your Amazon Web Services account.</p>
        force_delete: <p>Indicates whether Amazon AppFlow should unregister the connector, even if it is currently in use in one or more connector profiles. The default value is false.</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.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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_appflow.types.unregister_connector_request.UnregisterConnectorRequest]",
    ) -> AsyncOperationResponse[
        "capo_appflow.types.unregister_connector_response.UnregisterConnectorResponse"
    ]:
        import capo_appflow._operations.sandstone_configuration_service_lambda.unregister_connector

        (
            output,
            http_response,
        ) = await capo_appflow._operations.sandstone_configuration_service_lambda.unregister_connector.async_unregister_connector(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UnregisterConnector")
    )
    input_: capo_appflow.types.unregister_connector_request.UnregisterConnectorRequest = {
        "connector_label": connector_label
    }
    if force_delete is not None:
        input_["force_delete"] = force_delete

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

unregister_connector async ¶

unregister_connector `async` ¶