Class: Aws::Lambda::Waiters::FunctionUpdated

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

Overview

Waits for the function's LastUpdateStatus to be Successful.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FunctionUpdated

Returns a new instance of FunctionUpdated.

Parameters:

  • options (Hash)

Options Hash (options):

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


180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/waiters.rb', line 180

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

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :function_name (required, String)

    The name of the Lambda function, version, or alias.

    Name formats

    • Function name - my-function (name-only), my-function:v1 (with alias).

    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

    • Partial ARN - 123456789012:function:my-function.

    You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • :qualifier (String)

    Specify a version or alias to get details about a published version of the function.

Returns:



213
214
215
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/waiters.rb', line 213

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