{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.SageMaker.ListTrainingJobsForHyperParameterTuningJob
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets a list of TrainingJobSummary objects that describe the training
-- jobs that a hyperparameter tuning job launched.
--
-- This operation returns paginated results.
module Amazonka.SageMaker.ListTrainingJobsForHyperParameterTuningJob
  ( -- * Creating a Request
    ListTrainingJobsForHyperParameterTuningJob (..),
    newListTrainingJobsForHyperParameterTuningJob,

    -- * Request Lenses
    listTrainingJobsForHyperParameterTuningJob_maxResults,
    listTrainingJobsForHyperParameterTuningJob_nextToken,
    listTrainingJobsForHyperParameterTuningJob_sortBy,
    listTrainingJobsForHyperParameterTuningJob_sortOrder,
    listTrainingJobsForHyperParameterTuningJob_statusEquals,
    listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName,

    -- * Destructuring the Response
    ListTrainingJobsForHyperParameterTuningJobResponse (..),
    newListTrainingJobsForHyperParameterTuningJobResponse,

    -- * Response Lenses
    listTrainingJobsForHyperParameterTuningJobResponse_nextToken,
    listTrainingJobsForHyperParameterTuningJobResponse_httpStatus,
    listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
import Amazonka.SageMaker.Types

-- | /See:/ 'newListTrainingJobsForHyperParameterTuningJob' smart constructor.
data ListTrainingJobsForHyperParameterTuningJob = ListTrainingJobsForHyperParameterTuningJob'
  { -- | The maximum number of training jobs to return. The default value is 10.
    ListTrainingJobsForHyperParameterTuningJob -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | 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 -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | 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
-> Maybe TrainingJobSortByOptions
sortBy :: Prelude.Maybe TrainingJobSortByOptions,
    -- | The sort order for results. The default is @Ascending@.
    ListTrainingJobsForHyperParameterTuningJob -> Maybe SortOrder
sortOrder :: Prelude.Maybe SortOrder,
    -- | A filter that returns only training jobs with the specified status.
    ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobStatus
statusEquals :: Prelude.Maybe TrainingJobStatus,
    -- | The name of the tuning job whose training jobs you want to list.
    ListTrainingJobsForHyperParameterTuningJob -> Text
hyperParameterTuningJobName :: Prelude.Text
  }
  deriving (ListTrainingJobsForHyperParameterTuningJob
-> ListTrainingJobsForHyperParameterTuningJob -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListTrainingJobsForHyperParameterTuningJob
-> ListTrainingJobsForHyperParameterTuningJob -> Bool
$c/= :: ListTrainingJobsForHyperParameterTuningJob
-> ListTrainingJobsForHyperParameterTuningJob -> Bool
== :: ListTrainingJobsForHyperParameterTuningJob
-> ListTrainingJobsForHyperParameterTuningJob -> Bool
$c== :: ListTrainingJobsForHyperParameterTuningJob
-> ListTrainingJobsForHyperParameterTuningJob -> Bool
Prelude.Eq, ReadPrec [ListTrainingJobsForHyperParameterTuningJob]
ReadPrec ListTrainingJobsForHyperParameterTuningJob
Int -> ReadS ListTrainingJobsForHyperParameterTuningJob
ReadS [ListTrainingJobsForHyperParameterTuningJob]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListTrainingJobsForHyperParameterTuningJob]
$creadListPrec :: ReadPrec [ListTrainingJobsForHyperParameterTuningJob]
readPrec :: ReadPrec ListTrainingJobsForHyperParameterTuningJob
$creadPrec :: ReadPrec ListTrainingJobsForHyperParameterTuningJob
readList :: ReadS [ListTrainingJobsForHyperParameterTuningJob]
$creadList :: ReadS [ListTrainingJobsForHyperParameterTuningJob]
readsPrec :: Int -> ReadS ListTrainingJobsForHyperParameterTuningJob
$creadsPrec :: Int -> ReadS ListTrainingJobsForHyperParameterTuningJob
Prelude.Read, Int -> ListTrainingJobsForHyperParameterTuningJob -> ShowS
[ListTrainingJobsForHyperParameterTuningJob] -> ShowS
ListTrainingJobsForHyperParameterTuningJob -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListTrainingJobsForHyperParameterTuningJob] -> ShowS
$cshowList :: [ListTrainingJobsForHyperParameterTuningJob] -> ShowS
show :: ListTrainingJobsForHyperParameterTuningJob -> String
$cshow :: ListTrainingJobsForHyperParameterTuningJob -> String
showsPrec :: Int -> ListTrainingJobsForHyperParameterTuningJob -> ShowS
$cshowsPrec :: Int -> ListTrainingJobsForHyperParameterTuningJob -> ShowS
Prelude.Show, forall x.
Rep ListTrainingJobsForHyperParameterTuningJob x
-> ListTrainingJobsForHyperParameterTuningJob
forall x.
ListTrainingJobsForHyperParameterTuningJob
-> Rep ListTrainingJobsForHyperParameterTuningJob x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListTrainingJobsForHyperParameterTuningJob x
-> ListTrainingJobsForHyperParameterTuningJob
$cfrom :: forall x.
ListTrainingJobsForHyperParameterTuningJob
-> Rep ListTrainingJobsForHyperParameterTuningJob x
Prelude.Generic)

