Skip to content

describe_human_task_ui async

describe_human_task_ui(
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    human_task_ui_name: Optional[HumanTaskUiName] = None,
) -> DescribeHumanTaskUiResponse

Returns information about the requested human task user interface (worker task template).

Parameters:

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

    The name of the human task user interface (worker task template) you want information about.

Raises:

Source code in docs_src/capo_sagemaker/_services/async_sage_maker.py
async def describe_human_task_ui(
    self,
    *,
    config_overrides: Optional[AsyncSageMakerClientConfig] = None,
    human_task_ui_name: Optional[
        "capo_sagemaker.types.human_task_ui_name.HumanTaskUiName"
    ] = None,
) -> "capo_sagemaker.types.describe_human_task_ui_response.DescribeHumanTaskUiResponse":
    """<p>Returns information about the requested human task user interface (worker task template).</p>

    Args:
        human_task_ui_name: <p>The name of the human task user interface (worker task template) you want information about.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_sagemaker.types.describe_human_task_ui_request.DescribeHumanTaskUiRequest]",
    ) -> AsyncOperationResponse[
        "capo_sagemaker.types.describe_human_task_ui_response.DescribeHumanTaskUiResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_human_task_ui

        (
            output,
            http_response,
        ) = await capo_sagemaker._operations.sage_maker.describe_human_task_ui.async_describe_human_task_ui(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

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

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