AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | List of all members
Aws::SageMaker::Model::DescribeTrainingJobResult Class Reference

#include <DescribeTrainingJobResult.h>

Public Member Functions

 DescribeTrainingJobResult ()
 
 DescribeTrainingJobResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
DescribeTrainingJobResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetTrainingJobName () const
 
void SetTrainingJobName (const Aws::String &value)
 
void SetTrainingJobName (Aws::String &&value)
 
void SetTrainingJobName (const char *value)
 
DescribeTrainingJobResultWithTrainingJobName (const Aws::String &value)
 
DescribeTrainingJobResultWithTrainingJobName (Aws::String &&value)
 
DescribeTrainingJobResultWithTrainingJobName (const char *value)
 
const Aws::StringGetTrainingJobArn () const
 
void SetTrainingJobArn (const Aws::String &value)
 
void SetTrainingJobArn (Aws::String &&value)
 
void SetTrainingJobArn (const char *value)
 
DescribeTrainingJobResultWithTrainingJobArn (const Aws::String &value)
 
DescribeTrainingJobResultWithTrainingJobArn (Aws::String &&value)
 
DescribeTrainingJobResultWithTrainingJobArn (const char *value)
 
const Aws::StringGetTuningJobArn () const
 
void SetTuningJobArn (const Aws::String &value)
 
void SetTuningJobArn (Aws::String &&value)
 
void SetTuningJobArn (const char *value)
 
DescribeTrainingJobResultWithTuningJobArn (const Aws::String &value)
 
DescribeTrainingJobResultWithTuningJobArn (Aws::String &&value)
 
DescribeTrainingJobResultWithTuningJobArn (const char *value)
 
const Aws::StringGetLabelingJobArn () const
 
void SetLabelingJobArn (const Aws::String &value)
 
void SetLabelingJobArn (Aws::String &&value)
 
void SetLabelingJobArn (const char *value)
 
DescribeTrainingJobResultWithLabelingJobArn (const Aws::String &value)
 
DescribeTrainingJobResultWithLabelingJobArn (Aws::String &&value)
 
DescribeTrainingJobResultWithLabelingJobArn (const char *value)
 
const Aws::StringGetAutoMLJobArn () const
 
void SetAutoMLJobArn (const Aws::String &value)
 
void SetAutoMLJobArn (Aws::String &&value)
 
void SetAutoMLJobArn (const char *value)
 
DescribeTrainingJobResultWithAutoMLJobArn (const Aws::String &value)
 
DescribeTrainingJobResultWithAutoMLJobArn (Aws::String &&value)
 
DescribeTrainingJobResultWithAutoMLJobArn (const char *value)
 
const ModelArtifactsGetModelArtifacts () const
 
void SetModelArtifacts (const ModelArtifacts &value)
 
void SetModelArtifacts (ModelArtifacts &&value)
 
DescribeTrainingJobResultWithModelArtifacts (const ModelArtifacts &value)
 
DescribeTrainingJobResultWithModelArtifacts (ModelArtifacts &&value)
 
const TrainingJobStatusGetTrainingJobStatus () const
 
void SetTrainingJobStatus (const TrainingJobStatus &value)
 
void SetTrainingJobStatus (TrainingJobStatus &&value)
 
DescribeTrainingJobResultWithTrainingJobStatus (const TrainingJobStatus &value)
 
DescribeTrainingJobResultWithTrainingJobStatus (TrainingJobStatus &&value)
 
const SecondaryStatusGetSecondaryStatus () const
 
void SetSecondaryStatus (const SecondaryStatus &value)
 
void SetSecondaryStatus (SecondaryStatus &&value)
 
DescribeTrainingJobResultWithSecondaryStatus (const SecondaryStatus &value)
 
DescribeTrainingJobResultWithSecondaryStatus (SecondaryStatus &&value)
 
const Aws::StringGetFailureReason () const
 
void SetFailureReason (const Aws::String &value)
 
void SetFailureReason (Aws::String &&value)
 
void SetFailureReason (const char *value)
 
DescribeTrainingJobResultWithFailureReason (const Aws::String &value)
 
DescribeTrainingJobResultWithFailureReason (Aws::String &&value)
 