-- |
-- Create a value of 'ListTrainingJobsForHyperParameterTuningJob' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'maxResults', 'listTrainingJobsForHyperParameterTuningJob_maxResults' - The maximum number of training jobs to return. The default value is 10.
--
-- 'nextToken', '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.
--
-- 'sortBy', '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.
--
-- 'sortOrder', 'listTrainingJobsForHyperParameterTuningJob_sortOrder' - The sort order for results. The default is @Ascending@.
--
-- 'statusEquals', 'listTrainingJobsForHyperParameterTuningJob_statusEquals' - A filter that returns only training jobs with the specified status.
--
-- 'hyperParameterTuningJobName', 'listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName' - The name of the tuning job whose training jobs you want to list.
newListTrainingJobsForHyperParameterTuningJob ::
  -- | 'hyperParameterTuningJobName'
  Prelude.Text ->
  ListTrainingJobsForHyperParameterTuningJob
newListTrainingJobsForHyperParameterTuningJob :: Text -> ListTrainingJobsForHyperParameterTuningJob
newListTrainingJobsForHyperParameterTuningJob
  Text
pHyperParameterTuningJobName_ =
    ListTrainingJobsForHyperParameterTuningJob'
      { $sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: Maybe Natural
maxResults =
          forall a. Maybe a
Prelude.Nothing,
        $sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
        $sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: Maybe TrainingJobSortByOptions
sortBy = forall a. Maybe a
Prelude.Nothing,
        $sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: Maybe SortOrder
sortOrder = forall a. Maybe a
Prelude.Nothing,
        $sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: Maybe TrainingJobStatus
statusEquals = forall a. Maybe a
Prelude.Nothing,
        $sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: Text
hyperParameterTuningJobName =
          Text
pHyperParameterTuningJobName_
      }

-- | The maximum number of training jobs to return. The default value is 10.
listTrainingJobsForHyperParameterTuningJob_maxResults :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob (Prelude.Maybe Prelude.Natural)
listTrainingJobsForHyperParameterTuningJob_maxResults :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Natural)
listTrainingJobsForHyperParameterTuningJob_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Maybe Natural
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListTrainingJobsForHyperParameterTuningJob)

-- | 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_nextToken :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob (Prelude.Maybe Prelude.Text)
listTrainingJobsForHyperParameterTuningJob_nextToken :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Text)
listTrainingJobsForHyperParameterTuningJob_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Maybe Text
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: Maybe Text
nextToken = Maybe Text
a} :: ListTrainingJobsForHyperParameterTuningJob)

-- | 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_sortBy :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob (Prelude.Maybe TrainingJobSortByOptions)
listTrainingJobsForHyperParameterTuningJob_sortBy :: Lens'
  ListTrainingJobsForHyperParameterTuningJob
  (Maybe TrainingJobSortByOptions)
listTrainingJobsForHyperParameterTuningJob_sortBy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Maybe TrainingJobSortByOptions
sortBy :: Maybe TrainingJobSortByOptions
$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobSortByOptions
sortBy} -> Maybe TrainingJobSortByOptions
sortBy) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Maybe TrainingJobSortByOptions
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: Maybe TrainingJobSortByOptions
sortBy = Maybe TrainingJobSortByOptions
a} :: ListTrainingJobsForHyperParameterTuningJob)

