Class: Aws::NimbleStudio::Waiters::StudioReady

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

Overview

Wait until a Studio is Ready. Use this after invoking CreateStudio, UpdateStudio, or StartStudioSSOConfigurationRepair

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StudioReady

Returns a new instance of StudioReady.

Parameters:

  • options (Hash)

Options Hash (options):

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


615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 615

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_studio,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "studio.state",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "studio.state",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "studio.state",
          "state" => "failure",
          "expected" => "UPDATE_FAILED"
        }
      ]
    )
  }.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. 



653
654
655
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 653

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :studio_id (required, String) —

    The studio ID.

Returns:



648
649
650
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 648

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