Skip to content

SearchRequest

Source code in docs_src/capo_sagemaker/types/search_request.py
class SearchRequest(TypedDict, closed=True):
    resource: NotRequired["capo_sagemaker.types.resource_type.ResourceType"]
    """<p>The name of the SageMaker resource to search for.</p>"""
    search_expression: NotRequired[
        "capo_sagemaker.types.search_expression.SearchExpression"
    ]
    """<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: NotRequired[
        "capo_sagemaker.types.resource_property_name.ResourcePropertyName"
    ]
    """<p>The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.</p>"""
    sort_order: NotRequired["capo_sagemaker.types.search_sort_order.SearchSortOrder"]
    """<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: NotRequired["capo_sagemaker.types.next_token.NextToken"]
    """<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: NotRequired["capo_sagemaker.types.max_results.MaxResults"]
    """<p>The maximum number of results to return.</p>"""
    cross_account_filter_option: NotRequired[
        "capo_sagemaker.types.cross_account_filter_option.CrossAccountFilterOption"
    ]
    """<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: NotRequired[
        "capo_sagemaker.types.visibility_conditions_list.VisibilityConditionsList"
    ]
    """<p> Limits the results of your search request to the resources that you can access. </p>"""

cross_account_filter_option instance-attribute

cross_account_filter_option: NotRequired[CrossAccountFilterOption]

A cross account filter option. When the value is "CrossAccount" the search results will only include resources made discoverable to you from other accounts. When the value is "SameAccount" or null the search results will only include resources from your account. Default is null. For more information on searching for resources made discoverable to your account, see Search discoverable resources in the SageMaker Developer Guide. The maximum number of ResourceCatalogs viewable is 1000.

max_results instance-attribute

max_results: NotRequired[MaxResults]

The maximum number of results to return.

next_token instance-attribute

next_token: NotRequired[NextToken]

If more than MaxResults resources match the specified SearchExpression, the response includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results.

resource instance-attribute

resource: NotRequired[ResourceType]

The name of the SageMaker resource to search for.

search_expression instance-attribute

search_expression: NotRequired[SearchExpression]

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 SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

sort_by instance-attribute

sort_by: NotRequired[ResourcePropertyName]

The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

sort_order instance-attribute

sort_order: NotRequired[SearchSortOrder]

How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

visibility_conditions instance-attribute

visibility_conditions: NotRequired[VisibilityConditionsList]

Limits the results of your search request to the resources that you can access.