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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

This operation returns paginated results.

Synopsis

Creating a Request

data ListHyperParameterTuningJobs Source #

See: newListHyperParameterTuningJobs smart constructor.

Constructors

ListHyperParameterTuningJobs'

Fields

creationTimeAfter :: Maybe POSIX
A filter that returns only tuning jobs that were created after the specified time.
creationTimeBefore :: Maybe POSIX
A filter that returns only tuning jobs that were created before the specified time.
lastModifiedTimeAfter :: Maybe POSIX
A filter that returns only tuning jobs that were modified after the specified time.
lastModifiedTimeBefore :: Maybe POSIX
A filter that returns only tuning jobs that were modified before the specified time.
maxResults :: Maybe Natural
The maximum number of tuning jobs to return. The default value is 10.
nameContains :: Maybe Text
A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.
nextToken :: Maybe Text
If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.
sortBy :: Maybe HyperParameterTuningJobSortByOptions
The field to sort results by. The default is Name.
sortOrder :: Maybe SortOrder
The sort order for results. The default is Ascending.
statusEquals :: Maybe HyperParameterTuningJobStatus
A filter that returns only tuning jobs with the specified status.

Instances

Instances details

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

newListHyperParameterTuningJobs :: ListHyperParameterTuningJobs Source #

Create a value of ListHyperParameterTuningJobs 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:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_creationTimeAfter - A filter that returns only tuning jobs that were created after the specified time.

$sel:creationTimeBefore:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_creationTimeBefore - A filter that returns only tuning jobs that were created before the specified time.

$sel:lastModifiedTimeAfter:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_lastModifiedTimeAfter - A filter that returns only tuning jobs that were modified after the specified time.

$sel:lastModifiedTimeBefore:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_lastModifiedTimeBefore - A filter that returns only tuning jobs that were modified before the specified time.

$sel:maxResults:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_maxResults - The maximum number of tuning jobs to return. The default value is 10.

$sel:nameContains:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_nameContains - A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

ListHyperParameterTuningJobs, listHyperParameterTuningJobs_nextToken - If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

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

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

$sel:statusEquals:ListHyperParameterTuningJobs', listHyperParameterTuningJobs_statusEquals - A filter that returns only tuning jobs with the specified status.

Request Lenses

listHyperParameterTuningJobs_creationTimeAfter :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were created after the specified time.

listHyperParameterTuningJobs_creationTimeBefore :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were created before the specified time.

listHyperParameterTuningJobs_lastModifiedTimeAfter :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were modified after the specified time.

listHyperParameterTuningJobs_lastModifiedTimeBefore :: Lens' ListHyperParameterTuningJobs (Maybe UTCTime) Source #

A filter that returns only tuning jobs that were modified before the specified time.

listHyperParameterTuningJobs_maxResults :: Lens' ListHyperParameterTuningJobs (Maybe Natural) Source #

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

listHyperParameterTuningJobs_nameContains :: Lens' ListHyperParameterTuningJobs (Maybe Text) Source #

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

listHyperParameterTuningJobs_nextToken :: Lens' ListHyperParameterTuningJobs (Maybe Text) Source #

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

listHyperParameterTuningJobs_sortBy :: Lens' ListHyperParameterTuningJobs (Maybe HyperParameterTuningJobSortByOptions) Source #

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

listHyperParameterTuningJobs_sortOrder :: Lens' ListHyperParameterTuningJobs (Maybe SortOrder) Source #

The sort order for results. The default is Ascending.

listHyperParameterTuningJobs_statusEquals :: Lens' ListHyperParameterTuningJobs (Maybe HyperParameterTuningJobStatus) Source #

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

Destructuring the Response

data ListHyperParameterTuningJobsResponse Source #

See: newListHyperParameterTuningJobsResponse smart constructor.

Constructors

ListHyperParameterTuningJobsResponse'

Fields

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

Instances

Instances details

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

newListHyperParameterTuningJobsResponse Source #

Arguments

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

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

ListHyperParameterTuningJobs, listHyperParameterTuningJobsResponse_nextToken - If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

$sel:httpStatus:ListHyperParameterTuningJobsResponse', listHyperParameterTuningJobsResponse_httpStatus - The response's http status code.

$sel:hyperParameterTuningJobSummaries:ListHyperParameterTuningJobsResponse', listHyperParameterTuningJobsResponse_hyperParameterTuningJobSummaries - A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

Response Lenses

listHyperParameterTuningJobsResponse_nextToken :: Lens' ListHyperParameterTuningJobsResponse (Maybe Text) Source #

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

listHyperParameterTuningJobsResponse_httpStatus :: Lens' ListHyperParameterTuningJobsResponse Int Source #

The response's http status code.

listHyperParameterTuningJobsResponse_hyperParameterTuningJobSummaries :: Lens' ListHyperParameterTuningJobsResponse [HyperParameterTuningJobSummary] Source #

A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.