libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.ListModels

Description

Lists models created with the CreateModel API.

This operation returns paginated results.

Synopsis

Creating a Request

data ListModels Source #

See: newListModels smart constructor.

Constructors

ListModels' 

Fields

  • nameContains :: Maybe Text

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

  • creationTimeAfter :: Maybe POSIX

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

  • 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.

  • sortOrder :: Maybe OrderKey

    The sort order for results. The default is Descending.

  • 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.

  • sortBy :: Maybe ModelSortKey

    Sorts the list of results. The default is CreationTime.

Instances

Instances details
Eq ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Read ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Show ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Generic ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Associated Types

type Rep ListModels :: Type -> Type #

NFData ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Methods

rnf :: ListModels -> () #

Hashable ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

ToJSON ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

AWSPager ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

AWSRequest ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Associated Types

type AWSResponse ListModels #

ToHeaders ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Methods

toHeaders :: ListModels -> [Header] #

ToPath ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

ToQuery ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

type Rep ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

type AWSResponse ListModels Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

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:nameContains:ListModels', listModels_nameContains - A string in the model name. This filter returns only models whose name contains the specified string.

$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:nextToken: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:sortOrder:ListModels', listModels_sortOrder - The sort order for results. The default is Descending.

$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:sortBy:ListModels', listModels_sortBy - Sorts the list of results. The default is CreationTime.

Request Lenses

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_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_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_sortOrder :: Lens' ListModels (Maybe OrderKey) Source #

The sort order for results. The default is Descending.

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_sortBy :: Lens' ListModels (Maybe ModelSortKey) Source #

Sorts the list of results. The default is CreationTime.

Destructuring the Response

data ListModelsResponse Source #

See: newListModelsResponse smart constructor.

Constructors

ListModelsResponse' 

Fields

  • nextToken :: Maybe Text

    If the response is truncated, Amazon 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
Eq ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Read ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Show ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Generic ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Associated Types

type Rep ListModelsResponse :: Type -> Type #

NFData ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

Methods

rnf :: ListModelsResponse -> () #

type Rep ListModelsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModels

type Rep ListModelsResponse = D1 ('MetaData "ListModelsResponse" "Amazonka.SageMaker.ListModels" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" '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 #

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:

$sel:nextToken:ListModels', listModelsResponse_nextToken - If the response is truncated, Amazon 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.

$sel:models: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, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

listModelsResponse_models :: Lens' ListModelsResponse [ModelSummary] Source #

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