list_spaces ¶

def list_spaces(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    sort_order: Optional["capo_sagemaker.types.sort_order.SortOrder"] = None,
    sort_by: Optional["capo_sagemaker.types.space_sort_key.SpaceSortKey"] = None,
    domain_id_equals: Optional["capo_sagemaker.types.domain_id.DomainId"] = None,
    space_name_contains: Optional[
        "capo_sagemaker.types.space_name.SpaceName"
    ] = None,
) -> "capo_sagemaker.types.list_spaces_response.ListSpacesResponse":
    """<p>Lists spaces.</p>

    Args:
        next_token: <p>If the previous response was truncated, you will receive this token. Use it in your next request to receive the next set of results.</p>
        max_results: <p>This parameter defines the maximum number of results that can be return in a single response. The <code>MaxResults</code> parameter is an upper bound, not a target. If there are more results available than the value specified, a <code>NextToken</code> is provided in the response. The <code>NextToken</code> indicates that the user should get the next set of results by providing this token as a part of a subsequent call. The default value for <code>MaxResults</code> is 10.</p>
        sort_order: <p>The sort order for the results. The default is <code>Ascending</code>.</p>
        sort_by: <p>The parameter by which to sort the results. The default is <code>CreationTime</code>.</p>
        domain_id_equals: <p>A parameter to search for the domain ID.</p>
        space_name_contains: <p>A parameter by which to filter the results.</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_spaces_request.ListSpacesRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.list_spaces_response.ListSpacesResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.list_spaces

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSpaces")
    )
    input_: capo_sagemaker.types.list_spaces_request.ListSpacesRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if sort_by is not None:
        input_["sort_by"] = sort_by
    if domain_id_equals is not None:
        input_["domain_id_equals"] = domain_id_equals
    if space_name_contains is not None:
        input_["space_name_contains"] = space_name_contains

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