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

Description

Lists the model packages that have been created.

This operation returns paginated results.

Synopsis

Creating a Request

data ListModelPackages Source #

See: newListModelPackages smart constructor.

Constructors

ListModelPackages' 

Fields

  • nameContains :: Maybe Text

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

  • modelApprovalStatus :: Maybe ModelApprovalStatus

    A filter that returns only the model packages with the specified approval status.

  • modelPackageType :: Maybe ModelPackageType

    A filter that returns onlyl the model packages of the specified type. This can be one of the following values.

    • VERSIONED - List only versioned models.
    • UNVERSIONED - List only unversioined models.
    • BOTH - List both versioned and unversioned models.
  • creationTimeAfter :: Maybe POSIX

    A filter that returns only model packages created after the specified time (timestamp).

  • nextToken :: Maybe Text

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

  • sortOrder :: Maybe SortOrder

    The sort order for the results. The default is Ascending.

  • modelPackageGroupName :: Maybe Text

    A filter that returns only model versions that belong to the specified model group.

  • creationTimeBefore :: Maybe POSIX

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

  • maxResults :: Maybe Natural

    The maximum number of model packages to return in the response.

  • sortBy :: Maybe ModelPackageSortBy

    The parameter by which to sort the results. The default is CreationTime.

Instances

Instances details
Eq ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

(==) :: ListModelPackages -> ListModelPackages -> Bool #

(/=) :: ListModelPackages -> ListModelPackages -> Bool #

Read ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

readsPrec :: Int -> ReadS ListModelPackages #

readList :: ReadS [ListModelPackages] #

readPrec :: ReadPrec ListModelPackages #

readListPrec :: ReadPrec [ListModelPackages] #

Show ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

showsPrec :: Int -> ListModelPackages -> ShowS #

show :: ListModelPackages -> String #

showList :: [ListModelPackages] -> ShowS #

Generic ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type Rep ListModelPackages :: Type -> Type #

Methods

from :: ListModelPackages -> Rep ListModelPackages x #

to :: Rep ListModelPackages x -> ListModelPackages #

NFData ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

rnf :: ListModelPackages -> () #

Hashable ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

hashWithSalt :: Int -> ListModelPackages -> Int #

hash :: ListModelPackages -> Int #

ToJSON ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toJSON :: ListModelPackages -> Value #

toEncoding :: ListModelPackages -> Encoding #

toJSONList :: [ListModelPackages] -> Value #

toEncodingList :: [ListModelPackages] -> Encoding #

AWSPager ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

page :: ListModelPackages -> AWSResponse ListModelPackages -> Maybe ListModelPackages #

AWSRequest ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type AWSResponse ListModelPackages #

Methods

request :: ListModelPackages -> Request ListModelPackages #

response :: MonadResource m => Logger -> Service -> Proxy ListModelPackages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListModelPackages))) #

ToHeaders ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toHeaders :: ListModelPackages -> [Header] #

ToPath ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toPath :: ListModelPackages -> ByteString #

ToQuery ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toQuery :: ListModelPackages -> QueryString #

type Rep ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

type Rep ListModelPackages = D1 ('MetaData "ListModelPackages" "Amazonka.SageMaker.ListModelPackages" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListModelPackages'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "nameContains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "modelApprovalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelApprovalStatus))) :*: (S1 ('MetaSel ('Just "modelPackageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageType)) :*: (S1 ('MetaSel ('Just "creationTimeAfter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)) :*: S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "creationTimeBefore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "sortBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageSortBy)))))))
type AWSResponse ListModelPackages Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

type AWSResponse ListModelPackages = ListModelPackagesResponse

newListModelPackages :: ListModelPackages Source #

Create a value of ListModelPackages 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:ListModelPackages', listModelPackages_nameContains - A string in the model package name. This filter returns only model packages whose name contains the specified string.

$sel:modelApprovalStatus:ListModelPackages', listModelPackages_modelApprovalStatus - A filter that returns only the model packages with the specified approval status.

$sel:modelPackageType:ListModelPackages', listModelPackages_modelPackageType - A filter that returns onlyl the model packages of the specified type. This can be one of the following values.

  • VERSIONED - List only versioned models.
  • UNVERSIONED - List only unversioined models.
  • BOTH - List both versioned and unversioned models.

$sel:creationTimeAfter:ListModelPackages', listModelPackages_creationTimeAfter - A filter that returns only model packages created after the specified time (timestamp).

$sel:nextToken:ListModelPackages', listModelPackages_nextToken - If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

$sel:sortOrder:ListModelPackages', listModelPackages_sortOrder - The sort order for the results. The default is Ascending.

