Skip to content

list_human_task_uis

list_human_task_uis(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[Timestamp] = None,
    creation_time_before: Optional[Timestamp] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
) -> ListHumanTaskUisResponse

Returns information about the human task user interfaces in your account.

Parameters:

  • creation_time_after (Optional[Timestamp], default: None ) –

    A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.

  • creation_time_before (Optional[Timestamp], default: None ) –

    A filter that returns only human task user interfaces that were created before the specified timestamp.

  • sort_order (Optional[SortOrder], default: None ) –

    An optional value that specifies whether you want the results sorted in Ascending or Descending order.

  • next_token (Optional[NextToken], default: None ) –

    A token to resume pagination.

  • max_results (Optional[MaxResults], default: None ) –

    The total number of items to return. If the total number of available items is more than the value specified in MaxResults, then a NextToken will be provided in the output that you can use to resume pagination.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def list_human_task_uis(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    creation_time_after: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    creation_time_before: Optional[
        "capo_sagemaker.types.timestamp.Timestamp"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
) -> "capo_sagemaker.types.list_human_task_uis_response.ListHumanTaskUisResponse":
    """<p>Returns information about the human task user interfaces in your account.</p>

    Args:
        creation_time_after: <p>A filter that returns only human task user interfaces with a creation time greater than or equal to the specified timestamp.</p>
        creation_time_before: <p>A filter that returns only human task user interfaces that were created before the specified timestamp.</p>
        sort_order: <p>An optional value that specifies whether you want the results sorted in <code>Ascending</code> or <code>Descending</code> order.</p>
        next_token: <p>A token to resume pagination.</p>
        max_results: <p>The total number of items to return. If the total number of available items is more than the value specified in <code>MaxResults</code>, then a <code>NextToken</code> will be provided in the output that you can use to resume pagination.</p>

    Raises:
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.list_human_task_uis_request.ListHumanTaskUisRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_human_task_uis_response.ListHumanTaskUisResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_human_task_uis

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListHumanTaskUis")
    )
    input_: capo_sagemaker.types.list_human_task_uis_request.ListHumanTaskUisRequest = {}
    if creation_time_after is not None:
        input_["creation_time_after"] = creation_time_after
    if creation_time_before is not None:
        input_["creation_time_before"] = creation_time_before
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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