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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

This operation returns paginated results.

Synopsis

data ListTrials = ListTrials' {
- createdAfter :: Maybe POSIX
- createdBefore :: Maybe POSIX
- experimentName :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- sortBy :: Maybe SortTrialsBy
- sortOrder :: Maybe SortOrder
- trialComponentName :: Maybe Text
}
newListTrials :: ListTrials
listTrials_createdAfter :: Lens' ListTrials (Maybe UTCTime)
listTrials_createdBefore :: Lens' ListTrials (Maybe UTCTime)
listTrials_experimentName :: Lens' ListTrials (Maybe Text)
listTrials_maxResults :: Lens' ListTrials (Maybe Natural)
listTrials_nextToken :: Lens' ListTrials (Maybe Text)
listTrials_sortBy :: Lens' ListTrials (Maybe SortTrialsBy)
listTrials_sortOrder :: Lens' ListTrials (Maybe SortOrder)
listTrials_trialComponentName :: Lens' ListTrials (Maybe Text)
data ListTrialsResponse = ListTrialsResponse' {
- nextToken :: Maybe Text
- trialSummaries :: Maybe [TrialSummary]
- httpStatus :: Int
}
newListTrialsResponse :: Int -> ListTrialsResponse
listTrialsResponse_nextToken :: Lens' ListTrialsResponse (Maybe Text)
listTrialsResponse_trialSummaries :: Lens' ListTrialsResponse (Maybe [TrialSummary])
listTrialsResponse_httpStatus :: Lens' ListTrialsResponse Int

Creating a Request

data ListTrials Source #

See: newListTrials smart constructor.

Constructors

ListTrials'

Fields

createdAfter :: Maybe POSIX
A filter that returns only trials created after the specified time.
createdBefore :: Maybe POSIX
A filter that returns only trials created before the specified time.
experimentName :: Maybe Text
A filter that returns only trials that are part of the specified experiment.
maxResults :: Maybe Natural
The maximum number of trials to return in the response. The default value is 10.
nextToken :: Maybe Text
If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.
sortBy :: Maybe SortTrialsBy
The property used to sort results. The default value is CreationTime.
sortOrder :: Maybe SortOrder
The sort order. The default value is Descending.
trialComponentName :: Maybe Text
A filter that returns only trials that are associated with the specified trial component.

Instances

Instances details

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

newListTrials :: ListTrials Source #

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

ListTrials, listTrials_createdAfter - A filter that returns only trials created after the specified time.

ListTrials, listTrials_createdBefore - A filter that returns only trials created before the specified time.

ListTrials, listTrials_experimentName - A filter that returns only trials that are part of the specified experiment.

$sel:maxResults:ListTrials', listTrials_maxResults - The maximum number of trials to return in the response. The default value is 10.

ListTrials, listTrials_nextToken - If the previous call to ListTrials didn't return the full set of trials, the call returns a token for getting the next set of trials.

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

$sel:sortOrder:ListTrials', listTrials_sortOrder - The sort order. The default value is Descending.

ListTrials, listTrials_trialComponentName - A filter that returns only trials that are associated with the specified trial component.

Request Lenses

listTrials_createdAfter :: Lens' ListTrials (Maybe UTCTime) Source #

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

listTrials_createdBefore :: Lens' ListTrials (Maybe UTCTime) Source #

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

listTrials_experimentName :: Lens' ListTrials (Maybe Text) Source #

A filter that returns only trials that are part of the specified experiment.

listTrials_maxResults :: Lens' ListTrials (Maybe Natural) Source #

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

listTrials_nextToken :: Lens' ListTrials (Maybe Text) Source #

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

listTrials_sortBy :: Lens' ListTrials (Maybe SortTrialsBy) Source #

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

listTrials_sortOrder :: Lens' ListTrials (Maybe SortOrder) Source #

The sort order. The default value is Descending.

listTrials_trialComponentName :: Lens' ListTrials (Maybe Text) Source #

A filter that returns only trials that are associated with the specified trial component.

Destructuring the Response

data ListTrialsResponse Source #

See: newListTrialsResponse smart constructor.

Constructors

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

Instances

Instances details

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

newListTrialsResponse Source #

Arguments

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

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

ListTrials, listTrialsResponse_nextToken - A token for getting the next set of trials, if there are any.

$sel:trialSummaries:ListTrialsResponse', listTrialsResponse_trialSummaries - A list of the summaries of your trials.

$sel:httpStatus:ListTrialsResponse', listTrialsResponse_httpStatus - The response's http status code.

Response Lenses

listTrialsResponse_nextToken :: Lens' ListTrialsResponse (Maybe Text) Source #

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

listTrialsResponse_trialSummaries :: Lens' ListTrialsResponse (Maybe [TrialSummary]) Source #

A list of the summaries of your trials.

listTrialsResponse_httpStatus :: Lens' ListTrialsResponse Int Source #

The response's http status code.