Enables you to delete an existing connector profile.
Parameters:
-
connector_profile_name
(ConnectorProfileName)
–
The name of the connector profile. The name is unique for each ConnectorProfile in your account.
-
force_delete
(Optional[Boolean], default:
None
)
–
Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows.
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/appflow.py
| def delete_connector_profile(
self,
connector_profile_name: "capo_appflow.types.connector_profile_name.ConnectorProfileName",
*,
config_overrides: Optional[AppflowClientConfig] = None,
force_delete: Optional["capo_appflow.types.boolean.Boolean"] = None,
) -> "capo_appflow.types.delete_connector_profile_response.DeleteConnectorProfileResponse":
"""<p> Enables you to delete an existing connector profile. </p>
Args:
connector_profile_name: <p> The name of the connector profile. The name is unique for each <code>ConnectorProfile</code> in your account. </p>
force_delete: <p> Indicates whether Amazon AppFlow should delete the profile, even if it is currently in use in one or more flows. </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.
"""
def _handler(
req: "OperationRequest[capo_appflow.types.delete_connector_profile_request.DeleteConnectorProfileRequest]",
) -> OperationResponse[
"capo_appflow.types.delete_connector_profile_response.DeleteConnectorProfileResponse"
]:
import capo_appflow._operations.sandstone_configuration_service_lambda.delete_connector_profile
output, http_response = (
capo_appflow._operations.sandstone_configuration_service_lambda.delete_connector_profile.delete_connector_profile(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DeleteConnectorProfile")
)
input_: capo_appflow.types.delete_connector_profile_request.DeleteConnectorProfileRequest = {
"connector_profile_name": connector_profile_name
}
if force_delete is not None:
input_["force_delete"] = force_delete
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|