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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

This operation returns paginated results.

Synopsis

data ListExperiments = ListExperiments' {
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortExperimentsBy
- sortOrder :: Maybe SortOrder
}
newListExperiments :: ListExperiments
listExperiments_createdAfter :: Lens' ListExperiments (Maybe UTCTime)
listExperiments_createdBefore :: Lens' ListExperiments (Maybe UTCTime)
listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural)
listExperiments_nextToken :: Lens' ListExperiments (Maybe Text)
listExperiments_sortBy :: Lens' ListExperiments (Maybe SortExperimentsBy)
listExperiments_sortOrder :: Lens' ListExperiments (Maybe SortOrder)
data ListExperimentsResponse = ListExperimentsResponse' {
- experimentSummaries :: Maybe [ExperimentSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListExperimentsResponse :: Int -> ListExperimentsResponse
listExperimentsResponse_experimentSummaries :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary])
listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text)
listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int

Creating a Request

data ListExperiments Source #

See: newListExperiments smart constructor.

Constructors

ListExperiments'

Fields

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

Instances

Instances details

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

newListExperiments :: ListExperiments Source #

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

ListExperiments, listExperiments_createdAfter - A filter that returns only experiments created after the specified time.

ListExperiments, listExperiments_createdBefore - A filter that returns only experiments created before the specified time.

$sel:maxResults:ListExperiments', listExperiments_maxResults - The maximum number of experiments to return in the response. The default value is 10.

ListExperiments, listExperiments_nextToken - If the previous call to ListExperiments didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

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

$sel:sortOrder:ListExperiments', listExperiments_sortOrder - The sort order. The default value is Descending.

Request Lenses

listExperiments_createdAfter :: Lens' ListExperiments (Maybe UTCTime) Source #

A filter that returns only experiments created after the specified time.

listExperiments_createdBefore :: Lens' ListExperiments (Maybe UTCTime) Source #

A filter that returns only experiments created before the specified time.

listExperiments_maxResults :: Lens' ListExperiments (Maybe Natural) Source #

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

listExperiments_nextToken :: Lens' ListExperiments (Maybe Text) Source #

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

listExperiments_sortBy :: Lens' ListExperiments (Maybe SortExperimentsBy) Source #

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

listExperiments_sortOrder :: Lens' ListExperiments (Maybe SortOrder) Source #

The sort order. The default value is Descending.

Destructuring the Response

data ListExperimentsResponse Source #

See: newListExperimentsResponse smart constructor.

Constructors

ListExperimentsResponse'
Fields experimentSummaries :: Maybe [ExperimentSummary] A list of the summaries of your experiments. nextToken :: Maybe Text A token for getting the next set of experiments, if there are any. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListExperimentsResponse Source #

Arguments

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

Create a value of ListExperimentsResponse 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:experimentSummaries:ListExperimentsResponse', listExperimentsResponse_experimentSummaries - A list of the summaries of your experiments.

ListExperiments, listExperimentsResponse_nextToken - A token for getting the next set of experiments, if there are any.

$sel:httpStatus:ListExperimentsResponse', listExperimentsResponse_httpStatus - The response's http status code.

Response Lenses

listExperimentsResponse_experimentSummaries :: Lens' ListExperimentsResponse (Maybe [ExperimentSummary]) Source #

A list of the summaries of your experiments.

listExperimentsResponse_nextToken :: Lens' ListExperimentsResponse (Maybe Text) Source #

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

listExperimentsResponse_httpStatus :: Lens' ListExperimentsResponse Int Source #

The response's http status code.