amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.ListAlgorithms

Description

Lists the machine learning algorithms that have been created.

This operation returns paginated results.

Synopsis

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

ToHeaders ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

ToPath ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

ToQuery ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

AWSPager ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

AWSRequest ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Associated Types

type AWSResponse ListAlgorithms #

Generic ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Associated Types

type Rep ListAlgorithms :: Type -> Type #

Read ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Show ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

NFData ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Methods

rnf :: ListAlgorithms -> () #

Eq ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Hashable ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

type AWSResponse ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

type Rep ListAlgorithms Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

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

Instances

Instances details
Generic ListAlgorithmsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Associated Types

type Rep ListAlgorithmsResponse :: Type -> Type #

Read ListAlgorithmsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Show ListAlgorithmsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

NFData ListAlgorithmsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

Methods

rnf :: ListAlgorithmsResponse -> () #

Eq ListAlgorithmsResponse Source # 
Instance details

Defined in Amazonka.SageMaker.ListAlgorithms

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 #

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_algorithmSummaryList :: Lens' ListAlgorithmsResponse [AlgorithmSummary] Source #

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

algorithm.