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

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

Overview

Waits for the function’s LastUpdateStatus to be Successful. This waiter uses GetFunctionConfiguration API. This should be used after function updates.

Instance Attribute Summary collapse

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)


234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/aws-sdk-lambda/waiters.rb', line 234

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 Attribute Details

#waiterObject (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.



272
273
274
# File 'lib/aws-sdk-lambda/waiters.rb', line 272

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :function_name (required, String)

    The name or ARN 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:



267
268
269
# File 'lib/aws-sdk-lambda/waiters.rb', line 267

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