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

Amazonka.SageMaker.ListModels

Contents

Description

Lists models created with the CreateModel API.

This operation returns paginated results.

Synopsis

data ListModels = ListModels' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe ModelSortKey
- sortOrder :: Maybe OrderKey
}
newListModels :: ListModels
listModels_creationTimeAfter :: Lens' ListModels (Maybe UTCTime)
listModels_creationTimeBefore :: Lens' ListModels (Maybe UTCTime)
listModels_maxResults :: Lens' ListModels (Maybe Natural)
listModels_nameContains :: Lens' ListModels (Maybe Text)
listModels_nextToken :: Lens' ListModels (Maybe Text)
listModels_sortBy :: Lens' ListModels (Maybe ModelSortKey)
listModels_sortOrder :: Lens' ListModels (Maybe OrderKey)
data ListModelsResponse = ListModelsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- models :: [ModelSummary]
}
newListModelsResponse :: Int -> ListModelsResponse
listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text)
listModelsResponse_httpStatus :: Lens' ListModelsResponse Int
listModelsResponse_models :: Lens' ListModelsResponse [ModelSummary]

Creating a Request

data ListModels Source #

See: newListModels smart constructor.

Constructors

ListModels'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).
creationTimeBefore :: Maybe POSIX
A filter that returns only models created before the specified time (timestamp).
maxResults :: Maybe Natural
The maximum number of models to return in the response.
nameContains :: Maybe Text
A string in the model name. This filter returns only models whose name contains the specified string.
nextToken :: Maybe Text
If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
sortBy :: Maybe ModelSortKey
Sorts the list of results. The default is CreationTime.
sortOrder :: Maybe OrderKey
The sort order for results. The default is Descending.

Instances

Instances details

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

newListModels :: ListModels Source #

Create a value of ListModels 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:creationTimeAfter:ListModels', listModels_creationTimeAfter - A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

$sel:creationTimeBefore:ListModels', listModels_creationTimeBefore - A filter that returns only models created before the specified time (timestamp).

$sel:maxResults:ListModels', listModels_maxResults - The maximum number of models to return in the response.

$sel:nameContains:ListModels', listModels_nameContains - A string in the model name. This filter returns only models whose name contains the specified string.

ListModels, listModels_nextToken - If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

$sel:sortBy:ListModels', listModels_sortBy - Sorts the list of results. The default is CreationTime.

$sel:sortOrder:ListModels', listModels_sortOrder - The sort order for results. The default is Descending.

Request Lenses

listModels_creationTimeAfter :: Lens' ListModels (Maybe UTCTime) Source #

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

listModels_creationTimeBefore :: Lens' ListModels (Maybe UTCTime) Source #

A filter that returns only models created before the specified time (timestamp).

listModels_maxResults :: Lens' ListModels (Maybe Natural) Source #

The maximum number of models to return in the response.

listModels_nameContains :: Lens' ListModels (Maybe Text) Source #

A string in the model name. This filter returns only models whose name contains the specified string.

listModels_nextToken :: Lens' ListModels (Maybe Text) Source #

If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

listModels_sortBy :: Lens' ListModels (Maybe ModelSortKey) Source #

Sorts the list of results. The default is CreationTime.

listModels_sortOrder :: Lens' ListModels (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

Destructuring the Response

data ListModelsResponse Source #

See: newListModelsResponse smart constructor.

Constructors

ListModelsResponse'
Fields nextToken :: Maybe Text If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request. httpStatus :: Int The response's http status code. models :: [ModelSummary] An array of `ModelSummary` objects, each of which lists a model.

Instances

Instances details

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

newListModelsResponse Source #

Arguments

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

Create a value of ListModelsResponse 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:

ListModels, listModelsResponse_nextToken - If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

$sel:httpStatus:ListModelsResponse', listModelsResponse_httpStatus - The response's http status code.

ListModelsResponse, listModelsResponse_models - An array of ModelSummary objects, each of which lists a model.

Response Lenses

listModelsResponse_nextToken :: Lens' ListModelsResponse (Maybe Text) Source #

If the response is truncated, SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

listModelsResponse_httpStatus :: Lens' ListModelsResponse Int Source #

The response's http status code.

listModelsResponse_models :: Lens' ListModelsResponse [ModelSummary] Source #

An array of ModelSummary objects, each of which lists a model.