Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.Search

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- nextToken :: Maybe Text
- searchExpression :: Maybe SearchExpression
- sortOrder :: Maybe SearchSortOrder
- maxResults :: Maybe Natural
- sortBy :: Maybe Text
- resource :: ResourceType
}
newSearch :: ResourceType -> Search
search_nextToken :: Lens' Search (Maybe Text)
search_searchExpression :: Lens' Search (Maybe SearchExpression)
search_sortOrder :: Lens' Search (Maybe SearchSortOrder)
search_maxResults :: Lens' Search (Maybe Natural)
search_sortBy :: Lens' Search (Maybe Text)
search_resource :: Lens' Search ResourceType
data SearchResponse = SearchResponse' {
- results :: Maybe [SearchRecord]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newSearchResponse :: Int -> SearchResponse
searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord])
searchResponse_nextToken :: Lens' SearchResponse (Maybe Text)
searchResponse_httpStatus :: Lens' SearchResponse Int

Creating a Request

data Search Source #

See: newSearch smart constructor.

Constructors

Search'

Fields

nextToken :: Maybe Text
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.
searchExpression :: Maybe 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.
sortOrder :: Maybe SearchSortOrder
How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.
maxResults :: Maybe Natural
The maximum number of results to return.
sortBy :: Maybe Text
The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.
resource :: ResourceType
The name of the Amazon SageMaker resource to search for.

Instances

Instances details

Eq Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods (==) :: Search -> Search -> Bool # (/=) :: Search -> Search -> Bool #
Read Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods readsPrec :: Int -> ReadS Search # readList :: ReadS [Search] # readPrec :: ReadPrec Search # readListPrec :: ReadPrec [Search] #
Show Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods showsPrec :: Int -> Search -> ShowS # show :: Search -> String # showList :: [Search] -> ShowS #
Generic Search Source #
Instance details Defined in Amazonka.SageMaker.Search Associated Types type Rep Search :: Type -> Type # Methods from :: Search -> Rep Search x # to :: Rep Search x -> Search #
NFData Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods rnf :: Search -> () #
Hashable Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods hashWithSalt :: Int -> Search -> Int # hash :: Search -> Int #
ToJSON Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods toJSON :: Search -> Value # toEncoding :: Search -> Encoding # toJSONList :: [Search] -> Value # toEncodingList :: [Search] -> Encoding #
AWSPager Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods page :: Search -> AWSResponse Search -> Maybe Search #
AWSRequest Search Source #
Instance details Defined in Amazonka.SageMaker.Search Associated Types type AWSResponse Search # Methods request :: Search -> Request Search # response :: MonadResource m => Logger -> Service -> Proxy Search -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Search))) #
ToHeaders Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods toHeaders :: Search -> [Header] #
ToPath Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods toPath :: Search -> ByteString #
ToQuery Search Source #
Instance details Defined in Amazonka.SageMaker.Search Methods toQuery :: Search -> QueryString #
type Rep Search Source #
Instance details Defined in Amazonka.SageMaker.Search type Rep Search = D1 ('MetaData "Search" "Amazonka.SageMaker.Search" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "Search'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "searchExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SearchExpression)) :: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SearchSortOrder)))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))))
type AWSResponse Search Source #
Instance details Defined in Amazonka.SageMaker.Search type AWSResponse Search = SearchResponse

newSearch Source #

Arguments

:: ResourceType	`$sel:resource:Search'`
-> Search

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:nextToken: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:sortOrder:Search', search_sortOrder - How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

$sel:maxResults:Search', search_maxResults - The maximum number of results to return.

$sel:sortBy:Search', search_sortBy - The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

$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_sortOrder :: Lens' Search (Maybe SearchSortOrder) Source #

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

search_maxResults :: Lens' Search (Maybe Natural) Source #

The maximum number of results to return.

search_sortBy :: Lens' Search (Maybe Text) Source #

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

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.

Constructors

SearchResponse'
Fields results :: Maybe [SearchRecord] A list of `SearchRecord` objects. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search Methods (==) :: SearchResponse -> SearchResponse -> Bool # (/=) :: SearchResponse -> SearchResponse -> Bool #
Read SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search Methods readsPrec :: Int -> ReadS SearchResponse # readList :: ReadS [SearchResponse] # readPrec :: ReadPrec SearchResponse # readListPrec :: ReadPrec [SearchResponse] #
Show SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search Methods showsPrec :: Int -> SearchResponse -> ShowS # show :: SearchResponse -> String # showList :: [SearchResponse] -> ShowS #
Generic SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search Associated Types type Rep SearchResponse :: Type -> Type # Methods from :: SearchResponse -> Rep SearchResponse x # to :: Rep SearchResponse x -> SearchResponse #
NFData SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search Methods rnf :: SearchResponse -> () #
type Rep SearchResponse Source #
Instance details Defined in Amazonka.SageMaker.Search type Rep SearchResponse = D1 ('MetaData "SearchResponse" "Amazonka.SageMaker.Search" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "SearchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "results") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SearchRecord])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSearchResponse Source #

Arguments

:: Int	`$sel:httpStatus:SearchResponse'`
-> SearchResponse

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:

$sel:results:SearchResponse', searchResponse_results - A list of SearchRecord objects.

$sel:nextToken: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:httpStatus:SearchResponse', searchResponse_httpStatus - The response's http status code.

Response Lenses

searchResponse_results :: Lens' SearchResponse (Maybe [SearchRecord]) Source #

A list of SearchRecord objects.

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_httpStatus :: Lens' SearchResponse Int Source #

The response's http status code.