Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

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.

post/#X-Amz-Target=SageMaker.Search

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'SageMaker.Search' required

Request body

Resource'TrainingJob' | 'Experiment' | 'ExperimentTrial' | 'ExperimentTrialComponent' | 'Endpoint' | 'ModelPackage' | 'ModelPackageGroup' | 'Pipeline' | 'PipelineExecution' | 'FeatureGroup' | 'Project' | 'FeatureMetadata' | 'HyperParameterTuningJob' | 'ModelCard' | 'Model' required

The name of the SageMaker resource to search for.

SortBystring

The name of the resource property used to sort the <code>SearchResults</code>. The default is <code>LastModifiedTime</code>.

SortOrder'Ascending' | 'Descending'

How <code>SearchResults</code> are ordered. Valid values are <code>Ascending</code> or <code>Descending</code>. The default is <code>Descending</code>.

NextTokenstring

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.

MaxResultsinteger

The maximum number of results to return.

Response

Success

NextTokenstring

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.