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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the artifacts in your account and their properties.

This operation returns paginated results.

Synopsis

data ListArtifacts = ListArtifacts' {
- artifactType :: Maybe Text
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortArtifactsBy
- sortOrder :: Maybe SortOrder
- sourceUri :: Maybe Text
}
newListArtifacts :: ListArtifacts
listArtifacts_artifactType :: Lens' ListArtifacts (Maybe Text)
listArtifacts_createdAfter :: Lens' ListArtifacts (Maybe UTCTime)
listArtifacts_createdBefore :: Lens' ListArtifacts (Maybe UTCTime)
listArtifacts_maxResults :: Lens' ListArtifacts (Maybe Natural)
listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text)
listArtifacts_sortBy :: Lens' ListArtifacts (Maybe SortArtifactsBy)
listArtifacts_sortOrder :: Lens' ListArtifacts (Maybe SortOrder)
listArtifacts_sourceUri :: Lens' ListArtifacts (Maybe Text)
data ListArtifactsResponse = ListArtifactsResponse' {
- artifactSummaries :: Maybe [ArtifactSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListArtifactsResponse :: Int -> ListArtifactsResponse
listArtifactsResponse_artifactSummaries :: Lens' ListArtifactsResponse (Maybe [ArtifactSummary])
listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text)
listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int

Creating a Request

data ListArtifacts Source #

See: newListArtifacts smart constructor.

Constructors

ListArtifacts'

Fields

artifactType :: Maybe Text
A filter that returns only artifacts of the specified type.
createdAfter :: Maybe POSIX
A filter that returns only artifacts created on or after the specified time.
createdBefore :: Maybe POSIX
A filter that returns only artifacts created on or before the specified time.
maxResults :: Maybe Natural
The maximum number of artifacts to return in the response. The default value is 10.
nextToken :: Maybe Text
If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.
sortBy :: Maybe SortArtifactsBy
The property used to sort results. The default value is CreationTime.
sortOrder :: Maybe SortOrder
The sort order. The default value is Descending.
sourceUri :: Maybe Text
A filter that returns only artifacts with the specified source URI.

Instances

Instances details

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

newListArtifacts :: ListArtifacts Source #

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

ListArtifacts, listArtifacts_artifactType - A filter that returns only artifacts of the specified type.

ListArtifacts, listArtifacts_createdAfter - A filter that returns only artifacts created on or after the specified time.

ListArtifacts, listArtifacts_createdBefore - A filter that returns only artifacts created on or before the specified time.

$sel:maxResults:ListArtifacts', listArtifacts_maxResults - The maximum number of artifacts to return in the response. The default value is 10.

ListArtifacts, listArtifacts_nextToken - If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.

$sel:sortBy:ListArtifacts', listArtifacts_sortBy - The property used to sort results. The default value is CreationTime.

$sel:sortOrder:ListArtifacts', listArtifacts_sortOrder - The sort order. The default value is Descending.

ListArtifacts, listArtifacts_sourceUri - A filter that returns only artifacts with the specified source URI.

Request Lenses

listArtifacts_artifactType :: Lens' ListArtifacts (Maybe Text) Source #

A filter that returns only artifacts of the specified type.

listArtifacts_createdAfter :: Lens' ListArtifacts (Maybe UTCTime) Source #

A filter that returns only artifacts created on or after the specified time.

listArtifacts_createdBefore :: Lens' ListArtifacts (Maybe UTCTime) Source #

A filter that returns only artifacts created on or before the specified time.

listArtifacts_maxResults :: Lens' ListArtifacts (Maybe Natural) Source #

The maximum number of artifacts to return in the response. The default value is 10.

listArtifacts_nextToken :: Lens' ListArtifacts (Maybe Text) Source #

If the previous call to ListArtifacts didn't return the full set of artifacts, the call returns a token for getting the next set of artifacts.

listArtifacts_sortBy :: Lens' ListArtifacts (Maybe SortArtifactsBy) Source #

The property used to sort results. The default value is CreationTime.

listArtifacts_sortOrder :: Lens' ListArtifacts (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listArtifacts_sourceUri :: Lens' ListArtifacts (Maybe Text) Source #

A filter that returns only artifacts with the specified source URI.

Destructuring the Response

data ListArtifactsResponse Source #

See: newListArtifactsResponse smart constructor.

Constructors

ListArtifactsResponse'
Fields artifactSummaries :: Maybe [ArtifactSummary] A list of artifacts and their properties. nextToken :: Maybe Text A token for getting the next set of artifacts, if there are any. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListArtifactsResponse Source #

Arguments

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

Create a value of ListArtifactsResponse 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:artifactSummaries:ListArtifactsResponse', listArtifactsResponse_artifactSummaries - A list of artifacts and their properties.

ListArtifacts, listArtifactsResponse_nextToken - A token for getting the next set of artifacts, if there are any.

$sel:httpStatus:ListArtifactsResponse', listArtifactsResponse_httpStatus - The response's http status code.

Response Lenses

listArtifactsResponse_artifactSummaries :: Lens' ListArtifactsResponse (Maybe [ArtifactSummary]) Source #

A list of artifacts and their properties.

listArtifactsResponse_nextToken :: Lens' ListArtifactsResponse (Maybe Text) Source #

A token for getting the next set of artifacts, if there are any.

listArtifactsResponse_httpStatus :: Lens' ListArtifactsResponse Int Source #

The response's http status code.