Class: Aws::SageMaker::Waiters::TrainingJobCompletedOrStopped

Inherits:

Object

Object
Aws::SageMaker::Waiters::TrainingJobCompletedOrStopped

show all

Defined in:: lib/aws-sdk-sagemaker/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ TrainingJobCompletedOrStopped constructor

A new instance of TrainingJobCompletedOrStopped.
#wait(params = {}) ⇒ Types::DescribeTrainingJobResponse

Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ `TrainingJobCompletedOrStopped`

Returns a new instance of TrainingJobCompletedOrStopped.

Parameters:

options (Hash)

Options Hash (options):

:client (required, Client)
:max_attempts (Integer) — default: 180
:delay (Integer) — default: 120
:before_attempt (Proc)
:before_wait (Proc)

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 299

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 120,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_training_job,
      acceptors: [
        {
          "expected" => "Completed",
          "matcher" => "path",
          "state" => "success",
          "argument" => "training_job_status"
        },
        {
          "expected" => "Stopped",
          "matcher" => "path",
          "state" => "success",
          "argument" => "training_job_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "training_job_status"
        },
        {
          "expected" => "ValidationException",
          "matcher" => "error",
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ `Object` (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



342
343
344

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 342

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::DescribeTrainingJobResponse`

Returns a response object which responds to the following methods:

#training_job_name => String
#training_job_arn => String
#tuning_job_arn => String
#labeling_job_arn => String
#auto_ml_job_arn => String
#model_artifacts => Types::ModelArtifacts
#training_job_status => String
#secondary_status => String
#failure_reason => String
#hyper_parameters => Hash<String,String>
#algorithm_specification => Types::AlgorithmSpecification
#role_arn => String
#input_data_config => Array<Types::Channel>
#output_data_config => Types::OutputDataConfig
#resource_config => Types::ResourceConfig
#vpc_config => Types::VpcConfig
#stopping_condition => Types::StoppingCondition
#creation_time => Time
#training_start_time => Time
#training_end_time => Time
#last_modified_time => Time
#secondary_status_transitions => Array<Types::SecondaryStatusTransition>
#final_metric_data_list => Array<Types::MetricData>
#enable_network_isolation => Boolean
#enable_inter_container_traffic_encryption => Boolean
#enable_managed_spot_training => Boolean
#checkpoint_config => Types::CheckpointConfig
#training_time_in_seconds => Integer
#billable_time_in_seconds => Integer
#debug_hook_config => Types::DebugHookConfig
#experiment_config => Types::ExperimentConfig
#debug_rule_configurations => Array<Types::DebugRuleConfiguration>
#tensor_board_output_config => Types::TensorBoardOutputConfig
#debug_rule_evaluation_statuses => Array<Types::DebugRuleEvaluationStatus>

Options Hash (params):

:training_job_name (required, String) —

The name of the training job.

Returns:

(Types::DescribeTrainingJobResponse) —
Returns a response object which responds to the following methods:
- #training_job_name => String
- #training_job_arn => String
- #tuning_job_arn => String
- #labeling_job_arn => String
- #auto_ml_job_arn => String
- #model_artifacts => Types::ModelArtifacts
- #training_job_status => String
- #secondary_status => String
- #failure_reason => String
- #hyper_parameters => Hash<String,String>
- #algorithm_specification => Types::AlgorithmSpecification
- #role_arn => String
- #input_data_config => Array<Types::Channel>
- #output_data_config => Types::OutputDataConfig
- #resource_config => Types::ResourceConfig
- #vpc_config => Types::VpcConfig
- #stopping_condition => Types::StoppingCondition
- #creation_time => Time
- #training_start_time => Time
- #training_end_time => Time
- #last_modified_time => Time
- #secondary_status_transitions => Array<Types::SecondaryStatusTransition>
- #final_metric_data_list => Array<Types::MetricData>
- #enable_network_isolation => Boolean
- #enable_inter_container_traffic_encryption => Boolean
- #enable_managed_spot_training => Boolean
- #checkpoint_config => Types::CheckpointConfig
- #training_time_in_seconds => Integer
- #billable_time_in_seconds => Integer
- #debug_hook_config => Types::DebugHookConfig
- #experiment_config => Types::ExperimentConfig
- #debug_rule_configurations => Array<Types::DebugRuleConfiguration>
- #tensor_board_output_config => Types::TensorBoardOutputConfig
- #debug_rule_evaluation_statuses => Array<Types::DebugRuleEvaluationStatus>



337
338
339

# File 'lib/aws-sdk-sagemaker/waiters.rb', line 337

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end