-- | The sort order for results. The default is @Ascending@.
listTrainingJobsForHyperParameterTuningJob_sortOrder :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob (Prelude.Maybe SortOrder)
listTrainingJobsForHyperParameterTuningJob_sortOrder :: Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe SortOrder)
listTrainingJobsForHyperParameterTuningJob_sortOrder = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Maybe SortOrder
sortOrder :: Maybe SortOrder
$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe SortOrder
sortOrder} -> Maybe SortOrder
sortOrder) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Maybe SortOrder
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: Maybe SortOrder
sortOrder = Maybe SortOrder
a} :: ListTrainingJobsForHyperParameterTuningJob)

-- | A filter that returns only training jobs with the specified status.
listTrainingJobsForHyperParameterTuningJob_statusEquals :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob (Prelude.Maybe TrainingJobStatus)
listTrainingJobsForHyperParameterTuningJob_statusEquals :: Lens'
  ListTrainingJobsForHyperParameterTuningJob
  (Maybe TrainingJobStatus)
listTrainingJobsForHyperParameterTuningJob_statusEquals = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Maybe TrainingJobStatus
statusEquals :: Maybe TrainingJobStatus
$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobStatus
statusEquals} -> Maybe TrainingJobStatus
statusEquals) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Maybe TrainingJobStatus
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: Maybe TrainingJobStatus
statusEquals = Maybe TrainingJobStatus
a} :: ListTrainingJobsForHyperParameterTuningJob)

-- | The name of the tuning job whose training jobs you want to list.
listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJob Prelude.Text
listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' ListTrainingJobsForHyperParameterTuningJob Text
listTrainingJobsForHyperParameterTuningJob_hyperParameterTuningJobName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJob' {Text
hyperParameterTuningJobName :: Text
$sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Text
hyperParameterTuningJobName} -> Text
hyperParameterTuningJobName) (\s :: ListTrainingJobsForHyperParameterTuningJob
s@ListTrainingJobsForHyperParameterTuningJob' {} Text
a -> ListTrainingJobsForHyperParameterTuningJob
s {$sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: Text
hyperParameterTuningJobName = Text
a} :: ListTrainingJobsForHyperParameterTuningJob)

instance
  Core.AWSPager
    ListTrainingJobsForHyperParameterTuningJob
  where
  page :: ListTrainingJobsForHyperParameterTuningJob
-> AWSResponse ListTrainingJobsForHyperParameterTuningJob
-> Maybe ListTrainingJobsForHyperParameterTuningJob
page ListTrainingJobsForHyperParameterTuningJob
rq AWSResponse ListTrainingJobsForHyperParameterTuningJob
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListTrainingJobsForHyperParameterTuningJob
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens'
  ListTrainingJobsForHyperParameterTuningJobResponse (Maybe Text)
listTrainingJobsForHyperParameterTuningJobResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse ListTrainingJobsForHyperParameterTuningJob
rs
            forall s a. s -> Getting a s a -> a
Lens.^. Lens'
  ListTrainingJobsForHyperParameterTuningJobResponse
  [HyperParameterTrainingJobSummary]
listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ ListTrainingJobsForHyperParameterTuningJob
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' ListTrainingJobsForHyperParameterTuningJob (Maybe Text)
listTrainingJobsForHyperParameterTuningJob_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse ListTrainingJobsForHyperParameterTuningJob
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens'
  ListTrainingJobsForHyperParameterTuningJobResponse (Maybe Text)
listTrainingJobsForHyperParameterTuningJobResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance
  Core.AWSRequest
    ListTrainingJobsForHyperParameterTuningJob
  where
  type
    AWSResponse
      ListTrainingJobsForHyperParameterTuningJob =
      ListTrainingJobsForHyperParameterTuningJobResponse
  request :: (Service -> Service)
