Amazonka.SageMaker.ListModelPackages

Lists the model packages that have been created.

This operation returns paginated results.

Creating a Request

data ListModelPackages

See: newListModelPackages smart constructor.

Constructors

ListModelPackages'

Fields

• creationTimeAfter :: Maybe POSIX

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

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

• modelApprovalStatus :: Maybe ModelApprovalStatus

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

• modelPackageGroupName :: Maybe Text

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

• modelPackageType :: Maybe ModelPackageType

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

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
  • VERSIONED - List only versioned models.
  • BOTH - List both versioned and unversioned models.
• nameContains :: Maybe Text

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

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

• sortBy :: Maybe ModelPackageSortBy

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

• sortOrder :: Maybe SortOrder

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

Instances

ToJSON ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toJSON :: ListModelPackages -> Value

toEncoding :: ListModelPackages -> Encoding

toJSONList :: [ListModelPackages] -> Value

toEncodingList :: [ListModelPackages] -> Encoding

ToHeaders ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toHeaders :: ListModelPackages -> [Header]

ToPath ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toPath :: ListModelPackages -> ByteString

ToQuery ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

toQuery :: ListModelPackages -> QueryString

AWSPager ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

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

AWSRequest ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type AWSResponse ListModelPackages

Methods

request :: (Service -> Service) -> ListModelPackages -> Request ListModelPackages

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

Generic ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type Rep ListModelPackages :: Type -> Type

Methods

from :: ListModelPackages -> Rep ListModelPackages x

to :: Rep ListModelPackages x -> ListModelPackages

Read ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

readsPrec :: Int -> ReadS ListModelPackages

readList :: ReadS [ListModelPackages]

readPrec :: ReadPrec ListModelPackages

readListPrec :: ReadPrec [ListModelPackages]

Show ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

showsPrec :: Int -> ListModelPackages -> ShowS

show :: ListModelPackages -> String

showList :: [ListModelPackages] -> ShowS

NFData ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

rnf :: ListModelPackages -> ()

Eq ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

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

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

Hashable ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

Methods

hashWithSalt :: Int -> ListModelPackages -> Int

hash :: ListModelPackages -> Int

type AWSResponse ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

type AWSResponse ListModelPackages = ListModelPackagesResponse

type Rep ListModelPackages

Defined in Amazonka.SageMaker.ListModelPackages

type Rep ListModelPackages = D1 ('MetaData "ListModelPackages" "Amazonka.SageMaker.ListModelPackages" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListModelPackages'" '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 "modelApprovalStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelApprovalStatus)) :*: S1 ('MetaSel ('Just "modelPackageGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "modelPackageType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelPackageType)) :*: 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 ModelPackageSortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SortOrder)))))))

newListModelPackages :: ListModelPackages

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:creationTimeAfter:ListModelPackages', listModelPackages_creationTimeAfter - A filter that returns only model packages created after the specified time (timestamp).

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

ListModelPackages, listModelPackages_modelApprovalStatus - A filter that returns only the model packages with the specified approval status.

ListModelPackages, listModelPackages_modelPackageGroupName - A filter that returns only model versions that belong to the specified model group.

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

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
• VERSIONED - List only versioned models.
• BOTH - List both versioned and unversioned models.

$sel:nameContains:ListModelPackages', listModelPackages_nameContains - A string in the model package name. This filter returns only model packages whose name contains the specified string.

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:sortBy:ListModelPackages', listModelPackages_sortBy - The parameter by which to sort the results. The default is CreationTime.

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

Request Lenses

listModelPackages_creationTimeAfter :: Lens' ListModelPackages (Maybe UTCTime)

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

listModelPackages_creationTimeBefore :: Lens' ListModelPackages (Maybe UTCTime)

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

listModelPackages_maxResults :: Lens' ListModelPackages (Maybe Natural)

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

listModelPackages_modelApprovalStatus :: Lens' ListModelPackages (Maybe ModelApprovalStatus)

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

listModelPackages_modelPackageGroupName :: Lens' ListModelPackages (Maybe Text)

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

listModelPackages_modelPackageType :: Lens' ListModelPackages (Maybe ModelPackageType)

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

• UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.
• VERSIONED - List only versioned models.
• BOTH - List both versioned and unversioned models.

listModelPackages_nameContains :: Lens' ListModelPackages (Maybe Text)

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

listModelPackages_nextToken :: Lens' ListModelPackages (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.

listModelPackages_sortBy :: Lens' ListModelPackages (Maybe ModelPackageSortBy)

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

listModelPackages_sortOrder :: Lens' ListModelPackages (Maybe SortOrder)

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

Destructuring the Response

data ListModelPackagesResponse

See: newListModelPackagesResponse smart constructor.

Constructors

ListModelPackagesResponse'

Fields

• nextToken :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

• modelPackageSummaryList :: [ModelPackageSummary]

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

Instances

Generic ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

Associated Types

type Rep ListModelPackagesResponse :: Type -> Type

Methods

from :: ListModelPackagesResponse -> Rep ListModelPackagesResponse x

to :: Rep ListModelPackagesResponse x -> ListModelPackagesResponse

Read ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

Methods

readsPrec :: Int -> ReadS ListModelPackagesResponse

readList :: ReadS [ListModelPackagesResponse]

readPrec :: ReadPrec ListModelPackagesResponse

readListPrec :: ReadPrec [ListModelPackagesResponse]

Show ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

Methods

showsPrec :: Int -> ListModelPackagesResponse -> ShowS

show :: ListModelPackagesResponse -> String

showList :: [ListModelPackagesResponse] -> ShowS

NFData ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

Methods

rnf :: ListModelPackagesResponse -> ()

Eq ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

Methods

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

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

type Rep ListModelPackagesResponse

Defined in Amazonka.SageMaker.ListModelPackages

type Rep ListModelPackagesResponse = D1 ('MetaData "ListModelPackagesResponse" "Amazonka.SageMaker.ListModelPackages" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" '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

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:

ListModelPackages, listModelPackagesResponse_nextToken - If the response is truncated, 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)

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

listModelPackagesResponse_httpStatus :: Lens' ListModelPackagesResponse Int

The response's http status code.

listModelPackagesResponse_modelPackageSummaryList :: Lens' ListModelPackagesResponse [ModelPackageSummary]

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