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

Class: Aws::SageMaker::Waiters::NotebookInstanceStopped

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) ⇒ NotebookInstanceStopped

Returns a new instance of NotebookInstanceStopped

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 60
  • :delay (Integer) — default: 30
  • :before_attempt (Proc)
  • :before_wait (Proc)


200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/waiters.rb', line 200

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_notebook_instance,
      acceptors: [
        {
          "expected" => "Stopped",
          "matcher" => "path",
          "state" => "success",
          "argument" => "notebook_instance_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "notebook_instance_status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :notebook_instance_name (required, String)

    The name of the notebook instance that you want information about.

Returns:



227
228
229
# File 'gems/aws-sdk-sagemaker/lib/aws-sdk-sagemaker/waiters.rb', line 227

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