list_workforces ¶

def list_workforces(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    sort_by: Optional[
        "capo_sagemaker.types.list_workforces_sort_by_options.ListWorkforcesSortByOptions"
    ] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    name_contains: Optional[
        "capo_sagemaker.types.workforce_name.WorkforceName"
    ] = 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_workforces_response.ListWorkforcesResponse":
    """<p>Use this operation to list all private and vendor workforces in an Amazon Web Services Region. Note that you can only have one private workforce per Amazon Web Services Region.</p>

    Args:
        sort_by: <p>Sort workforces using the workforce name or creation date.</p>
        sort_order: <p>Sort workforces in ascending or descending order.</p>
        name_contains: <p>A filter you can use to search for workforces using part of the workforce name.</p>
        next_token: <p>A token to resume pagination.</p>
        max_results: <p>The maximum number of workforces returned in 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_workforces_request.ListWorkforcesRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_workforces_response.ListWorkforcesResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_workforces

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListWorkforces")
    )
    input_: capo_sagemaker.types.list_workforces_request.ListWorkforcesRequest = {}
    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