Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.DescribeHyperParameterTuningJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a description of a hyperparameter tuning job.

Synopsis

Creating a Request

data DescribeHyperParameterTuningJob Source #

See: newDescribeHyperParameterTuningJob smart constructor.

Constructors

DescribeHyperParameterTuningJob'
Fields hyperParameterTuningJobName :: Text The name of the tuning job.

Instances

Instances details

Eq DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods (==) :: DescribeHyperParameterTuningJob -> DescribeHyperParameterTuningJob -> Bool # (/=) :: DescribeHyperParameterTuningJob -> DescribeHyperParameterTuningJob -> Bool #
Read DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods readsPrec :: Int -> ReadS DescribeHyperParameterTuningJob # readList :: ReadS [DescribeHyperParameterTuningJob] # readPrec :: ReadPrec DescribeHyperParameterTuningJob # readListPrec :: ReadPrec [DescribeHyperParameterTuningJob] #
Show DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods showsPrec :: Int -> DescribeHyperParameterTuningJob -> ShowS # show :: DescribeHyperParameterTuningJob -> String # showList :: [DescribeHyperParameterTuningJob] -> ShowS #
Generic DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Associated Types type Rep DescribeHyperParameterTuningJob :: Type -> Type # Methods from :: DescribeHyperParameterTuningJob -> Rep DescribeHyperParameterTuningJob x # to :: Rep DescribeHyperParameterTuningJob x -> DescribeHyperParameterTuningJob #
NFData DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods rnf :: DescribeHyperParameterTuningJob -> () #
Hashable DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods hashWithSalt :: Int -> DescribeHyperParameterTuningJob -> Int # hash :: DescribeHyperParameterTuningJob -> Int #
ToJSON DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods toJSON :: DescribeHyperParameterTuningJob -> Value # toEncoding :: DescribeHyperParameterTuningJob -> Encoding # toJSONList :: [DescribeHyperParameterTuningJob] -> Value # toEncodingList :: [DescribeHyperParameterTuningJob] -> Encoding #
AWSRequest DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Associated Types type AWSResponse DescribeHyperParameterTuningJob # Methods request :: DescribeHyperParameterTuningJob -> Request DescribeHyperParameterTuningJob # response :: MonadResource m => Logger -> Service -> Proxy DescribeHyperParameterTuningJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeHyperParameterTuningJob))) #
ToHeaders DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods toHeaders :: DescribeHyperParameterTuningJob -> [Header] #
ToPath DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods toPath :: DescribeHyperParameterTuningJob -> ByteString #
ToQuery DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods toQuery :: DescribeHyperParameterTuningJob -> QueryString #
type Rep DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob type Rep DescribeHyperParameterTuningJob = D1 ('MetaData "DescribeHyperParameterTuningJob" "Amazonka.SageMaker.DescribeHyperParameterTuningJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeHyperParameterTuningJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "hyperParameterTuningJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeHyperParameterTuningJob Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob type AWSResponse DescribeHyperParameterTuningJob = DescribeHyperParameterTuningJobResponse

newDescribeHyperParameterTuningJob Source #

Arguments

:: Text	`$sel:hyperParameterTuningJobName:DescribeHyperParameterTuningJob'`
-> DescribeHyperParameterTuningJob

Create a value of DescribeHyperParameterTuningJob 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:hyperParameterTuningJobName:DescribeHyperParameterTuningJob', describeHyperParameterTuningJob_hyperParameterTuningJobName - The name of the tuning job.

Request Lenses

describeHyperParameterTuningJob_hyperParameterTuningJobName :: Lens' DescribeHyperParameterTuningJob Text Source #

The name of the tuning job.

Destructuring the Response

data DescribeHyperParameterTuningJobResponse Source #

See: newDescribeHyperParameterTuningJobResponse smart constructor.

Constructors

DescribeHyperParameterTuningJobResponse'

Fields

failureReason :: Maybe Text
If the tuning job failed, the reason it failed.
trainingJobDefinition :: Maybe HyperParameterTrainingJobDefinition
The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.
lastModifiedTime :: Maybe POSIX
The date and time that the status of the tuning job was modified.
bestTrainingJob :: Maybe HyperParameterTrainingJobSummary
A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.
hyperParameterTuningEndTime :: Maybe POSIX
The date and time that the tuning job ended.
overallBestTrainingJob :: Maybe HyperParameterTrainingJobSummary
If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.
warmStartConfig :: Maybe HyperParameterTuningJobWarmStartConfig
The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.
trainingJobDefinitions :: Maybe (NonEmpty HyperParameterTrainingJobDefinition)
A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.
httpStatus :: Int
The response's http status code.
hyperParameterTuningJobName :: Text
The name of the tuning job.
hyperParameterTuningJobArn :: Text
The Amazon Resource Name (ARN) of the tuning job.
hyperParameterTuningJobConfig :: HyperParameterTuningJobConfig
The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.
hyperParameterTuningJobStatus :: HyperParameterTuningJobStatus
The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.
creationTime :: POSIX
The date and time that the tuning job started.
trainingJobStatusCounters :: TrainingJobStatusCounters
The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.
objectiveStatusCounters :: ObjectiveStatusCounters
The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Instances

Instances details

Eq DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods (==) :: DescribeHyperParameterTuningJobResponse -> DescribeHyperParameterTuningJobResponse -> Bool # (/=) :: DescribeHyperParameterTuningJobResponse -> DescribeHyperParameterTuningJobResponse -> Bool #
Read DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods readsPrec :: Int -> ReadS DescribeHyperParameterTuningJobResponse # readList :: ReadS [DescribeHyperParameterTuningJobResponse] # readPrec :: ReadPrec DescribeHyperParameterTuningJobResponse # readListPrec :: ReadPrec [DescribeHyperParameterTuningJobResponse] #
Show DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods showsPrec :: Int -> DescribeHyperParameterTuningJobResponse -> ShowS # show :: DescribeHyperParameterTuningJobResponse -> String # showList :: [DescribeHyperParameterTuningJobResponse] -> ShowS #
Generic DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Associated Types type Rep DescribeHyperParameterTuningJobResponse :: Type -> Type # Methods from :: DescribeHyperParameterTuningJobResponse -> Rep DescribeHyperParameterTuningJobResponse x # to :: Rep DescribeHyperParameterTuningJobResponse x -> DescribeHyperParameterTuningJobResponse #
NFData DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob Methods rnf :: DescribeHyperParameterTuningJobResponse -> () #
type Rep DescribeHyperParameterTuningJobResponse Source #
Instance details Defined in Amazonka.SageMaker.DescribeHyperParameterTuningJob type Rep DescribeHyperParameterTuningJobResponse = D1 ('MetaData "DescribeHyperParameterTuningJobResponse" "Amazonka.SageMaker.DescribeHyperParameterTuningJob" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeHyperParameterTuningJobResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "failureReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "trainingJobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HyperParameterTrainingJobDefinition))) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "bestTrainingJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HyperParameterTrainingJobSummary)))) :: ((S1 ('MetaSel ('Just "hyperParameterTuningEndTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "overallBestTrainingJob") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HyperParameterTrainingJobSummary))) :: (S1 ('MetaSel ('Just "warmStartConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HyperParameterTuningJobWarmStartConfig)) :: S1 ('MetaSel ('Just "trainingJobDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty HyperParameterTrainingJobDefinition)))))) :: (((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "hyperParameterTuningJobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "hyperParameterTuningJobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "hyperParameterTuningJobConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HyperParameterTuningJobConfig))) :: ((S1 ('MetaSel ('Just "hyperParameterTuningJobStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HyperParameterTuningJobStatus) :: S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)) :: (S1 ('MetaSel ('Just "trainingJobStatusCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TrainingJobStatusCounters) :*: S1 ('MetaSel ('Just "objectiveStatusCounters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectiveStatusCounters))))))

newDescribeHyperParameterTuningJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeHyperParameterTuningJobResponse'`
-> Text	`$sel:hyperParameterTuningJobName:DescribeHyperParameterTuningJob'`
-> Text	`$sel:hyperParameterTuningJobArn:DescribeHyperParameterTuningJobResponse'`
-> HyperParameterTuningJobConfig	`$sel:hyperParameterTuningJobConfig:DescribeHyperParameterTuningJobResponse'`
-> HyperParameterTuningJobStatus	`$sel:hyperParameterTuningJobStatus:DescribeHyperParameterTuningJobResponse'`
-> UTCTime	`$sel:creationTime:DescribeHyperParameterTuningJobResponse'`
-> TrainingJobStatusCounters	`$sel:trainingJobStatusCounters:DescribeHyperParameterTuningJobResponse'`
-> ObjectiveStatusCounters	`$sel:objectiveStatusCounters:DescribeHyperParameterTuningJobResponse'`
-> DescribeHyperParameterTuningJobResponse

Create a value of DescribeHyperParameterTuningJobResponse 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:failureReason:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_failureReason - If the tuning job failed, the reason it failed.

$sel:trainingJobDefinition:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_trainingJobDefinition - The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

$sel:lastModifiedTime:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_lastModifiedTime - The date and time that the status of the tuning job was modified.

$sel:bestTrainingJob:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_bestTrainingJob - A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

$sel:hyperParameterTuningEndTime:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_hyperParameterTuningEndTime - The date and time that the tuning job ended.

$sel:overallBestTrainingJob:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_overallBestTrainingJob - If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

$sel:warmStartConfig:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_warmStartConfig - The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

$sel:trainingJobDefinitions:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_trainingJobDefinitions - A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

$sel:httpStatus:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_httpStatus - The response's http status code.

$sel:hyperParameterTuningJobName:DescribeHyperParameterTuningJob', describeHyperParameterTuningJobResponse_hyperParameterTuningJobName - The name of the tuning job.

$sel:hyperParameterTuningJobArn:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_hyperParameterTuningJobArn - The Amazon Resource Name (ARN) of the tuning job.

$sel:hyperParameterTuningJobConfig:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_hyperParameterTuningJobConfig - The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

$sel:hyperParameterTuningJobStatus:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_hyperParameterTuningJobStatus - The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

$sel:creationTime:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_creationTime - The date and time that the tuning job started.

$sel:trainingJobStatusCounters:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_trainingJobStatusCounters - The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

$sel:objectiveStatusCounters:DescribeHyperParameterTuningJobResponse', describeHyperParameterTuningJobResponse_objectiveStatusCounters - The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

Response Lenses

describeHyperParameterTuningJobResponse_failureReason :: Lens' DescribeHyperParameterTuningJobResponse (Maybe Text) Source #

If the tuning job failed, the reason it failed.

describeHyperParameterTuningJobResponse_trainingJobDefinition :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobDefinition) Source #

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

describeHyperParameterTuningJobResponse_lastModifiedTime :: Lens' DescribeHyperParameterTuningJobResponse (Maybe UTCTime) Source #

The date and time that the status of the tuning job was modified.

describeHyperParameterTuningJobResponse_bestTrainingJob :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobSummary) Source #

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

describeHyperParameterTuningJobResponse_hyperParameterTuningEndTime :: Lens' DescribeHyperParameterTuningJobResponse (Maybe UTCTime) Source #

The date and time that the tuning job ended.

describeHyperParameterTuningJobResponse_overallBestTrainingJob :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTrainingJobSummary) Source #

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

describeHyperParameterTuningJobResponse_warmStartConfig :: Lens' DescribeHyperParameterTuningJobResponse (Maybe HyperParameterTuningJobWarmStartConfig) Source #

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

describeHyperParameterTuningJobResponse_trainingJobDefinitions :: Lens' DescribeHyperParameterTuningJobResponse (Maybe (NonEmpty HyperParameterTrainingJobDefinition)) Source #

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

describeHyperParameterTuningJobResponse_httpStatus :: Lens' DescribeHyperParameterTuningJobResponse Int Source #

The response's http status code.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobName :: Lens' DescribeHyperParameterTuningJobResponse Text Source #

The name of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobArn :: Lens' DescribeHyperParameterTuningJobResponse Text Source #

The Amazon Resource Name (ARN) of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobConfig :: Lens' DescribeHyperParameterTuningJobResponse HyperParameterTuningJobConfig Source #

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

describeHyperParameterTuningJobResponse_hyperParameterTuningJobStatus :: Lens' DescribeHyperParameterTuningJobResponse HyperParameterTuningJobStatus Source #

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

describeHyperParameterTuningJobResponse_creationTime :: Lens' DescribeHyperParameterTuningJobResponse UTCTime Source #

The date and time that the tuning job started.

describeHyperParameterTuningJobResponse_trainingJobStatusCounters :: Lens' DescribeHyperParameterTuningJobResponse TrainingJobStatusCounters Source #

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

describeHyperParameterTuningJobResponse_objectiveStatusCounters :: Lens' DescribeHyperParameterTuningJobResponse ObjectiveStatusCounters Source #

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.