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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

This operation returns paginated results.

Synopsis

Creating a Request

data ListTrainingJobsForHyperParameterTuningJob Source #

See: newListTrainingJobsForHyperParameterTuningJob smart constructor.

Constructors

ListTrainingJobsForHyperParameterTuningJob'

Fields

maxResults :: Maybe Natural
The maximum number of training jobs to return. The default value is 10.
nextToken :: Maybe Text
If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
sortBy :: Maybe TrainingJobSortByOptions
The field to sort results by. The default is Name.
If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.
sortOrder :: Maybe SortOrder
The sort order for results. The default is Ascending.
statusEquals :: Maybe TrainingJobStatus
A filter that returns only training jobs with the specified status.
hyperParameterTuningJobName :: Text
The name of the tuning job whose training jobs you want to list.

Instances

Instances details

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

newListTrainingJobsForHyperParameterTuningJob Source #

Arguments

:: Text	`ListTrainingJobsForHyperParameterTuningJob`
-> ListTrainingJobsForHyperParameterTuningJob

Create a value of ListTrainingJobsForHyperParameterTuningJob 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:maxResults:ListTrainingJobsForHyperParameterTuningJob', listTrainingJobsForHyperParameterTuningJob_maxResults - The maximum number of training jobs to return. The default value is 10.

ListTrainingJobsForHyperParameterTuningJob, listTrainingJobsForHyperParameterTuningJob_nextToken - If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob', listTrainingJobsForHyperParameterTuningJob_sortBy - The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob', listTrainingJobsForHyperParameterTuningJob_sortOrder - The sort order for results. The default is Ascending.

$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob', listTrainingJobsForHyperParameterTuningJob_statusEquals - A filter that returns only training jobs with the specified status.

ListTrainingJobsForHyperParameterTuningJob, listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName - The name of the tuning job whose training jobs you want to list.

Request Lenses

listTrainingJobsForHyperParameterTuningJob_maxResults :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Natural) Source #

The maximum number of training jobs to return. The default value is 10.

listTrainingJobsForHyperParameterTuningJob_nextToken :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Text) Source #

If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

listTrainingJobsForHyperParameterTuningJob_sortBy :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe TrainingJobSortByOptions) Source #

The field to sort results by. The default is Name.

If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

listTrainingJobsForHyperParameterTuningJob_sortOrder :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listTrainingJobsForHyperParameterTuningJob_statusEquals :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe TrainingJobStatus) Source #

A filter that returns only training jobs with the specified status.

listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' ListTrainingJobsForHyperParameterTuningJob Text Source #

The name of the tuning job whose training jobs you want to list.

Destructuring the Response

data ListTrainingJobsForHyperParameterTuningJobResponse Source #

See: newListTrainingJobsForHyperParameterTuningJobResponse smart constructor.

Constructors

ListTrainingJobsForHyperParameterTuningJobResponse'

Fields

nextToken :: Maybe Text
If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.
httpStatus :: Int
The response's http status code.
trainingJobSummaries :: [HyperParameterTrainingJobSummary]
A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

Instances

Instances details

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

newListTrainingJobsForHyperParameterTuningJobResponse Source #

Arguments

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

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

ListTrainingJobsForHyperParameterTuningJob, listTrainingJobsForHyperParameterTuningJobResponse_nextToken - If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

$sel:httpStatus:ListTrainingJobsForHyperParameterTuningJobResponse', listTrainingJobsForHyperParameterTuningJobResponse_httpStatus - The response's http status code.

$sel:trainingJobSummaries:ListTrainingJobsForHyperParameterTuningJobResponse', listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries - A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

Response Lenses

listTrainingJobsForHyperParameterTuningJobResponse_nextToken :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse (Maybe Text) Source #

If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

listTrainingJobsForHyperParameterTuningJobResponse_httpStatus :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse Int Source #

The response's http status code.

listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse [HyperParameterTrainingJobSummary] Source #

A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.