Class: Aws::Lambda::Waiters::FunctionExists

Inherits:

Object

• Object
• Aws::Lambda::Waiters::FunctionExists

Defined in:

lib/aws-sdk-lambda/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ FunctionExists constructor

  A new instance of FunctionExists.

• #wait(params = {}) ⇒ Types::GetFunctionResponse

  Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ FunctionExists

Returns a new instance of FunctionExists.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-lambda/waiters.rb', line 191

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_function,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "status",
          "expected" => 200
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "ResourceNotFoundException"
        }
      ]
    )
  }.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.

# File 'lib/aws-sdk-lambda/waiters.rb', line 221

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #configuration => Types::FunctionConfiguration

• #code => Types::FunctionCodeLocation

• #tags => Hash<String,String>

• #concurrency => Types::Concurrency

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:

• (Types::GetFunctionResponse) —

  Returns a response object which responds to the following methods:

  • #configuration => Types::FunctionConfiguration

  • #code => Types::FunctionCodeLocation

  • #tags => Hash<String,String>

  • #concurrency => Types::Concurrency

# File 'lib/aws-sdk-lambda/waiters.rb', line 216

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