list_workteams ¶

def list_workteams(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    sort_by: Optional[
        "capo_sagemaker.types.list_workteams_sort_by_options.ListWorkteamsSortByOptions"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    name_contains: Optional[
        "capo_sagemaker.types.workteam_name.WorkteamName"
    ] = 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_workteams_response.ListWorkteamsResponse":
    """<p>Gets a list of private work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the <code>NameContains</code> parameter.</p>

    Args:
        sort_by: <p>The field to sort results by. The default is <code>CreationTime</code>.</p>
        sort_order: <p>The sort order for results. The default is <code>Ascending</code>.</p>
        name_contains: <p>A string in the work team's name. This filter returns only work teams whose name contains the specified string.</p>
        next_token: <p>If the result of the previous <code>ListWorkteams</code> request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of labeling jobs, use the token in the next request.</p>
        max_results: <p>The maximum number of work teams to return in each page of the response.</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_workteams_request.ListWorkteamsRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_workteams_response.ListWorkteamsResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_workteams

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkteams")
    )
    input_: capo_sagemaker.types.list_workteams_request.ListWorkteamsRequest = {}
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if name_contains is not None:
        input_["name_contains"] = name_contains
    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