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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the machine learning algorithms that have been created.

This operation returns paginated results.

Synopsis

data ListAlgorithms = ListAlgorithms' {
- creationTimeAfter :: Maybe POSIX
- creationTimeBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nameContains :: Maybe Text
- nextToken :: Maybe Text
- sortBy :: Maybe AlgorithmSortBy
- sortOrder :: Maybe SortOrder
}
newListAlgorithms :: ListAlgorithms
listAlgorithms_creationTimeAfter :: Lens' ListAlgorithms (Maybe UTCTime)
listAlgorithms_creationTimeBefore :: Lens' ListAlgorithms (Maybe UTCTime)
listAlgorithms_maxResults :: Lens' ListAlgorithms (Maybe Natural)
listAlgorithms_nameContains :: Lens' ListAlgorithms (Maybe Text)
listAlgorithms_nextToken :: Lens' ListAlgorithms (Maybe Text)
listAlgorithms_sortBy :: Lens' ListAlgorithms (Maybe AlgorithmSortBy)
listAlgorithms_sortOrder :: Lens' ListAlgorithms (Maybe SortOrder)
data ListAlgorithmsResponse = ListAlgorithmsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- algorithmSummaryList :: [AlgorithmSummary]
}
newListAlgorithmsResponse :: Int -> ListAlgorithmsResponse
listAlgorithmsResponse_nextToken :: Lens' ListAlgorithmsResponse (Maybe Text)
listAlgorithmsResponse_httpStatus :: Lens' ListAlgorithmsResponse Int
listAlgorithmsResponse_algorithmSummaryList :: Lens' ListAlgorithmsResponse [AlgorithmSummary]

Creating a Request

data ListAlgorithms Source #

See: newListAlgorithms smart constructor.

Constructors

ListAlgorithms'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only algorithms created after the specified time (timestamp).
creationTimeBefore :: Maybe POSIX
A filter that returns only algorithms created before the specified time (timestamp).
maxResults :: Maybe Natural
The maximum number of algorithms to return in the response.
nameContains :: Maybe Text
A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.
nextToken :: Maybe Text
If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.
sortBy :: Maybe AlgorithmSortBy
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

Instances details

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

newListAlgorithms :: ListAlgorithms Source #

Create a value of ListAlgorithms 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:ListAlgorithms', listAlgorithms_creationTimeAfter - A filter that returns only algorithms created after the specified time (timestamp).

$sel:creationTimeBefore:ListAlgorithms', listAlgorithms_creationTimeBefore - A filter that returns only algorithms created before the specified time (timestamp).

$sel:maxResults:ListAlgorithms', listAlgorithms_maxResults - The maximum number of algorithms to return in the response.

$sel:nameContains:ListAlgorithms', listAlgorithms_nameContains - A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

ListAlgorithms, listAlgorithms_nextToken - If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

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

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

Request Lenses

listAlgorithms_creationTimeAfter :: Lens' ListAlgorithms (Maybe UTCTime) Source #

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

listAlgorithms_creationTimeBefore :: Lens' ListAlgorithms (Maybe UTCTime) Source #

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

listAlgorithms_maxResults :: Lens' ListAlgorithms (Maybe Natural) Source #

The maximum number of algorithms to return in the response.

listAlgorithms_nameContains :: Lens' ListAlgorithms (Maybe Text) Source #

A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

listAlgorithms_nextToken :: Lens' ListAlgorithms (Maybe Text) Source #

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

listAlgorithms_sortBy :: Lens' ListAlgorithms (Maybe AlgorithmSortBy) Source #

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

listAlgorithms_sortOrder :: Lens' ListAlgorithms (Maybe SortOrder) Source #

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

Destructuring the Response

data ListAlgorithmsResponse Source #

See: newListAlgorithmsResponse smart constructor.

Constructors

ListAlgorithmsResponse'
Fields nextToken :: Maybe Text If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request. httpStatus :: Int The response's http status code. algorithmSummaryList :: [AlgorithmSummary] An array of @AlgorithmSummary@ objects, each of which lists an algorithm.

Instances

Instances details

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

newListAlgorithmsResponse Source #

Arguments

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

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

ListAlgorithms, listAlgorithmsResponse_nextToken - If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

$sel:httpStatus:ListAlgorithmsResponse', listAlgorithmsResponse_httpStatus - The response's http status code.

$sel:algorithmSummaryList:ListAlgorithmsResponse', listAlgorithmsResponse_algorithmSummaryList - >An array of AlgorithmSummary objects, each of which lists an algorithm.

Response Lenses

listAlgorithmsResponse_nextToken :: Lens' ListAlgorithmsResponse (Maybe Text) Source #

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

listAlgorithmsResponse_httpStatus :: Lens' ListAlgorithmsResponse Int Source #

The response's http status code.

listAlgorithmsResponse_algorithmSummaryList :: Lens' ListAlgorithmsResponse [AlgorithmSummary] Source #

An array of @AlgorithmSummary@ objects, each of which lists an

algorithm.