Network.AWS.SageMaker.DescribeTrainingJob

Returns information about a training job.

Creating a Request

describeTrainingJob

Arguments

:: Text

dtjTrainingJobName

-> DescribeTrainingJob

Creates a value of DescribeTrainingJob with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dtjTrainingJobName - The name of the training job.

data DescribeTrainingJob

See: describeTrainingJob smart constructor.

Instances

Eq DescribeTrainingJob

Methods

(==) :: DescribeTrainingJob -> DescribeTrainingJob -> Bool

(/=) :: DescribeTrainingJob -> DescribeTrainingJob -> Bool

Data DescribeTrainingJob

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTrainingJob -> c DescribeTrainingJob

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTrainingJob

toConstr :: DescribeTrainingJob -> Constr

dataTypeOf :: DescribeTrainingJob -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTrainingJob)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTrainingJob)

gmapT :: (forall b. Data b => b -> b) -> DescribeTrainingJob -> DescribeTrainingJob

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrainingJob -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrainingJob -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeTrainingJob -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTrainingJob -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTrainingJob -> m DescribeTrainingJob

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrainingJob -> m DescribeTrainingJob

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrainingJob -> m DescribeTrainingJob

Read DescribeTrainingJob

Methods

readsPrec :: Int -> ReadS DescribeTrainingJob

readList :: ReadS [DescribeTrainingJob]

readPrec :: ReadPrec DescribeTrainingJob

readListPrec :: ReadPrec [DescribeTrainingJob]

Show DescribeTrainingJob

Methods

showsPrec :: Int -> DescribeTrainingJob -> ShowS

show :: DescribeTrainingJob -> String

showList :: [DescribeTrainingJob] -> ShowS

Generic DescribeTrainingJob

Associated Types

type Rep DescribeTrainingJob :: * -> *

Methods

from :: DescribeTrainingJob -> Rep DescribeTrainingJob x

to :: Rep DescribeTrainingJob x -> DescribeTrainingJob

Hashable DescribeTrainingJob

Methods

hashWithSalt :: Int -> DescribeTrainingJob -> Int

hash :: DescribeTrainingJob -> Int

ToJSON DescribeTrainingJob

Methods

toJSON :: DescribeTrainingJob -> Value

toEncoding :: DescribeTrainingJob -> Encoding

toJSONList :: [DescribeTrainingJob] -> Value

toEncodingList :: [DescribeTrainingJob] -> Encoding

NFData DescribeTrainingJob

Methods

rnf :: DescribeTrainingJob -> ()

AWSRequest DescribeTrainingJob

Associated Types

type Rs DescribeTrainingJob :: *

Methods

request :: DescribeTrainingJob -> Request DescribeTrainingJob

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeTrainingJob -> ClientResponse -> m (Response DescribeTrainingJob)

ToHeaders DescribeTrainingJob

Methods

toHeaders :: DescribeTrainingJob -> [Header]

ToPath DescribeTrainingJob

Methods

toPath :: DescribeTrainingJob -> ByteString

ToQuery DescribeTrainingJob

Methods

toQuery :: DescribeTrainingJob -> QueryString

type Rep DescribeTrainingJob