-> ListTrainingJobsForHyperParameterTuningJob
-> Request ListTrainingJobsForHyperParameterTuningJob
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListTrainingJobsForHyperParameterTuningJob
-> ClientResponse ClientBody
-> m (Either
        Error
        (ClientResponse
           (AWSResponse ListTrainingJobsForHyperParameterTuningJob)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text
-> Int
-> [HyperParameterTrainingJobSummary]
-> ListTrainingJobsForHyperParameterTuningJobResponse
ListTrainingJobsForHyperParameterTuningJobResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"NextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"TrainingJobSummaries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
      )

instance
  Prelude.Hashable
    ListTrainingJobsForHyperParameterTuningJob
  where
  hashWithSalt :: Int -> ListTrainingJobsForHyperParameterTuningJob -> Int
hashWithSalt
    Int
_salt
    ListTrainingJobsForHyperParameterTuningJob' {Maybe Natural
Maybe Text
Maybe SortOrder
Maybe TrainingJobSortByOptions
Maybe TrainingJobStatus
Text
hyperParameterTuningJobName :: Text
statusEquals :: Maybe TrainingJobStatus
sortOrder :: Maybe SortOrder
sortBy :: Maybe TrainingJobSortByOptions
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Text
$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobStatus
$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe SortOrder
$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobSortByOptions
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Text
$sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Natural
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TrainingJobSortByOptions
sortBy
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SortOrder
sortOrder
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TrainingJobStatus
statusEquals
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
hyperParameterTuningJobName

instance
  Prelude.NFData
    ListTrainingJobsForHyperParameterTuningJob
  where
  rnf :: ListTrainingJobsForHyperParameterTuningJob -> ()
rnf ListTrainingJobsForHyperParameterTuningJob' {Maybe Natural
Maybe Text
Maybe SortOrder
Maybe TrainingJobSortByOptions
Maybe TrainingJobStatus
Text
hyperParameterTuningJobName :: Text
statusEquals :: Maybe TrainingJobStatus
sortOrder :: Maybe SortOrder
sortBy :: Maybe TrainingJobSortByOptions
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Text
$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobStatus
$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe SortOrder
$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobSortByOptions
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Text
$sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TrainingJobSortByOptions
sortBy
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SortOrder
sortOrder
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe TrainingJobStatus
statusEquals
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
hyperParameterTuningJobName

instance
  Data.ToHeaders
    ListTrainingJobsForHyperParameterTuningJob
  where
  toHeaders :: ListTrainingJobsForHyperParameterTuningJob -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"SageMaker.ListTrainingJobsForHyperParameterTuningJob" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance
  Data.ToJSON
    ListTrainingJobsForHyperParameterTuningJob
  where
  toJSON :: ListTrainingJobsForHyperParameterTuningJob -> Value
toJSON
    ListTrainingJobsForHyperParameterTuningJob' {Maybe Natural
Maybe Text
Maybe SortOrder
Maybe TrainingJobSortByOptions
Maybe TrainingJobStatus
Text
hyperParameterTuningJobName :: Text
statusEquals :: Maybe TrainingJobStatus
sortOrder :: Maybe SortOrder
sortBy :: Maybe TrainingJobSortByOptions
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:hyperParameterTuningJobName:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Text
$sel:statusEquals:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobStatus
$sel:sortOrder:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe SortOrder
$sel:sortBy:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob
-> Maybe TrainingJobSortByOptions
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Text
$sel:maxResults:ListTrainingJobsForHyperParameterTuningJob' :: ListTrainingJobsForHyperParameterTuningJob -> Maybe Natural
..} =
      [Pair] -> Value