DescribeTrainingJobResultWithFailureReason (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetHyperParameters () const
 
void SetHyperParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetHyperParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeTrainingJobResultWithHyperParameters (const Aws::Map< Aws::String, Aws::String > &value)
 
DescribeTrainingJobResultWithHyperParameters (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeTrainingJobResultAddHyperParameters (const Aws::String &key, const Aws::String &value)
 
DescribeTrainingJobResultAddHyperParameters (Aws::String &&key, const Aws::String &value)
 
DescribeTrainingJobResultAddHyperParameters (const Aws::String &key, Aws::String &&value)
 
DescribeTrainingJobResultAddHyperParameters (Aws::String &&key, Aws::String &&value)
 
DescribeTrainingJobResultAddHyperParameters (const char *key, Aws::String &&value)
 
DescribeTrainingJobResultAddHyperParameters (Aws::String &&key, const char *value)
 
DescribeTrainingJobResultAddHyperParameters (const char *key, const char *value)
 
const AlgorithmSpecificationGetAlgorithmSpecification () const
 
void SetAlgorithmSpecification (const AlgorithmSpecification &value)
 
void SetAlgorithmSpecification (AlgorithmSpecification &&value)
 
DescribeTrainingJobResultWithAlgorithmSpecification (const AlgorithmSpecification &value)
 
DescribeTrainingJobResultWithAlgorithmSpecification (AlgorithmSpecification &&value)
 
const Aws::StringGetRoleArn () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
DescribeTrainingJobResultWithRoleArn (const Aws::String &value)
 
DescribeTrainingJobResultWithRoleArn (Aws::String &&value)
 
DescribeTrainingJobResultWithRoleArn (const char *value)
 
const Aws::Vector< Channel > & GetInputDataConfig () const
 
void SetInputDataConfig (const Aws::Vector< Channel > &value)
 
void SetInputDataConfig (Aws::Vector< Channel > &&value)
 
DescribeTrainingJobResultWithInputDataConfig (const Aws::Vector< Channel > &value)
 
DescribeTrainingJobResultWithInputDataConfig (Aws::Vector< Channel > &&value)
 
DescribeTrainingJobResultAddInputDataConfig (const Channel &value)
 
DescribeTrainingJobResultAddInputDataConfig (Channel &&value)
 
const OutputDataConfigGetOutputDataConfig () const
 
void SetOutputDataConfig (const OutputDataConfig &value)
 
void SetOutputDataConfig (OutputDataConfig &&value)
 
DescribeTrainingJobResultWithOutputDataConfig (const OutputDataConfig &value)
 
DescribeTrainingJobResultWithOutputDataConfig (OutputDataConfig &&value)
 
const ResourceConfigGetResourceConfig () const
 
void SetResourceConfig (const ResourceConfig &value)
 
void SetResourceConfig (ResourceConfig &&value)
 
DescribeTrainingJobResultWithResourceConfig (const ResourceConfig &value)
 
DescribeTrainingJobResultWithResourceConfig (ResourceConfig &&value)
 
const VpcConfigGetVpcConfig () const
 
void SetVpcConfig (const VpcConfig &value)
 
void SetVpcConfig (VpcConfig &&value)
 
DescribeTrainingJobResultWithVpcConfig (const VpcConfig &value)
 
DescribeTrainingJobResultWithVpcConfig (VpcConfig &&value)
 
const StoppingConditionGetStoppingCondition () const
 
void SetStoppingCondition (const StoppingCondition &value)
 
void SetStoppingCondition (StoppingCondition &&value)
 
DescribeTrainingJobResultWithStoppingCondition (const StoppingCondition &value)
 
DescribeTrainingJobResultWithStoppingCondition (StoppingCondition &&value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
DescribeTrainingJobResultWithCreationTime (const Aws::Utils::DateTime &value)
 
DescribeTrainingJobResultWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingStartTime () const
 
void SetTrainingStartTime (const Aws::Utils::DateTime &value)
 
void SetTrainingStartTime (Aws::Utils::DateTime &&value)
 
DescribeTrainingJobResultWithTrainingStartTime (const Aws::Utils::DateTime &value)
 
DescribeTrainingJobResultWithTrainingStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetTrainingEndTime () const
 
void SetTrainingEndTime (const Aws::Utils::DateTime &value)
 
void SetTrainingEndTime (Aws::Utils::DateTime &&value)
 
DescribeTrainingJobResultWithTrainingEndTime (const Aws::Utils::DateTime &value)
 
DescribeTrainingJobResultWithTrainingEndTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetLastModifiedTime () const
 
void SetLastModifiedTime (const Aws::Utils::DateTime &value)
 
void SetLastModifiedTime (Aws::Utils::DateTime &&value)
 
DescribeTrainingJobResultWithLastModifiedTime (const Aws::Utils::DateTime &value)
 
DescribeTrainingJobResultWithLastModifiedTime (Aws::Utils::DateTime &&value)
 
const Aws::Vector< SecondaryStatusTransition > & GetSecondaryStatusTransitions () const
 
void SetSecondaryStatusTransitions (const Aws::Vector< SecondaryStatusTransition > &value)
 
void SetSecondaryStatusTransitions (Aws::Vector< SecondaryStatusTransition > &&value)
 
DescribeTrainingJobResultWithSecondaryStatusTransitions (const Aws::Vector< SecondaryStatusTransition > &value)
 
DescribeTrainingJobResultWithSecondaryStatusTransitions (Aws::Vector< SecondaryStatusTransition > &&value)
 
DescribeTrainingJobResultAddSecondaryStatusTransitions (const SecondaryStatusTransition &value)
 
DescribeTrainingJobResultAddSecondaryStatusTransitions (SecondaryStatusTransition &&value)
 
const Aws::Vector< MetricData > & GetFinalMetricDataList () const
 
void SetFinalMetricDataList (const Aws::Vector< MetricData > &value)
 
void SetFinalMetricDataList (Aws::Vector< MetricData > &&value)
 
DescribeTrainingJobResultWithFinalMetricDataList (const Aws::Vector< MetricData > &value)
 
DescribeTrainingJobResultWithFinalMetricDataList (Aws::Vector< MetricData > &&value)
 
DescribeTrainingJobResultAddFinalMetricDataList (const MetricData &value)
 
DescribeTrainingJobResultAddFinalMetricDataList (MetricData &&value)
 
bool GetEnableNetworkIsolation () const
 
void SetEnableNetworkIsolation (bool value)
 
DescribeTrainingJobResultWithEnableNetworkIsolation (bool value)
 
bool GetEnableInterContainerTrafficEncryption () const
 
void SetEnableInterContainerTrafficEncryption (bool value)
 
DescribeTrainingJobResultWithEnableInterContainerTrafficEncryption (bool value)
 
bool GetEnableManagedSpotTraining () const
 
void SetEnableManagedSpotTraining (bool value)
 
DescribeTrainingJobResultWithEnableManagedSpotTraining (bool value)
 
const CheckpointConfigGetCheckpointConfig () const
 
void SetCheckpointConfig (const CheckpointConfig &value)
 
void SetCheckpointConfig (CheckpointConfig &&value)
 
DescribeTrainingJobResultWithCheckpointConfig (const CheckpointConfig &value)
 
DescribeTrainingJobResultWithCheckpointConfig (CheckpointConfig &&value)
 
int GetTrainingTimeInSeconds () const
 
void SetTrainingTimeInSeconds (int value)
 
DescribeTrainingJobResultWithTrainingTimeInSeconds (int value)
 
int GetBillableTimeInSeconds () const
 
void SetBillableTimeInSeconds (int value)
 
DescribeTrainingJobResultWithBillableTimeInSeconds (int value)
 
const DebugHookConfigGetDebugHookConfig () const
 
void SetDebugHookConfig (const DebugHookConfig &value)
 
void SetDebugHookConfig (DebugHookConfig &&value)
 
DescribeTrainingJobResultWithDebugHookConfig (const DebugHookConfig &value)
 
DescribeTrainingJobResultWithDebugHookConfig (DebugHookConfig &&value)
 
const ExperimentConfigGetExperimentConfig () const
 
void SetExperimentConfig (const ExperimentConfig &value)
 
void SetExperimentConfig (ExperimentConfig &&value)
 
DescribeTrainingJobResultWithExperimentConfig (const ExperimentConfig &value)
 
DescribeTrainingJobResultWithExperimentConfig (ExperimentConfig &&value)
 
const Aws::Vector< DebugRuleConfiguration > & GetDebugRuleConfigurations () const
 
void SetDebugRuleConfigurations (const Aws::Vector< DebugRuleConfiguration > &value)
 
void SetDebugRuleConfigurations (Aws::Vector< DebugRuleConfiguration > &&value)
 
DescribeTrainingJobResultWithDebugRuleConfigurations (const Aws::Vector< DebugRuleConfiguration > &value)
 
DescribeTrainingJobResultWithDebugRuleConfigurations (Aws::Vector< DebugRuleConfiguration > &&value)
 
DescribeTrainingJobResultAddDebugRuleConfigurations (const DebugRuleConfiguration &value)
 
DescribeTrainingJobResultAddDebugRuleConfigurations (DebugRuleConfiguration &&value)
 
const TensorBoardOutputConfigGetTensorBoardOutputConfig () const
 
void SetTensorBoardOutputConfig (const TensorBoardOutputConfig &value)
 
void SetTensorBoardOutputConfig (TensorBoardOutputConfig &&value)
 
DescribeTrainingJobResultWithTensorBoardOutputConfig (const TensorBoardOutputConfig &value)
 
DescribeTrainingJobResultWithTensorBoardOutputConfig (TensorBoardOutputConfig &&value)
 
const Aws::Vector< DebugRuleEvaluationStatus > & GetDebugRuleEvaluationStatuses () const
 
void SetDebugRuleEvaluationStatuses (const Aws::Vector< DebugRuleEvaluationStatus > &value)
 
void SetDebugRuleEvaluationStatuses (Aws::Vector< DebugRuleEvaluationStatus > &&value)
 
DescribeTrainingJobResultWithDebugRuleEvaluationStatuses (const Aws::Vector< DebugRuleEvaluationStatus > &value)
 
DescribeTrainingJobResultWithDebugRuleEvaluationStatuses (Aws::Vector< DebugRuleEvaluationStatus > &&value)
 
DescribeTrainingJobResultAddDebugRuleEvaluationStatuses (const DebugRuleEvaluationStatus &value)
 
DescribeTrainingJobResultAddDebugRuleEvaluationStatuses (DebugRuleEvaluationStatus &&value)
 
const ProfilerConfigGetProfilerConfig () const
 
void SetProfilerConfig (const ProfilerConfig &value)
 
void SetProfilerConfig (ProfilerConfig &&value)
 
DescribeTrainingJobResultWithProfilerConfig (const ProfilerConfig &value)
 
DescribeTrainingJobResultWithProfilerConfig (ProfilerConfig &&value)
 
const Aws::Vector< ProfilerRuleConfiguration > & GetProfilerRuleConfigurations () const
 
void SetProfilerRuleConfigurations (const Aws::Vector< ProfilerRuleConfiguration > &value)
 
void SetProfilerRuleConfigurations (Aws::Vector< ProfilerRuleConfiguration > &&value)
 
DescribeTrainingJobResultWithProfilerRuleConfigurations (const Aws::Vector< ProfilerRuleConfiguration > &value)
 
DescribeTrainingJobResultWithProfilerRuleConfigurations (Aws::Vector< ProfilerRuleConfiguration > &&value)
 
DescribeTrainingJobResultAddProfilerRuleConfigurations (const ProfilerRuleConfiguration &value)
 
DescribeTrainingJobResultAddProfilerRuleConfigurations (ProfilerRuleConfiguration &&value)
 
const Aws::Vector< ProfilerRuleEvaluationStatus > & GetProfilerRuleEvaluationStatuses () const
 
void SetProfilerRuleEvaluationStatuses (const Aws::Vector< ProfilerRuleEvaluationStatus > &value)
 
void SetProfilerRuleEvaluationStatuses (Aws::Vector< ProfilerRuleEvaluationStatus > &&value)
 
DescribeTrainingJobResultWithProfilerRuleEvaluationStatuses (const Aws::Vector< ProfilerRuleEvaluationStatus > &value)
 
DescribeTrainingJobResultWithProfilerRuleEvaluationStatuses (Aws::Vector< ProfilerRuleEvaluationStatus > &&value)
 
DescribeTrainingJobResultAddProfilerRuleEvaluationStatuses (const ProfilerRuleEvaluationStatus &value)
 
DescribeTrainingJobResultAddProfilerRuleEvaluationStatuses (ProfilerRuleEvaluationStatus &&value)
 
const ProfilingStatusGetProfilingStatus () const
 
void SetProfilingStatus (const ProfilingStatus &value)
 
void SetProfilingStatus (ProfilingStatus &&value)
 
DescribeTrainingJobResultWithProfilingStatus (const ProfilingStatus &value)
 
DescribeTrainingJobResultWithProfilingStatus (ProfilingStatus &&value)
 
const RetryStrategyGetRetryStrategy () const
 
void SetRetryStrategy (const RetryStrategy &value)
 
void SetRetryStrategy (RetryStrategy &&value)
 
DescribeTrainingJobResultWithRetryStrategy (const RetryStrategy &value)
 
DescribeTrainingJobResultWithRetryStrategy (RetryStrategy &&value)
 
const Aws::Map< Aws::String, Aws::String > & GetEnvironment () const
 
void SetEnvironment (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetEnvironment (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeTrainingJobResultWithEnvironment (const Aws::Map< Aws::String, Aws::String > &value)
 
DescribeTrainingJobResultWithEnvironment (Aws::Map< Aws::String, Aws::String > &&value)
 
DescribeTrainingJobResultAddEnvironment (const Aws::String &key, const Aws::String &value)
 
DescribeTrainingJobResultAddEnvironment (Aws::String &&key, const Aws::String &value)
 
DescribeTrainingJobResultAddEnvironment (const Aws::String &key, Aws::String &&value)
 
DescribeTrainingJobResultAddEnvironment (Aws::String &&key, Aws::String &&value)
 
DescribeTrainingJobResultAddEnvironment (const char *key, Aws::String &&value)
 
DescribeTrainingJobResultAddEnvironment (Aws::String &&key, const char *value)
 
DescribeTrainingJobResultAddEnvironment (const char *key, const char *value)
 

Detailed Description

Definition at line 52 of file DescribeTrainingJobResult.h.

Constructor & Destructor Documentation

◆ DescribeTrainingJobResult() [1/2]

Aws::SageMaker::Model::DescribeTrainingJobResult::DescribeTrainingJobResult ( )

◆ DescribeTrainingJobResult() [2/2]

Aws::SageMaker::Model::DescribeTrainingJobResult::DescribeTrainingJobResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddDebugRuleConfigurations() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddDebugRuleConfigurations ( const DebugRuleConfiguration value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1348 of file DescribeTrainingJobResult.h.

◆ AddDebugRuleConfigurations() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddDebugRuleConfigurations ( DebugRuleConfiguration &&  value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1354 of file DescribeTrainingJobResult.h.

◆ AddDebugRuleEvaluationStatuses() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddDebugRuleEvaluationStatuses ( const DebugRuleEvaluationStatus value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1401 of file DescribeTrainingJobResult.h.

◆ AddDebugRuleEvaluationStatuses() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddDebugRuleEvaluationStatuses ( DebugRuleEvaluationStatus &&  value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1406 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [1/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1604 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [2/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( Aws::String &&  key,
const Aws::String value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1594 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [3/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( Aws::String &&  key,
const char *  value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1614 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [4/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( const Aws::String key,
Aws::String &&  value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1599 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [5/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( const Aws::String key,
const Aws::String value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1589 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [6/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( const char *  key,
Aws::String &&  value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1609 of file DescribeTrainingJobResult.h.

◆ AddEnvironment() [7/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddEnvironment ( const char *  key,
const char *  value 
)
inline

The environment variables to set in the Docker container.

Definition at line 1619 of file DescribeTrainingJobResult.h.

◆ AddFinalMetricDataList() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddFinalMetricDataList ( const MetricData value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1122 of file DescribeTrainingJobResult.h.

◆ AddFinalMetricDataList() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddFinalMetricDataList ( MetricData &&  value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1129 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [1/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( Aws::String &&  key,
Aws::String &&  value 
)
inline

Algorithm-specific parameters.

Definition at line 596 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [2/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( Aws::String &&  key,
const Aws::String value 
)
inline

Algorithm-specific parameters.

Definition at line 586 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [3/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( Aws::String &&  key,
const char *  value 
)
inline

Algorithm-specific parameters.

Definition at line 606 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [4/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( const Aws::String key,
Aws::String &&  value 
)
inline

Algorithm-specific parameters.

Definition at line 591 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [5/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( const Aws::String key,
const Aws::String value 
)
inline

Algorithm-specific parameters.

Definition at line 581 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [6/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( const char *  key,
Aws::String &&  value 
)
inline

Algorithm-specific parameters.

Definition at line 601 of file DescribeTrainingJobResult.h.

◆ AddHyperParameters() [7/7]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddHyperParameters ( const char *  key,
const char *  value 
)
inline

Algorithm-specific parameters.

Definition at line 611 of file DescribeTrainingJobResult.h.

◆ AddInputDataConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddInputDataConfig ( Channel &&  value)
inline

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

Definition at line 728 of file DescribeTrainingJobResult.h.

◆ AddInputDataConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddInputDataConfig ( const Channel value)
inline

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

Definition at line 722 of file DescribeTrainingJobResult.h.

◆ AddProfilerRuleConfigurations() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddProfilerRuleConfigurations ( const ProfilerRuleConfiguration value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1459 of file DescribeTrainingJobResult.h.

◆ AddProfilerRuleConfigurations() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddProfilerRuleConfigurations ( ProfilerRuleConfiguration &&  value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1465 of file DescribeTrainingJobResult.h.

◆ AddProfilerRuleEvaluationStatuses() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddProfilerRuleEvaluationStatuses ( const ProfilerRuleEvaluationStatus value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1496 of file DescribeTrainingJobResult.h.

◆ AddProfilerRuleEvaluationStatuses() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddProfilerRuleEvaluationStatuses ( ProfilerRuleEvaluationStatus &&  value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1501 of file DescribeTrainingJobResult.h.

◆ AddSecondaryStatusTransitions() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddSecondaryStatusTransitions ( const SecondaryStatusTransition value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1073 of file DescribeTrainingJobResult.h.

◆ AddSecondaryStatusTransitions() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::AddSecondaryStatusTransitions ( SecondaryStatusTransition &&  value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1079 of file DescribeTrainingJobResult.h.

◆ GetAlgorithmSpecification()

const AlgorithmSpecification& Aws::SageMaker::Model::DescribeTrainingJobResult::GetAlgorithmSpecification ( ) const
inline

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

Definition at line 618 of file DescribeTrainingJobResult.h.

◆ GetAutoMLJobArn()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetAutoMLJobArn ( ) const
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 221 of file DescribeTrainingJobResult.h.

◆ GetBillableTimeInSeconds()

int Aws::SageMaker::Model::DescribeTrainingJobResult::GetBillableTimeInSeconds ( ) const
inline

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker will bill you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

Definition at line 1253 of file DescribeTrainingJobResult.h.

◆ GetCheckpointConfig()

const CheckpointConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetCheckpointConfig ( ) const
inline

Definition at line 1211 of file DescribeTrainingJobResult.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::DescribeTrainingJobResult::GetCreationTime ( ) const
inline

A timestamp that indicates when the training job was created.

Definition at line 893 of file DescribeTrainingJobResult.h.

◆ GetDebugHookConfig()

const DebugHookConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetDebugHookConfig ( ) const
inline

Definition at line 1283 of file DescribeTrainingJobResult.h.

◆ GetDebugRuleConfigurations()

const Aws::Vector<DebugRuleConfiguration>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetDebugRuleConfigurations ( ) const
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1318 of file DescribeTrainingJobResult.h.

◆ GetDebugRuleEvaluationStatuses()

const Aws::Vector<DebugRuleEvaluationStatus>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetDebugRuleEvaluationStatuses ( ) const
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1376 of file DescribeTrainingJobResult.h.

◆ GetEnableInterContainerTrafficEncryption()

bool Aws::SageMaker::Model::DescribeTrainingJobResult::GetEnableInterContainerTrafficEncryption ( ) const
inline

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

Definition at line 1170 of file DescribeTrainingJobResult.h.

◆ GetEnableManagedSpotTraining()

bool Aws::SageMaker::Model::DescribeTrainingJobResult::GetEnableManagedSpotTraining ( ) const
inline

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Definition at line 1195 of file DescribeTrainingJobResult.h.

◆ GetEnableNetworkIsolation()

bool Aws::SageMaker::Model::DescribeTrainingJobResult::GetEnableNetworkIsolation ( ) const
inline

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Definition at line 1140 of file DescribeTrainingJobResult.h.

◆ GetEnvironment()

const Aws::Map<Aws::String, Aws::String>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetEnvironment ( ) const
inline

The environment variables to set in the Docker container.

Definition at line 1564 of file DescribeTrainingJobResult.h.

◆ GetExperimentConfig()

const ExperimentConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetExperimentConfig ( ) const
inline

Definition at line 1299 of file DescribeTrainingJobResult.h.

◆ GetFailureReason()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetFailureReason ( ) const
inline

If the training job failed, the reason it failed.

Definition at line 520 of file DescribeTrainingJobResult.h.

◆ GetFinalMetricDataList()

const Aws::Vector<MetricData>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetFinalMetricDataList ( ) const
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1087 of file DescribeTrainingJobResult.h.

◆ GetHyperParameters()

const Aws::Map<Aws::String, Aws::String>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetHyperParameters ( ) const
inline

Algorithm-specific parameters.

Definition at line 556 of file DescribeTrainingJobResult.h.

◆ GetInputDataConfig()

const Aws::Vector<Channel>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetInputDataConfig ( ) const
inline

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

Definition at line 692 of file DescribeTrainingJobResult.h.

◆ GetLabelingJobArn()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetLabelingJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 179 of file DescribeTrainingJobResult.h.

◆ GetLastModifiedTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::DescribeTrainingJobResult::GetLastModifiedTime ( ) const
inline

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

Definition at line 1012 of file DescribeTrainingJobResult.h.

◆ GetModelArtifacts()

const ModelArtifacts& Aws::SageMaker::Model::DescribeTrainingJobResult::GetModelArtifacts ( ) const
inline

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

Definition at line 258 of file DescribeTrainingJobResult.h.

◆ GetOutputDataConfig()

const OutputDataConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetOutputDataConfig ( ) const
inline

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

Definition at line 735 of file DescribeTrainingJobResult.h.

◆ GetProfilerConfig()

const ProfilerConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetProfilerConfig ( ) const
inline

Definition at line 1410 of file DescribeTrainingJobResult.h.

◆ GetProfilerRuleConfigurations()

const Aws::Vector<ProfilerRuleConfiguration>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetProfilerRuleConfigurations ( ) const
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1429 of file DescribeTrainingJobResult.h.

◆ GetProfilerRuleEvaluationStatuses()

const Aws::Vector<ProfilerRuleEvaluationStatus>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetProfilerRuleEvaluationStatuses ( ) const
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1471 of file DescribeTrainingJobResult.h.

◆ GetProfilingStatus()

const ProfilingStatus& Aws::SageMaker::Model::DescribeTrainingJobResult::GetProfilingStatus ( ) const
inline

Profiling status of a training job.

Definition at line 1507 of file DescribeTrainingJobResult.h.

◆ GetResourceConfig()

const ResourceConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetResourceConfig ( ) const
inline

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

Definition at line 766 of file DescribeTrainingJobResult.h.

◆ GetRetryStrategy()

const RetryStrategy& Aws::SageMaker::Model::DescribeTrainingJobResult::GetRetryStrategy ( ) const
inline

The number of times to retry the job when the job fails due to an InternalServerError.

Definition at line 1534 of file DescribeTrainingJobResult.h.

◆ GetRoleArn()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetRoleArn ( ) const
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 649 of file DescribeTrainingJobResult.h.

◆ GetSecondaryStatus()

const SecondaryStatus& Aws::SageMaker::Model::DescribeTrainingJobResult::GetSecondaryStatus ( ) const
inline

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

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

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

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

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

Definition at line 386 of file DescribeTrainingJobResult.h.

◆ GetSecondaryStatusTransitions()

const Aws::Vector<SecondaryStatusTransition>& Aws::SageMaker::Model::DescribeTrainingJobResult::GetSecondaryStatusTransitions ( ) const
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1043 of file DescribeTrainingJobResult.h.

◆ GetStoppingCondition()

const StoppingCondition& Aws::SageMaker::Model::DescribeTrainingJobResult::GetStoppingCondition ( ) const
inline

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Definition at line 843 of file DescribeTrainingJobResult.h.

◆ GetTensorBoardOutputConfig()

const TensorBoardOutputConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTensorBoardOutputConfig ( ) const
inline

Definition at line 1358 of file DescribeTrainingJobResult.h.

◆ GetTrainingEndTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingEndTime ( ) const
inline

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

Definition at line 969 of file DescribeTrainingJobResult.h.

◆ GetTrainingJobArn()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingJobArn ( ) const
inline

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

Definition at line 99 of file DescribeTrainingJobResult.h.

◆ GetTrainingJobName()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingJobName ( ) const
inline

Name of the model training job.

Definition at line 63 of file DescribeTrainingJobResult.h.

◆ GetTrainingJobStatus()

const TrainingJobStatus& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingJobStatus ( ) const
inline

The status of the training job.

Amazon SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

Definition at line 297 of file DescribeTrainingJobResult.h.

◆ GetTrainingStartTime()

const Aws::Utils::DateTime& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingStartTime ( ) const
inline

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

Definition at line 923 of file DescribeTrainingJobResult.h.

◆ GetTrainingTimeInSeconds()

int Aws::SageMaker::Model::DescribeTrainingJobResult::GetTrainingTimeInSeconds ( ) const
inline

The training time in seconds.

Definition at line 1229 of file DescribeTrainingJobResult.h.

◆ GetTuningJobArn()

const Aws::String& Aws::SageMaker::Model::DescribeTrainingJobResult::GetTuningJobArn ( ) const
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 136 of file DescribeTrainingJobResult.h.

◆ GetVpcConfig()

const VpcConfig& Aws::SageMaker::Model::DescribeTrainingJobResult::GetVpcConfig ( ) const
inline

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Definition at line 799 of file DescribeTrainingJobResult.h.

◆ operator=()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetAlgorithmSpecification() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetAlgorithmSpecification ( AlgorithmSpecification &&  value)
inline

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

Definition at line 630 of file DescribeTrainingJobResult.h.

◆ SetAlgorithmSpecification() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetAlgorithmSpecification ( const AlgorithmSpecification value)
inline

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

Definition at line 624 of file DescribeTrainingJobResult.h.

◆ SetAutoMLJobArn() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetAutoMLJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 231 of file DescribeTrainingJobResult.h.

◆ SetAutoMLJobArn() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetAutoMLJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 226 of file DescribeTrainingJobResult.h.

◆ SetAutoMLJobArn() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetAutoMLJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 236 of file DescribeTrainingJobResult.h.

◆ SetBillableTimeInSeconds()

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetBillableTimeInSeconds ( int  value)
inline

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker will bill you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

Definition at line 1266 of file DescribeTrainingJobResult.h.

◆ SetCheckpointConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetCheckpointConfig ( CheckpointConfig &&  value)
inline

Definition at line 1217 of file DescribeTrainingJobResult.h.

◆ SetCheckpointConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetCheckpointConfig ( const CheckpointConfig value)
inline

Definition at line 1214 of file DescribeTrainingJobResult.h.

◆ SetCreationTime() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when the training job was created.

Definition at line 903 of file DescribeTrainingJobResult.h.

◆ SetCreationTime() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when the training job was created.

Definition at line 898 of file DescribeTrainingJobResult.h.

◆ SetDebugHookConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugHookConfig ( const DebugHookConfig value)
inline

Definition at line 1286 of file DescribeTrainingJobResult.h.

◆ SetDebugHookConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugHookConfig ( DebugHookConfig &&  value)
inline

Definition at line 1289 of file DescribeTrainingJobResult.h.

◆ SetDebugRuleConfigurations() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugRuleConfigurations ( Aws::Vector< DebugRuleConfiguration > &&  value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1330 of file DescribeTrainingJobResult.h.

◆ SetDebugRuleConfigurations() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugRuleConfigurations ( const Aws::Vector< DebugRuleConfiguration > &  value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1324 of file DescribeTrainingJobResult.h.

◆ SetDebugRuleEvaluationStatuses() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugRuleEvaluationStatuses ( Aws::Vector< DebugRuleEvaluationStatus > &&  value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1386 of file DescribeTrainingJobResult.h.

◆ SetDebugRuleEvaluationStatuses() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetDebugRuleEvaluationStatuses ( const Aws::Vector< DebugRuleEvaluationStatus > &  value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1381 of file DescribeTrainingJobResult.h.

◆ SetEnableInterContainerTrafficEncryption()

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetEnableInterContainerTrafficEncryption ( bool  value)
inline

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

Definition at line 1179 of file DescribeTrainingJobResult.h.

◆ SetEnableManagedSpotTraining()

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetEnableManagedSpotTraining ( bool  value)
inline

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Definition at line 1201 of file DescribeTrainingJobResult.h.

◆ SetEnableNetworkIsolation()

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetEnableNetworkIsolation ( bool  value)
inline

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Definition at line 1150 of file DescribeTrainingJobResult.h.

◆ SetEnvironment() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetEnvironment ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The environment variables to set in the Docker container.

Definition at line 1574 of file DescribeTrainingJobResult.h.

◆ SetEnvironment() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetEnvironment ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The environment variables to set in the Docker container.

Definition at line 1569 of file DescribeTrainingJobResult.h.

◆ SetExperimentConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetExperimentConfig ( const ExperimentConfig value)
inline

Definition at line 1302 of file DescribeTrainingJobResult.h.

◆ SetExperimentConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetExperimentConfig ( ExperimentConfig &&  value)
inline

Definition at line 1305 of file DescribeTrainingJobResult.h.

◆ SetFailureReason() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetFailureReason ( Aws::String &&  value)
inline

If the training job failed, the reason it failed.

Definition at line 530 of file DescribeTrainingJobResult.h.

◆ SetFailureReason() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetFailureReason ( const Aws::String value)
inline

If the training job failed, the reason it failed.

Definition at line 525 of file DescribeTrainingJobResult.h.

◆ SetFailureReason() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetFailureReason ( const char *  value)
inline

If the training job failed, the reason it failed.

Definition at line 535 of file DescribeTrainingJobResult.h.

◆ SetFinalMetricDataList() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetFinalMetricDataList ( Aws::Vector< MetricData > &&  value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1101 of file DescribeTrainingJobResult.h.

◆ SetFinalMetricDataList() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetFinalMetricDataList ( const Aws::Vector< MetricData > &  value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1094 of file DescribeTrainingJobResult.h.

◆ SetHyperParameters() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetHyperParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Algorithm-specific parameters.

Definition at line 566 of file DescribeTrainingJobResult.h.

◆ SetHyperParameters() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetHyperParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Algorithm-specific parameters.

Definition at line 561 of file DescribeTrainingJobResult.h.

◆ SetInputDataConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetInputDataConfig ( Aws::Vector< Channel > &&  value)
inline

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

Definition at line 704 of file DescribeTrainingJobResult.h.

◆ SetInputDataConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetInputDataConfig ( const Aws::Vector< Channel > &  value)
inline

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

Definition at line 698 of file DescribeTrainingJobResult.h.

◆ SetLabelingJobArn() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetLabelingJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 191 of file DescribeTrainingJobResult.h.

◆ SetLabelingJobArn() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetLabelingJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 185 of file DescribeTrainingJobResult.h.

◆ SetLabelingJobArn() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetLabelingJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 197 of file DescribeTrainingJobResult.h.

◆ SetLastModifiedTime() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 1024 of file DescribeTrainingJobResult.h.

◆ SetLastModifiedTime() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetLastModifiedTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 1018 of file DescribeTrainingJobResult.h.

◆ SetModelArtifacts() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetModelArtifacts ( const ModelArtifacts value)
inline

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

Definition at line 264 of file DescribeTrainingJobResult.h.

◆ SetModelArtifacts() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetModelArtifacts ( ModelArtifacts &&  value)
inline

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

Definition at line 270 of file DescribeTrainingJobResult.h.

◆ SetOutputDataConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetOutputDataConfig ( const OutputDataConfig value)
inline

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

Definition at line 741 of file DescribeTrainingJobResult.h.

◆ SetOutputDataConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetOutputDataConfig ( OutputDataConfig &&  value)
inline

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

Definition at line 747 of file DescribeTrainingJobResult.h.

◆ SetProfilerConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerConfig ( const ProfilerConfig value)
inline

Definition at line 1413 of file DescribeTrainingJobResult.h.

◆ SetProfilerConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerConfig ( ProfilerConfig &&  value)
inline

Definition at line 1416 of file DescribeTrainingJobResult.h.

◆ SetProfilerRuleConfigurations() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerRuleConfigurations ( Aws::Vector< ProfilerRuleConfiguration > &&  value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1441 of file DescribeTrainingJobResult.h.

◆ SetProfilerRuleConfigurations() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerRuleConfigurations ( const Aws::Vector< ProfilerRuleConfiguration > &  value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1435 of file DescribeTrainingJobResult.h.

◆ SetProfilerRuleEvaluationStatuses() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerRuleEvaluationStatuses ( Aws::Vector< ProfilerRuleEvaluationStatus > &&  value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1481 of file DescribeTrainingJobResult.h.

◆ SetProfilerRuleEvaluationStatuses() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilerRuleEvaluationStatuses ( const Aws::Vector< ProfilerRuleEvaluationStatus > &  value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1476 of file DescribeTrainingJobResult.h.

◆ SetProfilingStatus() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilingStatus ( const ProfilingStatus value)
inline

Profiling status of a training job.

Definition at line 1512 of file DescribeTrainingJobResult.h.

◆ SetProfilingStatus() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetProfilingStatus ( ProfilingStatus &&  value)
inline

Profiling status of a training job.

Definition at line 1517 of file DescribeTrainingJobResult.h.

◆ SetResourceConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetResourceConfig ( const ResourceConfig value)
inline

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

Definition at line 772 of file DescribeTrainingJobResult.h.

◆ SetResourceConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetResourceConfig ( ResourceConfig &&  value)
inline

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

Definition at line 778 of file DescribeTrainingJobResult.h.

◆ SetRetryStrategy() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetRetryStrategy ( const RetryStrategy value)
inline

The number of times to retry the job when the job fails due to an InternalServerError.

Definition at line 1540 of file DescribeTrainingJobResult.h.

◆ SetRetryStrategy() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetRetryStrategy ( RetryStrategy &&  value)
inline

The number of times to retry the job when the job fails due to an InternalServerError.

Definition at line 1546 of file DescribeTrainingJobResult.h.

◆ SetRoleArn() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetRoleArn ( Aws::String &&  value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 661 of file DescribeTrainingJobResult.h.

◆ SetRoleArn() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetRoleArn ( const Aws::String value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 655 of file DescribeTrainingJobResult.h.

◆ SetRoleArn() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetRoleArn ( const char *  value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 667 of file DescribeTrainingJobResult.h.

◆ SetSecondaryStatus() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetSecondaryStatus ( const SecondaryStatus value)
inline

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

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

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

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

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

Definition at line 418 of file DescribeTrainingJobResult.h.

◆ SetSecondaryStatus() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetSecondaryStatus ( SecondaryStatus &&  value)
inline

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

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

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

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

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

Definition at line 450 of file DescribeTrainingJobResult.h.

◆ SetSecondaryStatusTransitions() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetSecondaryStatusTransitions ( Aws::Vector< SecondaryStatusTransition > &&  value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1055 of file DescribeTrainingJobResult.h.

◆ SetSecondaryStatusTransitions() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetSecondaryStatusTransitions ( const Aws::Vector< SecondaryStatusTransition > &  value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1049 of file DescribeTrainingJobResult.h.

◆ SetStoppingCondition() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetStoppingCondition ( const StoppingCondition value)
inline

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Definition at line 854 of file DescribeTrainingJobResult.h.

◆ SetStoppingCondition() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetStoppingCondition ( StoppingCondition &&  value)
inline

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Definition at line 865 of file DescribeTrainingJobResult.h.

◆ SetTensorBoardOutputConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTensorBoardOutputConfig ( const TensorBoardOutputConfig value)
inline

Definition at line 1361 of file DescribeTrainingJobResult.h.

◆ SetTensorBoardOutputConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTensorBoardOutputConfig ( TensorBoardOutputConfig &&  value)
inline

Definition at line 1364 of file DescribeTrainingJobResult.h.

◆ SetTrainingEndTime() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingEndTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

Definition at line 987 of file DescribeTrainingJobResult.h.

◆ SetTrainingEndTime() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingEndTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

Definition at line 978 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobArn() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobArn ( Aws::String &&  value)
inline

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

Definition at line 109 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobArn() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobArn ( const Aws::String value)
inline

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

Definition at line 104 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobArn() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobArn ( const char *  value)
inline

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

Definition at line 114 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobName() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobName ( Aws::String &&  value)
inline

Name of the model training job.

Definition at line 73 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobName() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobName ( const Aws::String value)
inline

Name of the model training job.

Definition at line 68 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobName() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobName ( const char *  value)
inline

Name of the model training job.

Definition at line 78 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobStatus() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobStatus ( const TrainingJobStatus value)
inline

The status of the training job.

Amazon SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

Definition at line 311 of file DescribeTrainingJobResult.h.

◆ SetTrainingJobStatus() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingJobStatus ( TrainingJobStatus &&  value)
inline

The status of the training job.

Amazon SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

Definition at line 325 of file DescribeTrainingJobResult.h.

◆ SetTrainingStartTime() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

Definition at line 941 of file DescribeTrainingJobResult.h.

◆ SetTrainingStartTime() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

Definition at line 932 of file DescribeTrainingJobResult.h.

◆ SetTrainingTimeInSeconds()

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTrainingTimeInSeconds ( int  value)
inline

The training time in seconds.

Definition at line 1234 of file DescribeTrainingJobResult.h.

◆ SetTuningJobArn() [1/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTuningJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 148 of file DescribeTrainingJobResult.h.

◆ SetTuningJobArn() [2/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTuningJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 142 of file DescribeTrainingJobResult.h.

◆ SetTuningJobArn() [3/3]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetTuningJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 154 of file DescribeTrainingJobResult.h.

◆ SetVpcConfig() [1/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetVpcConfig ( const VpcConfig value)
inline

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Definition at line 807 of file DescribeTrainingJobResult.h.

◆ SetVpcConfig() [2/2]

void Aws::SageMaker::Model::DescribeTrainingJobResult::SetVpcConfig ( VpcConfig &&  value)
inline

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Definition at line 815 of file DescribeTrainingJobResult.h.

◆ WithAlgorithmSpecification() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithAlgorithmSpecification ( AlgorithmSpecification &&  value)
inline

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

Definition at line 642 of file DescribeTrainingJobResult.h.

◆ WithAlgorithmSpecification() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithAlgorithmSpecification ( const AlgorithmSpecification value)
inline

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

Definition at line 636 of file DescribeTrainingJobResult.h.

◆ WithAutoMLJobArn() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithAutoMLJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 246 of file DescribeTrainingJobResult.h.

◆ WithAutoMLJobArn() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithAutoMLJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 241 of file DescribeTrainingJobResult.h.

◆ WithAutoMLJobArn() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithAutoMLJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of an AutoML job.

Definition at line 251 of file DescribeTrainingJobResult.h.

◆ WithBillableTimeInSeconds()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithBillableTimeInSeconds ( int  value)
inline

The billable time in seconds. Billable time refers to the absolute wall-clock time.

Multiply BillableTimeInSeconds by the number of instances (InstanceCount) in your training cluster to get the total compute time SageMaker will bill you if you run distributed training. The formula is as follows: BillableTimeInSeconds * InstanceCount .

You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

Definition at line 1279 of file DescribeTrainingJobResult.h.

◆ WithCheckpointConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithCheckpointConfig ( CheckpointConfig &&  value)
inline

Definition at line 1223 of file DescribeTrainingJobResult.h.

◆ WithCheckpointConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithCheckpointConfig ( const CheckpointConfig value)
inline

Definition at line 1220 of file DescribeTrainingJobResult.h.

◆ WithCreationTime() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

A timestamp that indicates when the training job was created.

Definition at line 913 of file DescribeTrainingJobResult.h.

◆ WithCreationTime() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithCreationTime ( const Aws::Utils::DateTime value)
inline

A timestamp that indicates when the training job was created.

Definition at line 908 of file DescribeTrainingJobResult.h.

◆ WithDebugHookConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugHookConfig ( const DebugHookConfig value)
inline

Definition at line 1292 of file DescribeTrainingJobResult.h.

◆ WithDebugHookConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugHookConfig ( DebugHookConfig &&  value)
inline

Definition at line 1295 of file DescribeTrainingJobResult.h.

◆ WithDebugRuleConfigurations() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugRuleConfigurations ( Aws::Vector< DebugRuleConfiguration > &&  value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1342 of file DescribeTrainingJobResult.h.

◆ WithDebugRuleConfigurations() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugRuleConfigurations ( const Aws::Vector< DebugRuleConfiguration > &  value)
inline

Configuration information for Debugger rules for debugging output tensors.

Definition at line 1336 of file DescribeTrainingJobResult.h.

◆ WithDebugRuleEvaluationStatuses() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugRuleEvaluationStatuses ( Aws::Vector< DebugRuleEvaluationStatus > &&  value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1396 of file DescribeTrainingJobResult.h.

◆ WithDebugRuleEvaluationStatuses() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithDebugRuleEvaluationStatuses ( const Aws::Vector< DebugRuleEvaluationStatus > &  value)
inline

Evaluation status of Debugger rules for debugging on a training job.

Definition at line 1391 of file DescribeTrainingJobResult.h.

◆ WithEnableInterContainerTrafficEncryption()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithEnableInterContainerTrafficEncryption ( bool  value)
inline

To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

Definition at line 1188 of file DescribeTrainingJobResult.h.

◆ WithEnableManagedSpotTraining()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithEnableManagedSpotTraining ( bool  value)
inline

A Boolean indicating whether managed spot training is enabled (True) or not (False).

Definition at line 1207 of file DescribeTrainingJobResult.h.

◆ WithEnableNetworkIsolation()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithEnableNetworkIsolation ( bool  value)
inline

If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

Definition at line 1160 of file DescribeTrainingJobResult.h.

◆ WithEnvironment() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithEnvironment ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The environment variables to set in the Docker container.

Definition at line 1584 of file DescribeTrainingJobResult.h.

◆ WithEnvironment() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithEnvironment ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The environment variables to set in the Docker container.

Definition at line 1579 of file DescribeTrainingJobResult.h.

◆ WithExperimentConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithExperimentConfig ( const ExperimentConfig value)
inline

Definition at line 1308 of file DescribeTrainingJobResult.h.

◆ WithExperimentConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithExperimentConfig ( ExperimentConfig &&  value)
inline

Definition at line 1311 of file DescribeTrainingJobResult.h.

◆ WithFailureReason() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithFailureReason ( Aws::String &&  value)
inline

If the training job failed, the reason it failed.

Definition at line 545 of file DescribeTrainingJobResult.h.

◆ WithFailureReason() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithFailureReason ( const Aws::String value)
inline

If the training job failed, the reason it failed.

Definition at line 540 of file DescribeTrainingJobResult.h.

◆ WithFailureReason() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithFailureReason ( const char *  value)
inline

If the training job failed, the reason it failed.

Definition at line 550 of file DescribeTrainingJobResult.h.

◆ WithFinalMetricDataList() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithFinalMetricDataList ( Aws::Vector< MetricData > &&  value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1115 of file DescribeTrainingJobResult.h.

◆ WithFinalMetricDataList() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithFinalMetricDataList ( const Aws::Vector< MetricData > &  value)
inline

A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

Definition at line 1108 of file DescribeTrainingJobResult.h.

◆ WithHyperParameters() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithHyperParameters ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

Algorithm-specific parameters.

Definition at line 576 of file DescribeTrainingJobResult.h.

◆ WithHyperParameters() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithHyperParameters ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

Algorithm-specific parameters.

Definition at line 571 of file DescribeTrainingJobResult.h.

◆ WithInputDataConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithInputDataConfig ( Aws::Vector< Channel > &&  value)
inline

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

Definition at line 716 of file DescribeTrainingJobResult.h.

◆ WithInputDataConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithInputDataConfig ( const Aws::Vector< Channel > &  value)
inline

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

Definition at line 710 of file DescribeTrainingJobResult.h.

◆ WithLabelingJobArn() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithLabelingJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 209 of file DescribeTrainingJobResult.h.

◆ WithLabelingJobArn() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithLabelingJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 203 of file DescribeTrainingJobResult.h.

◆ WithLabelingJobArn() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithLabelingJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

Definition at line 215 of file DescribeTrainingJobResult.h.

◆ WithLastModifiedTime() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 1036 of file DescribeTrainingJobResult.h.

◆ WithLastModifiedTime() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithLastModifiedTime ( const Aws::Utils::DateTime value)
inline

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

Definition at line 1030 of file DescribeTrainingJobResult.h.

◆ WithModelArtifacts() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithModelArtifacts ( const ModelArtifacts value)
inline

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

Definition at line 276 of file DescribeTrainingJobResult.h.

◆ WithModelArtifacts() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithModelArtifacts ( ModelArtifacts &&  value)
inline

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

Definition at line 282 of file DescribeTrainingJobResult.h.

◆ WithOutputDataConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithOutputDataConfig ( const OutputDataConfig value)
inline

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

Definition at line 753 of file DescribeTrainingJobResult.h.

◆ WithOutputDataConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithOutputDataConfig ( OutputDataConfig &&  value)
inline

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

Definition at line 759 of file DescribeTrainingJobResult.h.

◆ WithProfilerConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerConfig ( const ProfilerConfig value)
inline

Definition at line 1419 of file DescribeTrainingJobResult.h.

◆ WithProfilerConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerConfig ( ProfilerConfig &&  value)
inline

Definition at line 1422 of file DescribeTrainingJobResult.h.

◆ WithProfilerRuleConfigurations() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerRuleConfigurations ( Aws::Vector< ProfilerRuleConfiguration > &&  value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1453 of file DescribeTrainingJobResult.h.

◆ WithProfilerRuleConfigurations() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerRuleConfigurations ( const Aws::Vector< ProfilerRuleConfiguration > &  value)
inline

Configuration information for Debugger rules for profiling system and framework metrics.

Definition at line 1447 of file DescribeTrainingJobResult.h.

◆ WithProfilerRuleEvaluationStatuses() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerRuleEvaluationStatuses ( Aws::Vector< ProfilerRuleEvaluationStatus > &&  value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1491 of file DescribeTrainingJobResult.h.

◆ WithProfilerRuleEvaluationStatuses() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilerRuleEvaluationStatuses ( const Aws::Vector< ProfilerRuleEvaluationStatus > &  value)
inline

Evaluation status of Debugger rules for profiling on a training job.

Definition at line 1486 of file DescribeTrainingJobResult.h.

◆ WithProfilingStatus() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilingStatus ( const ProfilingStatus value)
inline

Profiling status of a training job.

Definition at line 1522 of file DescribeTrainingJobResult.h.

◆ WithProfilingStatus() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithProfilingStatus ( ProfilingStatus &&  value)
inline

Profiling status of a training job.

Definition at line 1527 of file DescribeTrainingJobResult.h.

◆ WithResourceConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithResourceConfig ( const ResourceConfig value)
inline

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

Definition at line 784 of file DescribeTrainingJobResult.h.

◆ WithResourceConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithResourceConfig ( ResourceConfig &&  value)
inline

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

Definition at line 790 of file DescribeTrainingJobResult.h.

◆ WithRetryStrategy() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithRetryStrategy ( const RetryStrategy value)
inline

The number of times to retry the job when the job fails due to an InternalServerError.

Definition at line 1552 of file DescribeTrainingJobResult.h.

◆ WithRetryStrategy() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithRetryStrategy ( RetryStrategy &&  value)
inline

The number of times to retry the job when the job fails due to an InternalServerError.

Definition at line 1558 of file DescribeTrainingJobResult.h.

◆ WithRoleArn() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithRoleArn ( Aws::String &&  value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 679 of file DescribeTrainingJobResult.h.

◆ WithRoleArn() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithRoleArn ( const Aws::String value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 673 of file DescribeTrainingJobResult.h.

◆ WithRoleArn() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithRoleArn ( const char *  value)
inline

The Amazon Web Services Identity and Access Management (IAM) role configured for the training job.

Definition at line 685 of file DescribeTrainingJobResult.h.

◆ WithSecondaryStatus() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithSecondaryStatus ( const SecondaryStatus value)
inline

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

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

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

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

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

Definition at line 482 of file DescribeTrainingJobResult.h.

◆ WithSecondaryStatus() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithSecondaryStatus ( SecondaryStatus &&  value)
inline

Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

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

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.

  • Interrupted - The job stopped because the managed spot training instances were interrupted.

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

  • MaxWaitTimeExceeded - The job stopped because it exceeded the maximum allowed wait time.

  • Stopped - The training job has stopped.

Stopping
  • Stopping - Stopping the training job.

Valid values for SecondaryStatus are subject to change.

We no longer support the following secondary statuses:

  • LaunchingMLInstances

  • PreparingTraining

  • DownloadingTrainingImage

Definition at line 514 of file DescribeTrainingJobResult.h.

◆ WithSecondaryStatusTransitions() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithSecondaryStatusTransitions ( Aws::Vector< SecondaryStatusTransition > &&  value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1067 of file DescribeTrainingJobResult.h.

◆ WithSecondaryStatusTransitions() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithSecondaryStatusTransitions ( const Aws::Vector< SecondaryStatusTransition > &  value)
inline

A history of all of the secondary statuses that the training job has transitioned through.

Definition at line 1061 of file DescribeTrainingJobResult.h.

◆ WithStoppingCondition() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithStoppingCondition ( const StoppingCondition value)
inline

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Definition at line 876 of file DescribeTrainingJobResult.h.

◆ WithStoppingCondition() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithStoppingCondition ( StoppingCondition &&  value)
inline

Specifies a limit to how long a model training job can run. It also specifies how long a managed Spot training job has to complete. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

Definition at line 887 of file DescribeTrainingJobResult.h.

◆ WithTensorBoardOutputConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTensorBoardOutputConfig ( const TensorBoardOutputConfig value)
inline

Definition at line 1367 of file DescribeTrainingJobResult.h.

◆ WithTensorBoardOutputConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTensorBoardOutputConfig ( TensorBoardOutputConfig &&  value)
inline

Definition at line 1370 of file DescribeTrainingJobResult.h.

◆ WithTrainingEndTime() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingEndTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

Definition at line 1005 of file DescribeTrainingJobResult.h.

◆ WithTrainingEndTime() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingEndTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

Definition at line 996 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobArn() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobArn ( Aws::String &&  value)
inline

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

Definition at line 124 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobArn() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobArn ( const Aws::String value)
inline

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

Definition at line 119 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobArn() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobArn ( const char *  value)
inline

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

Definition at line 129 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobName() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobName ( Aws::String &&  value)
inline

Name of the model training job.

Definition at line 88 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobName() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobName ( const Aws::String value)
inline

Name of the model training job.

Definition at line 83 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobName() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobName ( const char *  value)
inline

Name of the model training job.

Definition at line 93 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobStatus() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobStatus ( const TrainingJobStatus value)
inline

The status of the training job.

Amazon SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

Definition at line 339 of file DescribeTrainingJobResult.h.

◆ WithTrainingJobStatus() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingJobStatus ( TrainingJobStatus &&  value)
inline

The status of the training job.

Amazon SageMaker provides the following training job statuses:

  • InProgress - The training is in progress.

  • Completed - The training job has completed.

  • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

  • Stopping - The training job is stopping.

  • Stopped - The training job has stopped.

For more detailed information, see SecondaryStatus.

Definition at line 353 of file DescribeTrainingJobResult.h.

◆ WithTrainingStartTime() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingStartTime ( Aws::Utils::DateTime &&  value)
inline

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

Definition at line 959 of file DescribeTrainingJobResult.h.

◆ WithTrainingStartTime() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingStartTime ( const Aws::Utils::DateTime value)
inline

Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

Definition at line 950 of file DescribeTrainingJobResult.h.

◆ WithTrainingTimeInSeconds()

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTrainingTimeInSeconds ( int  value)
inline

The training time in seconds.

Definition at line 1239 of file DescribeTrainingJobResult.h.

◆ WithTuningJobArn() [1/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTuningJobArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 166 of file DescribeTrainingJobResult.h.

◆ WithTuningJobArn() [2/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTuningJobArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 160 of file DescribeTrainingJobResult.h.

◆ WithTuningJobArn() [3/3]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithTuningJobArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

Definition at line 172 of file DescribeTrainingJobResult.h.

◆ WithVpcConfig() [1/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithVpcConfig ( const VpcConfig value)
inline

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Definition at line 823 of file DescribeTrainingJobResult.h.

◆ WithVpcConfig() [2/2]

DescribeTrainingJobResult& Aws::SageMaker::Model::DescribeTrainingJobResult::WithVpcConfig ( VpcConfig &&  value)
inline

A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

Definition at line 831 of file DescribeTrainingJobResult.h.


The documentation for this class was generated from the following file: