Skip to content

delete_human_task_ui

delete_human_task_ui(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    human_task_ui_name: Optional[HumanTaskUiName] = None,
) -> DeleteHumanTaskUiResponse

Use this operation to delete a human task user interface (worker task template).

To see a list of human task user interfaces (work task templates) in your account, use ListHumanTaskUis. When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

Parameters:

  • human_task_ui_name (Optional[HumanTaskUiName], default: None ) –

    The name of the human task user interface (work task template) you want to delete.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def delete_human_task_ui(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    human_task_ui_name: Optional[
        "capo_sagemaker.types.human_task_ui_name.HumanTaskUiName"
    ] = None,
) -> "capo_sagemaker.types.delete_human_task_ui_response.DeleteHumanTaskUiResponse":
    """<p>Use this operation to delete a human task user interface (worker task template).</p> <p> To see a list of human task user interfaces (work task templates) in your account, use <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ListHumanTaskUis.html">ListHumanTaskUis</a>. When you delete a worker task template, it no longer appears when you call <code>ListHumanTaskUis</code>.</p>

    Args:
        human_task_ui_name: <p>The name of the human task user interface (work task template) you want to delete.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.delete_human_task_ui_request.DeleteHumanTaskUiRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.delete_human_task_ui_response.DeleteHumanTaskUiResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.delete_human_task_ui

        output, http_response = (
            capo_sagemaker._operations.sage_maker.delete_human_task_ui.delete_human_task_ui(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteHumanTaskUi")
    )
    input_: capo_sagemaker.types.delete_human_task_ui_request.DeleteHumanTaskUiRequest = {}
    if human_task_ui_name is not None:
        input_["human_task_ui_name"] = human_task_ui_name

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