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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List existing model cards.

This operation returns paginated results.

Synopsis

data ListModelCards = ListModelCards' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- modelCardStatus :: Maybe ModelCardStatus
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe ModelCardSortBy
- sortOrder :: Maybe ModelCardSortOrder
}
newListModelCards :: ListModelCards
listModelCards_creationTimeAfter :: Lens' ListModelCards (Maybe UTCTime)
listModelCards_creationTimeBefore :: Lens' ListModelCards (Maybe UTCTime)
listModelCards_maxResults :: Lens' ListModelCards (Maybe Natural)
listModelCards_modelCardStatus :: Lens' ListModelCards (Maybe ModelCardStatus)
listModelCards_nameContains :: Lens' ListModelCards (Maybe Text)
listModelCards_nextToken :: Lens' ListModelCards (Maybe Text)
listModelCards_sortBy :: Lens' ListModelCards (Maybe ModelCardSortBy)
listModelCards_sortOrder :: Lens' ListModelCards (Maybe ModelCardSortOrder)
data ListModelCardsResponse = ListModelCardsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- modelCardSummaries :: [ModelCardSummary]
}
newListModelCardsResponse :: Int -> ListModelCardsResponse
listModelCardsResponse_nextToken :: Lens' ListModelCardsResponse (Maybe Text)
listModelCardsResponse_httpStatus :: Lens' ListModelCardsResponse Int
listModelCardsResponse_modelCardSummaries :: Lens' ListModelCardsResponse [ModelCardSummary]

Creating a Request

data ListModelCards Source #

See: newListModelCards smart constructor.

Constructors

ListModelCards'

Fields

creationTimeAfter :: Maybe POSIX
Only list model cards that were created after the time specified.
creationTimeBefore :: Maybe POSIX
Only list model cards that were created before the time specified.
maxResults :: Maybe Natural
The maximum number of model cards to list.
modelCardStatus :: Maybe ModelCardStatus
Only list model cards with the specified approval status.
nameContains :: Maybe Text
Only list model cards with names that contain the specified string.
nextToken :: Maybe Text
If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.
sortBy :: Maybe ModelCardSortBy
Sort model cards by either name or creation time. Sorts by creation time by default.
sortOrder :: Maybe ModelCardSortOrder
Sort model cards by ascending or descending order.

Instances

Instances details

