libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.Types.SecondaryStatusTransition

Description

 
Synopsis

Documentation

data SecondaryStatusTransition Source #

An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

See: newSecondaryStatusTransition smart constructor.

Constructors

SecondaryStatusTransition' 

Fields

  • statusMessage :: Maybe Text

    A detailed description of the progress within a secondary status.

    Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

    Starting
    - Starting the training job.
    • Launching requested ML instances.
    • Insufficient capacity error from EC2 while launching instances, retrying!
    • Launched instance was unhealthy, replacing it!
    • Preparing the instances for training.
    Training
    - Downloading the training image.
    • Training image download completed. Training in progress.

    Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

    To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

    • TrainingJobStatus - InProgress
    • SecondaryStatus - Training
    • StatusMessage - Downloading the training image
  • endTime :: Maybe POSIX

    A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

  • status :: SecondaryStatus

    Contains a secondary status information from a training job.

    Status might be one of the following secondary statuses:

    InProgress
    - Starting - Starting the training job.
    • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
    • Training - Training is in progress.
    • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
    Completed
    - Completed - The training job has completed.
    Failed
    - Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
    Stopped
    - MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
    • Stopped - The training job has stopped.
    Stopping
    - Stopping - Stopping the training job.

    We no longer support the following secondary statuses:

    • LaunchingMLInstances
    • PreparingTrainingStack
    • DownloadingTrainingImage
  • startTime :: POSIX

    A timestamp that shows when the training job transitioned to the current secondary status state.

Instances

Instances details
Eq SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

Read SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

Show SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

Generic SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

Associated Types

type Rep SecondaryStatusTransition :: Type -> Type #

NFData SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

Hashable SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

FromJSON SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

type Rep SecondaryStatusTransition Source # 
Instance details

Defined in Amazonka.SageMaker.Types.SecondaryStatusTransition

type Rep SecondaryStatusTransition = D1 ('MetaData "SecondaryStatusTransition" "Amazonka.SageMaker.Types.SecondaryStatusTransition" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "SecondaryStatusTransition'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecondaryStatus) :*: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newSecondaryStatusTransition Source #

Create a value of SecondaryStatusTransition 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:statusMessage:SecondaryStatusTransition', secondaryStatusTransition_statusMessage - A detailed description of the progress within a secondary status.

Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
- Starting the training job.
  • Launching requested ML instances.
  • Insufficient capacity error from EC2 while launching instances, retrying!
  • Launched instance was unhealthy, replacing it!
  • Preparing the instances for training.
Training
- Downloading the training image.
  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress
  • SecondaryStatus - Training
  • StatusMessage - Downloading the training image

$sel:endTime:SecondaryStatusTransition', secondaryStatusTransition_endTime - A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

$sel:status:SecondaryStatusTransition', secondaryStatusTransition_status - Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress
- Starting - Starting the training job.
  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
  • Training - Training is in progress.
  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
- Completed - The training job has completed.
Failed
- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
Stopped
- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
  • Stopped - The training job has stopped.
Stopping
- Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances
  • PreparingTrainingStack
  • DownloadingTrainingImage

$sel:startTime:SecondaryStatusTransition', secondaryStatusTransition_startTime - A timestamp that shows when the training job transitioned to the current secondary status state.

secondaryStatusTransition_statusMessage :: Lens' SecondaryStatusTransition (Maybe Text) Source #

A detailed description of the progress within a secondary status.

Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

Starting
- Starting the training job.
  • Launching requested ML instances.
  • Insufficient capacity error from EC2 while launching instances, retrying!
  • Launched instance was unhealthy, replacing it!
  • Preparing the instances for training.
Training
- Downloading the training image.
  • Training image download completed. Training in progress.

Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

  • TrainingJobStatus - InProgress
  • SecondaryStatus - Training
  • StatusMessage - Downloading the training image

secondaryStatusTransition_endTime :: Lens' SecondaryStatusTransition (Maybe UTCTime) Source #

A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

secondaryStatusTransition_status :: Lens' SecondaryStatusTransition SecondaryStatus Source #

Contains a secondary status information from a training job.

Status might be one of the following secondary statuses:

InProgress
- Starting - Starting the training job.
  • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.
  • Training - Training is in progress.
  • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.
Completed
- Completed - The training job has completed.
Failed
- Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.
Stopped
- MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.
  • Stopped - The training job has stopped.
Stopping
- Stopping - Stopping the training job.

We no longer support the following secondary statuses:

  • LaunchingMLInstances
  • PreparingTrainingStack
  • DownloadingTrainingImage

secondaryStatusTransition_startTime :: Lens' SecondaryStatusTransition UTCTime Source #

A timestamp that shows when the training job transitioned to the current secondary status state.