You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Object
  • Object
show all
Defined in:
gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/waiters.rb

Instance Method Summary collapse

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)


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/waiters.rb', line 244

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 Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :training_job_name (required, String)

    The name of the training job.

Returns:



282
283
284
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/waiters.rb', line 282

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