ToJSON ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods toJSON :: ListModelCards -> Value # toEncoding :: ListModelCards -> Encoding # toJSONList :: [ListModelCards] -> Value # toEncodingList :: [ListModelCards] -> Encoding #
ToHeaders ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods toHeaders :: ListModelCards -> [Header] #
ToPath ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods toPath :: ListModelCards -> ByteString #
ToQuery ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods toQuery :: ListModelCards -> QueryString #
AWSPager ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods page :: ListModelCards -> AWSResponse ListModelCards -> Maybe ListModelCards #
AWSRequest ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Associated Types type AWSResponse ListModelCards # Methods request :: (Service -> Service) -> ListModelCards -> Request ListModelCards # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListModelCards -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListModelCards))) #
Generic ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Associated Types type Rep ListModelCards :: Type -> Type # Methods from :: ListModelCards -> Rep ListModelCards x # to :: Rep ListModelCards x -> ListModelCards #
Read ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods readsPrec :: Int -> ReadS ListModelCards # readList :: ReadS [ListModelCards] # readPrec :: ReadPrec ListModelCards # readListPrec :: ReadPrec [ListModelCards] #
Show ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods showsPrec :: Int -> ListModelCards -> ShowS # show :: ListModelCards -> String # showList :: [ListModelCards] -> ShowS #
NFData ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods rnf :: ListModelCards -> () #
Eq ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods (==) :: ListModelCards -> ListModelCards -> Bool # (/=) :: ListModelCards -> ListModelCards -> Bool #
Hashable ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards Methods hashWithSalt :: Int -> ListModelCards -> Int # hash :: ListModelCards -> Int #
type AWSResponse ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards type AWSResponse ListModelCards = ListModelCardsResponse
type Rep ListModelCards Source #
Instance details Defined in Amazonka.SageMaker.ListModelCards type Rep ListModelCards = D1 ('MetaData "ListModelCards" "Amazonka.SageMaker.ListModelCards" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "ListModelCards'" '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 "modelCardStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelCardStatus)))) :: ((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 ModelCardSortBy)) :*: S1 ('MetaSel ('Just "sortOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ModelCardSortOrder))))))

newListModelCards :: ListModelCards Source #

Create a value of ListModelCards 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:ListModelCards', listModelCards_creationTimeAfter - Only list model cards that were created after the time specified.

$sel:creationTimeBefore:ListModelCards', listModelCards_creationTimeBefore - Only list model cards that were created before the time specified.

$sel:maxResults:ListModelCards', listModelCards_maxResults - The maximum number of model cards to list.

ListModelCards, listModelCards_modelCardStatus - Only list model cards with the specified approval status.

$sel:nameContains:ListModelCards', listModelCards_nameContains - Only list model cards with names that contain the specified string.

ListModelCards, listModelCards_nextToken - If the response to a previous ListModelCards request was truncated, the response includes a NextToken. To retrieve the next set of model cards, use the token in the next request.

$sel:sortBy:ListModelCards', listModelCards_sortBy - Sort model cards by either name or creation time. Sorts by creation time by default.

$sel:sortOrder:ListModelCards', listModelCards_sortOrder - Sort model cards by ascending or descending order.

Request Lenses

listModelCards_creationTimeAfter :: Lens' ListModelCards (Maybe UTCTime) Source #

Only list model cards that were created after the time specified.

listModelCards_creationTimeBefore :: Lens' ListModelCards (Maybe UTCTime) Source #

Only list model cards that were created before the time specified.

listModelCards_maxResults :: Lens' ListModelCards (Maybe Natural) Source #

The maximum number of model cards to list.

listModelCards_modelCardStatus :: Lens' ListModelCards (Maybe ModelCardStatus) Source #

Only list model cards with the specified approval status.

listModelCards_nameContains :: Lens' ListModelCards (Maybe Text) Source #

Only list model cards with names that contain the specified string.

listModelCards_nextToken :: Lens' ListModelCards (Maybe Text) Source #

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

listModelCards_sortBy :: Lens' ListModelCards (Maybe ModelCardSortBy) Source #

Sort model cards by either name or creation time. Sorts by creation time by default.

listModelCards_sortOrder :: Lens' ListModelCards (Maybe ModelCardSortOrder) Source #

Sort model cards by ascending or descending order.

Destructuring the Response

data ListModelCardsResponse Source #

See: newListModelCardsResponse smart constructor.

Constructors

ListModelCardsResponse'
Fields nextToken :: Maybe Text If the response is truncated, SageMaker returns this token. To retrieve the next set of model cards, use it in the subsequent request. httpStatus :: Int The response's http status code. modelCardSummaries :: [ModelCardSummary] The summaries of the listed model cards.

Instances

Instances details

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

newListModelCardsResponse Source #

Arguments

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

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

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

$sel:httpStatus:ListModelCardsResponse', listModelCardsResponse_httpStatus - The response's http status code.

$sel:modelCardSummaries:ListModelCardsResponse', listModelCardsResponse_modelCardSummaries - The summaries of the listed model cards.

Response Lenses

listModelCardsResponse_nextToken :: Lens' ListModelCardsResponse (Maybe Text) Source #

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

listModelCardsResponse_httpStatus :: Lens' ListModelCardsResponse Int Source #

The response's http status code.

listModelCardsResponse_modelCardSummaries :: Lens' ListModelCardsResponse [ModelCardSummary] Source #

The summaries of the listed model cards.