Class: Aws::SageMaker::Waiters::NotebookInstanceInService

Inherits:

Object

Object
Aws::SageMaker::Waiters::NotebookInstanceInService

show all

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

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ NotebookInstanceInService constructor

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

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

Constructor Details

#initialize(options) ⇒ `NotebookInstanceInService`

Returns a new instance of NotebookInstanceInService.

Parameters:

options (Hash)

Options Hash (options):

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

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

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" => "InService",
          "matcher" => "path",
          "state" => "success",
          "argument" => "notebook_instance_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "notebook_instance_status"
        }
      ]
    )
  }.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.



506
507
508

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#notebook_instance_arn => String
#notebook_instance_name => String
#notebook_instance_status => String
#failure_reason => String
#url => String
#instance_type => String
#subnet_id => String
#security_groups => Array<String>
#role_arn => String
#kms_key_id => String
#network_interface_id => String
#last_modified_time => Time
#creation_time => Time
#notebook_instance_lifecycle_config_name => String
#direct_internet_access => String
#volume_size_in_gb => Integer
#accelerator_types => Array<String>
#default_code_repository => String
#additional_code_repositories => Array<String>
#root_access => String
#platform_identifier => String
#instance_metadata_service_configuration => Types::InstanceMetadataServiceConfiguration

Options Hash (params):

:notebook_instance_name (required, String) —

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

Returns:

(Types::DescribeNotebookInstanceOutput) —
Returns a response object which responds to the following methods:
- #notebook_instance_arn => String
- #notebook_instance_name => String
- #notebook_instance_status => String
- #failure_reason => String
- #url => String
- #instance_type => String
- #subnet_id => String
- #security_groups => Array<String>
- #role_arn => String
- #kms_key_id => String
- #network_interface_id => String
- #last_modified_time => Time
- #creation_time => Time
- #notebook_instance_lifecycle_config_name => String
- #direct_internet_access => String
- #volume_size_in_gb => Integer
- #accelerator_types => Array<String>
- #default_code_repository => String
- #additional_code_repositories => Array<String>
- #root_access => String
- #platform_identifier => String
- #instance_metadata_service_configuration => Types::InstanceMetadataServiceConfiguration



501
502
503

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

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