aws_sdk_sagemaker/client/
search.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`Search`](crate::operation::search::builders::SearchFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::search::builders::SearchFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`resource(ResourceType)`](crate::operation::search::builders::SearchFluentBuilder::resource) / [`set_resource(Option<ResourceType>)`](crate::operation::search::builders::SearchFluentBuilder::set_resource):<br>required: **true**<br><p>The name of the SageMaker resource to search for.</p><br>
8    ///   - [`search_expression(SearchExpression)`](crate::operation::search::builders::SearchFluentBuilder::search_expression) / [`set_search_expression(Option<SearchExpression>)`](crate::operation::search::builders::SearchFluentBuilder::set_search_expression):<br>required: **false**<br><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><br>
9    ///   - [`sort_by(impl Into<String>)`](crate::operation::search::builders::SearchFluentBuilder::sort_by) / [`set_sort_by(Option<String>)`](crate::operation::search::builders::SearchFluentBuilder::set_sort_by):<br>required: **false**<br><p>The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.</p><br>
10    ///   - [`sort_order(SearchSortOrder)`](crate::operation::search::builders::SearchFluentBuilder::sort_order) / [`set_sort_order(Option<SearchSortOrder>)`](crate::operation::search::builders::SearchFluentBuilder::set_sort_order):<br>required: **false**<br><p>How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or <code>Descending</code>. The default is <code>Descending</code>.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::search::builders::SearchFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::search::builders::SearchFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
12    ///   - [`max_results(i32)`](crate::operation::search::builders::SearchFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::search::builders::SearchFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return.</p><br>
13    ///   - [`cross_account_filter_option(CrossAccountFilterOption)`](crate::operation::search::builders::SearchFluentBuilder::cross_account_filter_option) / [`set_cross_account_filter_option(Option<CrossAccountFilterOption>)`](crate::operation::search::builders::SearchFluentBuilder::set_cross_account_filter_option):<br>required: **false**<br><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><br>
14    ///   - [`visibility_conditions(VisibilityConditions)`](crate::operation::search::builders::SearchFluentBuilder::visibility_conditions) / [`set_visibility_conditions(Option<Vec::<VisibilityConditions>>)`](crate::operation::search::builders::SearchFluentBuilder::set_visibility_conditions):<br>required: **false**<br><p>Limits the results of your search request to the resources that you can access.</p><br>
15    /// - On success, responds with [`SearchOutput`](crate::operation::search::SearchOutput) with field(s):
16    ///   - [`results(Option<Vec::<SearchRecord>>)`](crate::operation::search::SearchOutput::results): <p>A list of <code>SearchRecord</code> objects.</p>
17    ///   - [`next_token(Option<String>)`](crate::operation::search::SearchOutput::next_token): <p>If the result of the previous <code>Search</code> request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.</p>
18    ///   - [`total_hits(Option<TotalHits>)`](crate::operation::search::SearchOutput::total_hits): <p>The total number of matching results.</p>
19    /// - On failure, responds with [`SdkError<SearchError>`](crate::operation::search::SearchError)
20    pub fn search(&self) -> crate::operation::search::builders::SearchFluentBuilder {
21        crate::operation::search::builders::SearchFluentBuilder::new(self.handle.clone())
22    }
23}
aws_sdk_sagemaker/client/search.rs

aws_sdk_sagemaker/client/
search.rs
