/AWS1/CL_SGM=>SEARCH()

About Search

Finds SageMaker resources that match a search query. Matching resources are returned as a list of SearchRecord objects in the response. You can sort the search results by any resource property in a ascending or descending order.

You can query against the following value types: numeric, text, Boolean, and timestamp.

The Search API may provide access to otherwise restricted data. See Amazon SageMaker API Permissions: Actions, Permissions, and Resources Reference for more information.

Method Signature

IMPORTING

Required arguments:

IV_RESOURCE TYPE /AWS1/SGMRESOURCETYPE /AWS1/SGMRESOURCETYPE

The name of the SageMaker resource to search for.

Optional arguments:

IO_SEARCHEXPRESSION TYPE REF TO /AWS1/CL_SGMSEARCHEXPRESSION /AWS1/CL_SGMSEARCHEXPRESSION

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.

IV_SORTBY TYPE /AWS1/SGMRESOURCEPROPERTYNAME /AWS1/SGMRESOURCEPROPERTYNAME

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

IV_SORTORDER TYPE /AWS1/SGMSEARCHSORTORDER /AWS1/SGMSEARCHSORTORDER

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

IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

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.

IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of results to return.

IV_CROSSACCOUNTFILTEROPTION TYPE /AWS1/SGMCROSSACCTFILTEROPTION /AWS1/SGMCROSSACCTFILTEROPTION

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.

IT_VISIBILITYCONDITIONS TYPE /AWS1/CL_SGMVISIBILITYCONDS=>TT_VISIBILITYCONDITIONSLIST TT_VISIBILITYCONDITIONSLIST

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_SGMSEARCHRESPONSE /AWS1/CL_SGMSEARCHRESPONSE