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

Class: Aws::AppStream::Waiters::FleetStopped

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FleetStopped

Returns a new instance of FleetStopped

Parameters:

  • options (Hash)

Options Hash (options):

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


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/waiters.rb', line 71

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_fleets,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "pathAll",
          "argument" => "fleets[].state",
          "expected" => "INACTIVE"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "fleets[].state",
          "expected" => "PENDING_ACTIVATE"
        },
        {
          "state" => "failure",
          "matcher" => "pathAny",
          "argument" => "fleets[].state",
          "expected" => "ACTIVE"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :names (Array<String>)

    The fleet names to describe. Use null to describe all the fleets for the AWS account.

  • :next_token (String)

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

Returns:



104
105
106
# File 'gems/aws-sdk-appstream/lib/aws-sdk-appstream/waiters.rb', line 104

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