Class: Aws::OpsWorks::Waiters::AppExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AppExists

Returns a new instance of AppExists.

Parameters:

  • options (Hash)

Options Hash (options):

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


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 87

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_apps,
      acceptors: [
        {
          "expected" => 200,
          "matcher" => "status",
          "state" => "success"
        },
        {
          "matcher" => "status",
          "expected" => 400,
          "state" => "failure"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

  • #apps => Array<Types::App>

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :stack_id (String)

    The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

  • :app_ids (Array<String>)

    An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

Returns:



112
113
114
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/waiters.rb', line 112

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