Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Finds Amazon 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.
This operation returns paginated results.
Synopsis
- data Search = Search' {}
- newSearch :: ResourceType -> Search
- search_maxResults :: Lens' Search (Maybe Natural)
- search_nextToken :: Lens' Search (Maybe Text)
- search_searchExpression :: Lens' Search (Maybe SearchExpression)
- search_sortBy :: Lens' Search (Maybe Text)
- search_sortOrder :: Lens' Search (Maybe SearchSortOrder)
- search_resource :: Lens' Search ResourceType
- data SearchResponse = SearchResponse' {
- nextToken :: Maybe Text
- results :: Maybe [SearchRecord]
- httpStatus :: Int
- newSearchResponse :: Int -> SearchResponse
- searchResponse_nextToken :: Lens' SearchResponse (Maybe Text)
- searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord])
- searchResponse_httpStatus :: Lens' SearchResponse Int
Creating a Request
See: newSearch
smart constructor.
Search' | |
|
Instances
Create a value of Search
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:Search'
, search_maxResults
- The maximum number of results to return.
Search
, search_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.
$sel:searchExpression:Search'
, search_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.
$sel:sortBy:Search'
, search_sortBy
- The name of the resource property used to sort the SearchResults
. The
default is LastModifiedTime
.
$sel:sortOrder:Search'
, search_sortOrder
- How SearchResults
are ordered. Valid values are Ascending
or
Descending
. The default is Descending
.
$sel:resource:Search'
, search_resource
- The name of the Amazon SageMaker resource to search for.
Request Lenses
search_nextToken :: Lens' Search (Maybe Text) Source #
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.
search_searchExpression :: Lens' Search (Maybe SearchExpression) Source #
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.
search_sortBy :: Lens' Search (Maybe Text) Source #
The name of the resource property used to sort the SearchResults
. The
default is LastModifiedTime
.
search_sortOrder :: Lens' Search (Maybe SearchSortOrder) Source #
How SearchResults
are ordered. Valid values are Ascending
or
Descending
. The default is Descending
.
search_resource :: Lens' Search ResourceType Source #
The name of the Amazon SageMaker resource to search for.
Destructuring the Response
data SearchResponse Source #
See: newSearchResponse
smart constructor.
SearchResponse' | |
|
Instances
Create a value of SearchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
Search
, searchResponse_nextToken
- 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.
$sel:results:SearchResponse'
, searchResponse_results
- A list of SearchRecord
objects.
$sel:httpStatus:SearchResponse'
, searchResponse_httpStatus
- The response's http status code.
Response Lenses
searchResponse_nextToken :: Lens' SearchResponse (Maybe Text) Source #
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.
searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord]) Source #
A list of SearchRecord
objects.
searchResponse_httpStatus :: Lens' SearchResponse Int Source #
The response's http status code.