search ¶

def search(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    resource: Optional["capo_sagemaker.types.resource_type.ResourceType"] = None,
    search_expression: Optional[
        "capo_sagemaker.types.search_expression.SearchExpression"
    ] = None,
    sort_by: Optional[
        "capo_sagemaker.types.resource_property_name.ResourcePropertyName"
    ] = None,
    sort_order: Optional[
        "capo_sagemaker.types.search_sort_order.SearchSortOrder"
    ] = None,
    next_token: Optional["capo_sagemaker.types.next_token.NextToken"] = None,
    max_results: Optional["capo_sagemaker.types.max_results.MaxResults"] = None,
    cross_account_filter_option: Optional[
        "capo_sagemaker.types.cross_account_filter_option.CrossAccountFilterOption"
    ] = None,
    visibility_conditions: Optional[
        "capo_sagemaker.types.visibility_conditions_list.VisibilityConditionsList"
    ] = None,
) -> "capo_sagemaker.types.search_response.SearchResponse":
    """<p>Finds SageMaker resources that match a search query. Matching resources are returned as a list of <code>SearchRecord</code> objects in the response. You can sort the search results by any resource property in a ascending or descending order.</p> <p>You can query against the following value types: numeric, text, Boolean, and timestamp.</p> <note> <p>The Search API may provide access to otherwise restricted data. See <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/api-permissions-reference.html">Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference</a> for more information.</p> </note>

    Args:
        resource: <p>The name of the SageMaker resource to search for.</p>
        search_expression: <p>A Boolean conditional statement. Resources must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive <code>SubExpressions</code>, <code>NestedFilters</code>, and <code>Filters</code> that can be included in a <code>SearchExpression</code> object is 50.</p>
        sort_by: <p>The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.</p>
        sort_order: <p>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or <code>Descending</code>. The default is <code>Descending</code>.</p>
        next_token: <p>If more than <code>MaxResults</code> resources match the specified <code>SearchExpression</code>, the response includes a <code>NextToken</code>. The <code>NextToken</code> can be passed to the next <code>SearchRequest</code> to continue retrieving results.</p>
        max_results: <p>The maximum number of results to return.</p>
        cross_account_filter_option: <p> A cross account filter option. When the value is <code>"CrossAccount"</code> the search results will only include resources made discoverable to you from other accounts. When the value is <code>"SameAccount"</code> or <code>null</code> the search results will only include resources from your account. Default is <code>null</code>. For more information on searching for resources made discoverable to your account, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/feature-store-cross-account-discoverability-use.html"> Search discoverable resources</a> in the SageMaker Developer Guide. The maximum number of <code>ResourceCatalog</code>s viewable is 1000. </p>
        visibility_conditions: <p> Limits the results of your search request to the resources that you can access. </p>

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

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.search_request.SearchRequest]",
    ) -> OperationResponse["capo_sagemaker.types.search_response.SearchResponse"]:
        import capo_sagemaker._operations.sage_maker.search

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

    def _redact_output(
        output: "capo_sagemaker.types.search_response.SearchResponse",
    ) -> dict[str, Any]:
        import capo_sagemaker.types.search_response

        return capo_sagemaker.types.search_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("Search", redact_output=_redact_output)
    )
    input_: capo_sagemaker.types.search_request.SearchRequest = {}
    if resource is not None:
        input_["resource"] = resource
    if search_expression is not None:
        input_["search_expression"] = search_expression
    if sort_by is not None:
        input_["sort_by"] = sort_by
    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
    if cross_account_filter_option is not None:
        input_["cross_account_filter_option"] = cross_account_filter_option
    if visibility_conditions is not None:
        input_["visibility_conditions"] = visibility_conditions

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