type Rep DescribeTrainingJob = D1 * (MetaData "DescribeTrainingJob" "Network.AWS.SageMaker.DescribeTrainingJob" "amazonka-sagemaker-1.6.0-9oNc2IB3ZCo9VZHXZi5zcA" True) (C1 * (MetaCons "DescribeTrainingJob'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dtjTrainingJobName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)))

type Rs DescribeTrainingJob

type Rs DescribeTrainingJob = DescribeTrainingJobResponse

Request Lenses

dtjTrainingJobName :: Lens' DescribeTrainingJob Text

The name of the training job.

Destructuring the Response

describeTrainingJobResponse

Arguments

:: Int

dtjrsResponseStatus

-> Text

dtjrsTrainingJobName

-> Text

dtjrsTrainingJobARN

-> ModelArtifacts

dtjrsModelArtifacts

-> TrainingJobStatus

dtjrsTrainingJobStatus

-> SecondaryStatus

dtjrsSecondaryStatus

-> AlgorithmSpecification

dtjrsAlgorithmSpecification

-> NonEmpty Channel

dtjrsInputDataConfig

-> ResourceConfig

dtjrsResourceConfig

-> StoppingCondition

dtjrsStoppingCondition

-> UTCTime

dtjrsCreationTime

-> DescribeTrainingJobResponse

Creates a value of DescribeTrainingJobResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dtjrsFailureReason - If the training job failed, the reason it failed.
• dtjrsTrainingEndTime - A timestamp that indicates when model training ended.
• dtjrsLastModifiedTime - A timestamp that indicates when the status of the training job was last modified.
• dtjrsHyperParameters - Algorithm-specific parameters.
• dtjrsVPCConfig - A object that specifies the VPC that this training job has access to. For more information, see 'train-vpc' .
• dtjrsOutputDataConfig - The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.
• dtjrsTrainingStartTime - A timestamp that indicates when training started.
• dtjrsRoleARN - The AWS Identity and Access Management (IAM) role configured for the training job.
• dtjrsResponseStatus - -- | The response status code.
• dtjrsTrainingJobName - Name of the model training job.
• dtjrsTrainingJobARN - The Amazon Resource Name (ARN) of the training job.
• dtjrsModelArtifacts - Information about the Amazon S3 location that is configured for storing model artifacts.
• dtjrsTrainingJobStatus - The status of the training job. For the InProgress status, Amazon SageMaker can return these secondary statuses: * Starting - Preparing for training. * Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes. * Training - Training is in progress. * Uploading - Training is complete and model upload is in progress. For the Stopped training status, Amazon SageMaker can return these secondary statuses: * MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.
• dtjrsSecondaryStatus - Provides granular information about the system state. For more information, see TrainingJobStatus .
• dtjrsAlgorithmSpecification - Information about the algorithm used for training, and algorithm metadata.
• dtjrsInputDataConfig - An array of Channel objects that describes each data input channel.
• dtjrsResourceConfig - Resources, including ML compute instances and ML storage volumes, that are configured for model training.
• dtjrsStoppingCondition - The condition under which to stop the training job.
• dtjrsCreationTime - A timestamp that indicates when the training job was created.

data DescribeTrainingJobResponse

See: describeTrainingJobResponse smart constructor.

Instances

Eq DescribeTrainingJobResponse

Methods

(==) :: DescribeTrainingJobResponse -> DescribeTrainingJobResponse -> Bool

(/=) :: DescribeTrainingJobResponse -> DescribeTrainingJobResponse -> Bool

Data DescribeTrainingJobResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeTrainingJobResponse -> c DescribeTrainingJobResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeTrainingJobResponse

toConstr :: DescribeTrainingJobResponse -> Constr

dataTypeOf :: DescribeTrainingJobResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeTrainingJobResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeTrainingJobResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeTrainingJobResponse -> DescribeTrainingJobResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrainingJobResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeTrainingJobResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeTrainingJobResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeTrainingJobResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeTrainingJobResponse -> m DescribeTrainingJobResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrainingJobResponse -> m DescribeTrainingJobResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeTrainingJobResponse -> m DescribeTrainingJobResponse

Read DescribeTrainingJobResponse

Methods

readsPrec :: Int -> ReadS DescribeTrainingJobResponse

readList :: ReadS [DescribeTrainingJobResponse]

readPrec :: ReadPrec DescribeTrainingJobResponse

readListPrec :: ReadPrec [DescribeTrainingJobResponse]

Show DescribeTrainingJobResponse

Methods

showsPrec :: Int -> DescribeTrainingJobResponse -> ShowS

show :: DescribeTrainingJobResponse -> String

showList :: [DescribeTrainingJobResponse] -> ShowS

Generic DescribeTrainingJobResponse

Associated Types

type Rep DescribeTrainingJobResponse :: * -> *

Methods

from :: DescribeTrainingJobResponse -> Rep DescribeTrainingJobResponse x

to :: Rep DescribeTrainingJobResponse x -> DescribeTrainingJobResponse

NFData DescribeTrainingJobResponse

Methods

rnf :: DescribeTrainingJobResponse -> ()

type Rep DescribeTrainingJobResponse

type Rep DescribeTrainingJobResponse = D1 * (MetaData "DescribeTrainingJobResponse" "Network.AWS.SageMaker.DescribeTrainingJob" "amazonka-sagemaker-1.6.0-9oNc2IB3ZCo9VZHXZi5zcA" False) (C1 * (MetaCons "DescribeTrainingJobResponse'" PrefixI True) ((:*:) * ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsFailureReason") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dtjrsTrainingEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsLastModifiedTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) (S1 * (MetaSel (Just Symbol "_dtjrsHyperParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (Map Text Text)))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsVPCConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe VPCConfig))) (S1 * (MetaSel (Just Symbol "_dtjrsOutputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe OutputDataConfig)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsTrainingStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_dtjrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))) ((:*:) * ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsTrainingJobName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_dtjrsTrainingJobARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsModelArtifacts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ModelArtifacts)) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsTrainingJobStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * TrainingJobStatus)) (S1 * (MetaSel (Just Symbol "_dtjrsSecondaryStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * SecondaryStatus))))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsAlgorithmSpecification") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * AlgorithmSpecification)) (S1 * (MetaSel (Just Symbol "_dtjrsInputDataConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (List1 Channel)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsResourceConfig") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ResourceConfig)) ((:*:) * (S1 * (MetaSel (Just Symbol "_dtjrsStoppingCondition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * StoppingCondition)) (S1 * (MetaSel (Just Symbol "_dtjrsCreationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * POSIX))))))))

Response Lenses

dtjrsFailureReason :: Lens' DescribeTrainingJobResponse (Maybe Text)

If the training job failed, the reason it failed.

dtjrsTrainingEndTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime)

A timestamp that indicates when model training ended.

dtjrsLastModifiedTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime)

A timestamp that indicates when the status of the training job was last modified.

dtjrsHyperParameters :: Lens' DescribeTrainingJobResponse (HashMap Text Text)

Algorithm-specific parameters.

dtjrsVPCConfig :: Lens' DescribeTrainingJobResponse (Maybe VPCConfig)

A object that specifies the VPC that this training job has access to. For more information, see 'train-vpc' .

dtjrsOutputDataConfig :: Lens' DescribeTrainingJobResponse (Maybe OutputDataConfig)

The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

dtjrsTrainingStartTime :: Lens' DescribeTrainingJobResponse (Maybe UTCTime)

A timestamp that indicates when training started.

dtjrsRoleARN :: Lens' DescribeTrainingJobResponse (Maybe Text)

The AWS Identity and Access Management (IAM) role configured for the training job.

dtjrsResponseStatus :: Lens' DescribeTrainingJobResponse Int

• - | The response status code.

dtjrsTrainingJobName :: Lens' DescribeTrainingJobResponse Text

Name of the model training job.

dtjrsTrainingJobARN :: Lens' DescribeTrainingJobResponse Text

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

dtjrsModelArtifacts :: Lens' DescribeTrainingJobResponse ModelArtifacts

Information about the Amazon S3 location that is configured for storing model artifacts.

dtjrsTrainingJobStatus :: Lens' DescribeTrainingJobResponse TrainingJobStatus

The status of the training job. For the InProgress status, Amazon SageMaker can return these secondary statuses: * Starting - Preparing for training. * Downloading - Optional stage for algorithms that support File training input mode. It indicates data is being downloaded to ML storage volumes. * Training - Training is in progress. * Uploading - Training is complete and model upload is in progress. For the Stopped training status, Amazon SageMaker can return these secondary statuses: * MaxRuntimeExceeded - Job stopped as a result of maximum allowed runtime exceeded.

dtjrsSecondaryStatus :: Lens' DescribeTrainingJobResponse SecondaryStatus

Provides granular information about the system state. For more information, see TrainingJobStatus .

dtjrsAlgorithmSpecification :: Lens' DescribeTrainingJobResponse AlgorithmSpecification

Information about the algorithm used for training, and algorithm metadata.

dtjrsInputDataConfig :: Lens' DescribeTrainingJobResponse (NonEmpty Channel)

An array of Channel objects that describes each data input channel.

dtjrsResourceConfig :: Lens' DescribeTrainingJobResponse ResourceConfig

Resources, including ML compute instances and ML storage volumes, that are configured for model training.

dtjrsStoppingCondition :: Lens' DescribeTrainingJobResponse StoppingCondition

The condition under which to stop the training job.

dtjrsCreationTime :: Lens' DescribeTrainingJobResponse UTCTime

A timestamp that indicates when the training job was created.