search

Creates, updates, deletes, gets or lists a search resource.

Overview

Name	search
Type	Resource
Id	aws.sagemaker.search

Fields

The following fields are returned by SELECT queries:

search

Name	Datatype	Description
next_token	string	If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. (pattern: <code>.*</code>)
results	array	A list of SearchRecord objects.
total_hits	object	The total number of matching results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
search	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

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.

SELECT
next_token,
results,
total_hits
FROM aws.sagemaker.search
WHERE region = '{{ region }}' -- required
;