Data.object
        ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
            [ (Key
"MaxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
              (Key
"NextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken,
              (Key
"SortBy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TrainingJobSortByOptions
sortBy,
              (Key
"SortOrder" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe SortOrder
sortOrder,
              (Key
"StatusEquals" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe TrainingJobStatus
statusEquals,
              forall a. a -> Maybe a
Prelude.Just
                ( Key
"HyperParameterTuningJobName"
                    forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
hyperParameterTuningJobName
                )
            ]
        )

instance
  Data.ToPath
    ListTrainingJobsForHyperParameterTuningJob
  where
  toPath :: ListTrainingJobsForHyperParameterTuningJob -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance
  Data.ToQuery
    ListTrainingJobsForHyperParameterTuningJob
  where
  toQuery :: ListTrainingJobsForHyperParameterTuningJob -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newListTrainingJobsForHyperParameterTuningJobResponse' smart constructor.
data ListTrainingJobsForHyperParameterTuningJobResponse = ListTrainingJobsForHyperParameterTuningJobResponse'
  { -- | 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 -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    ListTrainingJobsForHyperParameterTuningJobResponse -> Int
httpStatus :: Prelude.Int,
    -- | A list of TrainingJobSummary objects that describe the training jobs
    -- that the @ListTrainingJobsForHyperParameterTuningJob@ request returned.
    ListTrainingJobsForHyperParameterTuningJobResponse
-> [HyperParameterTrainingJobSummary]
trainingJobSummaries :: [HyperParameterTrainingJobSummary]
  }
  deriving (ListTrainingJobsForHyperParameterTuningJobResponse
-> ListTrainingJobsForHyperParameterTuningJobResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListTrainingJobsForHyperParameterTuningJobResponse
-> ListTrainingJobsForHyperParameterTuningJobResponse -> Bool
$c/= :: ListTrainingJobsForHyperParameterTuningJobResponse
-> ListTrainingJobsForHyperParameterTuningJobResponse -> Bool
== :: ListTrainingJobsForHyperParameterTuningJobResponse
-> ListTrainingJobsForHyperParameterTuningJobResponse -> Bool
$c== :: ListTrainingJobsForHyperParameterTuningJobResponse
-> ListTrainingJobsForHyperParameterTuningJobResponse -> Bool
Prelude.Eq, ReadPrec [ListTrainingJobsForHyperParameterTuningJobResponse]
ReadPrec ListTrainingJobsForHyperParameterTuningJobResponse
Int -> ReadS ListTrainingJobsForHyperParameterTuningJobResponse
ReadS [ListTrainingJobsForHyperParameterTuningJobResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListTrainingJobsForHyperParameterTuningJobResponse]
$creadListPrec :: ReadPrec [ListTrainingJobsForHyperParameterTuningJobResponse]
readPrec :: ReadPrec ListTrainingJobsForHyperParameterTuningJobResponse
$creadPrec :: ReadPrec ListTrainingJobsForHyperParameterTuningJobResponse
readList :: ReadS [ListTrainingJobsForHyperParameterTuningJobResponse]
$creadList :: ReadS [ListTrainingJobsForHyperParameterTuningJobResponse]
readsPrec :: Int -> ReadS ListTrainingJobsForHyperParameterTuningJobResponse
$creadsPrec :: Int -> ReadS ListTrainingJobsForHyperParameterTuningJobResponse
Prelude.Read, Int -> ListTrainingJobsForHyperParameterTuningJobResponse -> ShowS
[ListTrainingJobsForHyperParameterTuningJobResponse] -> ShowS
ListTrainingJobsForHyperParameterTuningJobResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListTrainingJobsForHyperParameterTuningJobResponse] -> ShowS
$cshowList :: [ListTrainingJobsForHyperParameterTuningJobResponse] -> ShowS
show :: ListTrainingJobsForHyperParameterTuningJobResponse -> String
$cshow :: ListTrainingJobsForHyperParameterTuningJobResponse -> String
showsPrec :: Int -> ListTrainingJobsForHyperParameterTuningJobResponse -> ShowS
$cshowsPrec :: Int -> ListTrainingJobsForHyperParameterTuningJobResponse -> ShowS
Prelude.Show, forall x.
Rep ListTrainingJobsForHyperParameterTuningJobResponse x
-> ListTrainingJobsForHyperParameterTuningJobResponse
forall x.
ListTrainingJobsForHyperParameterTuningJobResponse
-> Rep ListTrainingJobsForHyperParameterTuningJobResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ListTrainingJobsForHyperParameterTuningJobResponse x
-> ListTrainingJobsForHyperParameterTuningJobResponse
$cfrom :: forall x.
ListTrainingJobsForHyperParameterTuningJobResponse
-> Rep ListTrainingJobsForHyperParameterTuningJobResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListTrainingJobsForHyperParameterTuningJobResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'nextToken', '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.
--
-- 'httpStatus', 'listTrainingJobsForHyperParameterTuningJobResponse_httpStatus' - The response's http status code.
--
-- 'trainingJobSummaries', 'listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries' - A list of TrainingJobSummary objects that describe the training jobs
-- that the @ListTrainingJobsForHyperParameterTuningJob@ request returned.
newListTrainingJobsForHyperParameterTuningJobResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListTrainingJobsForHyperParameterTuningJobResponse
newListTrainingJobsForHyperParameterTuningJobResponse :: Int -> ListTrainingJobsForHyperParameterTuningJobResponse
newListTrainingJobsForHyperParameterTuningJobResponse
  Int
pHttpStatus_ =
    ListTrainingJobsForHyperParameterTuningJobResponse'
      { $sel:nextToken:ListTrainingJobsForHyperParameterTuningJobResponse' :: Maybe Text
nextToken =
          forall a. Maybe a
Prelude.Nothing,
        $sel:httpStatus:ListTrainingJobsForHyperParameterTuningJobResponse' :: Int
httpStatus =
          Int
pHttpStatus_,
        $sel:trainingJobSummaries:ListTrainingJobsForHyperParameterTuningJobResponse' :: [HyperParameterTrainingJobSummary]
trainingJobSummaries =
          forall a. Monoid a => a
Prelude.mempty
      }

-- | 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_nextToken :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJobResponse (Prelude.Maybe Prelude.Text)
listTrainingJobsForHyperParameterTuningJobResponse_nextToken :: Lens'
  ListTrainingJobsForHyperParameterTuningJobResponse (Maybe Text)
listTrainingJobsForHyperParameterTuningJobResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJobResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListTrainingJobsForHyperParameterTuningJobResponse
s@ListTrainingJobsForHyperParameterTuningJobResponse' {} Maybe Text
a -> ListTrainingJobsForHyperParameterTuningJobResponse
s {$sel:nextToken:ListTrainingJobsForHyperParameterTuningJobResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListTrainingJobsForHyperParameterTuningJobResponse)

-- | The response's http status code.
listTrainingJobsForHyperParameterTuningJobResponse_httpStatus :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJobResponse Prelude.Int
listTrainingJobsForHyperParameterTuningJobResponse_httpStatus :: Lens' ListTrainingJobsForHyperParameterTuningJobResponse Int
listTrainingJobsForHyperParameterTuningJobResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJobResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListTrainingJobsForHyperParameterTuningJobResponse
s@ListTrainingJobsForHyperParameterTuningJobResponse' {} Int
a -> ListTrainingJobsForHyperParameterTuningJobResponse
s {$sel:httpStatus:ListTrainingJobsForHyperParameterTuningJobResponse' :: Int
httpStatus = Int
a} :: ListTrainingJobsForHyperParameterTuningJobResponse)

-- | A list of TrainingJobSummary objects that describe the training jobs
-- that the @ListTrainingJobsForHyperParameterTuningJob@ request returned.
listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries :: Lens.Lens' ListTrainingJobsForHyperParameterTuningJobResponse [HyperParameterTrainingJobSummary]
listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries :: Lens'
  ListTrainingJobsForHyperParameterTuningJobResponse
  [HyperParameterTrainingJobSummary]
listTrainingJobsForHyperParameterTuningJobResponse_trainingJobSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListTrainingJobsForHyperParameterTuningJobResponse' {[HyperParameterTrainingJobSummary]
trainingJobSummaries :: [HyperParameterTrainingJobSummary]
$sel:trainingJobSummaries:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse
-> [HyperParameterTrainingJobSummary]
trainingJobSummaries} -> [HyperParameterTrainingJobSummary]
trainingJobSummaries) (\s :: ListTrainingJobsForHyperParameterTuningJobResponse
s@ListTrainingJobsForHyperParameterTuningJobResponse' {} [HyperParameterTrainingJobSummary]
a -> ListTrainingJobsForHyperParameterTuningJobResponse
s {$sel:trainingJobSummaries:ListTrainingJobsForHyperParameterTuningJobResponse' :: [HyperParameterTrainingJobSummary]
trainingJobSummaries = [HyperParameterTrainingJobSummary]
a} :: ListTrainingJobsForHyperParameterTuningJobResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance
  Prelude.NFData
    ListTrainingJobsForHyperParameterTuningJobResponse
  where
  rnf :: ListTrainingJobsForHyperParameterTuningJobResponse -> ()
rnf
    ListTrainingJobsForHyperParameterTuningJobResponse' {Int
[HyperParameterTrainingJobSummary]
Maybe Text
trainingJobSummaries :: [HyperParameterTrainingJobSummary]
httpStatus :: Int
nextToken :: Maybe Text
$sel:trainingJobSummaries:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse
-> [HyperParameterTrainingJobSummary]
$sel:httpStatus:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse -> Int
$sel:nextToken:ListTrainingJobsForHyperParameterTuningJobResponse' :: ListTrainingJobsForHyperParameterTuningJobResponse -> Maybe Text
..} =
      forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
        seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
        seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [HyperParameterTrainingJobSummary]
trainingJobSummaries