$sel:modelPackageGroupName:ListModelPackages', listModelPackages_modelPackageGroupName - A filter that returns only model versions that belong to the specified model group.

$sel:creationTimeBefore:ListModelPackages', listModelPackages_creationTimeBefore - A filter that returns only model packages created before the specified time (timestamp).

$sel:maxResults:ListModelPackages', listModelPackages_maxResults - The maximum number of model packages to return in the response.

$sel:sortBy:ListModelPackages', listModelPackages_sortBy - The parameter by which to sort the results. The default is CreationTime.

Request Lenses

listModelPackages_nameContains :: Lens' ListModelPackages (Maybe Text) Source #

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

listModelPackages_modelApprovalStatus :: Lens' ListModelPackages (Maybe ModelApprovalStatus) Source #

A filter that returns only the model packages with the specified approval status.

listModelPackages_modelPackageType :: Lens' ListModelPackages (Maybe ModelPackageType) Source #

A filter that returns onlyl the model packages of the specified type. This can be one of the following values.

  • VERSIONED - List only versioned models.
  • UNVERSIONED - List only unversioined models.
  • BOTH - List both versioned and unversioned models.

listModelPackages_creationTimeAfter :: Lens' ListModelPackages (Maybe UTCTime) Source #

A filter that returns only model packages created after the specified time (timestamp).

listModelPackages_nextToken :: Lens' ListModelPackages (Maybe Text) Source #

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

listModelPackages_sortOrder :: Lens' ListModelPackages (Maybe SortOrder) Source #

The sort order for the results. The default is Ascending.

listModelPackages_modelPackageGroupName :: Lens' ListModelPackages (Maybe Text) Source #

A filter that returns only model versions that belong to the specified model group.

listModelPackages_creationTimeBefore :: Lens' ListModelPackages (Maybe UTCTime) Source #

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

listModelPackages_maxResults :: Lens' ListModelPackages (Maybe Natural) Source #

The maximum number of model packages to return in the response.

listModelPackages_sortBy :: Lens' ListModelPackages (Maybe ModelPackageSortBy) Source #

The parameter by which to sort the results. The default is CreationTime.

Destructuring the Response

data ListModelPackagesResponse Source #

See: newListModelPackagesResponse smart constructor.

Constructors

ListModelPackagesResponse' 

Fields

Instances

Instances details
Eq ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

(==) :: ListModelPackagesResponse -> ListModelPackagesResponse -> Bool #

(/=) :: ListModelPackagesResponse -> ListModelPackagesResponse -> Bool #

Read ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

readsPrec :: Int -> ReadS ListModelPackagesResponse #

readList :: ReadS [ListModelPackagesResponse] #

readPrec :: ReadPrec ListModelPackagesResponse #

readListPrec :: ReadPrec [ListModelPackagesResponse] #

Show ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

showsPrec :: Int -> ListModelPackagesResponse -> ShowS #

show :: ListModelPackagesResponse -> String #

showList :: [ListModelPackagesResponse] -> ShowS #

Generic ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type Rep ListModelPackagesResponse :: Type -> Type #

Methods

from :: ListModelPackagesResponse -> Rep ListModelPackagesResponse x #

to :: Rep ListModelPackagesResponse x -> ListModelPackagesResponse #

NFData ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

Methods

rnf :: ListModelPackagesResponse -> () #

type Rep ListModelPackagesResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListModelPackages

type Rep ListModelPackagesResponse = D1 ('MetaData "ListModelPackagesResponse" "Amazonka.SageMaker.ListModelPackages" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "ListModelPackagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "modelPackageSummaryList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ModelPackageSummary]))))

newListModelPackagesResponse Source #

Arguments

:: Int

$sel:httpStatus:ListModelPackagesResponse'

-> ListModelPackagesResponse 

Create a value of ListModelPackagesResponse 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:ListModelPackages', listModelPackagesResponse_nextToken - If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

$sel:httpStatus:ListModelPackagesResponse', listModelPackagesResponse_httpStatus - The response's http status code.

$sel:modelPackageSummaryList:ListModelPackagesResponse', listModelPackagesResponse_modelPackageSummaryList - An array of ModelPackageSummary objects, each of which lists a model package.

Response Lenses

listModelPackagesResponse_nextToken :: Lens' ListModelPackagesResponse (Maybe Text) Source #

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

listModelPackagesResponse_httpStatus :: Lens' ListModelPackagesResponse Int Source #

The response's http status code.

listModelPackagesResponse_modelPackageSummaryList :: Lens' ListModelPackagesResponse [ModelPackageSummary] Source #

An array of ModelPackageSummary objects, each of which lists a model package.