Class: Aws::Lambda::Waiters::FunctionActive

Inherits:

Object

Object
Aws::Lambda::Waiters::FunctionActive

show all

Defined in:: gems/aws-sdk-lambda/lib/aws-sdk-lambda/waiters.rb

Overview

Waits for the function's State to be Active. This waiter uses GetFunctionConfiguration API. This should be used after new function creation.

Instance Method Summary collapse

#initialize(options) ⇒ FunctionActive constructor
A new instance of FunctionActive.
#wait(params = {}) ⇒ Types::FunctionConfiguration
Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ `FunctionActive`

Returns a new instance of FunctionActive.

Parameters:

options (Hash)

Options Hash (options):

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

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

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" => "state",
          "expected" => "Active"
        },
        {
          "state" => "failure",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "Failed"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "Pending"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#function_name => String
#function_arn => String
#runtime => String
#role => String
#handler => String
#code_size => Integer
#description => String
#timeout => Integer
#memory_size => Integer
#last_modified => Time
#code_sha_256 => String
#version => String
#vpc_config => Types::VpcConfigResponse
#dead_letter_config => Types::DeadLetterConfig
#environment => Types::EnvironmentResponse
#kms_key_arn => String
#tracing_config => Types::TracingConfigResponse
#master_arn => String
#revision_id => String
#layers => Array<Types::Layer>
#state => String
#state_reason => String
#state_reason_code => String
#last_update_status => String
#last_update_status_reason => String
#last_update_status_reason_code => String
#file_system_configs => Array<Types::FileSystemConfig>
#package_type => String
#image_config_response => Types::ImageConfigResponse
#signing_profile_version_arn => String
#signing_job_arn => String
#architectures => Array<String>
#ephemeral_storage => Types::EphemeralStorage
#snap_start => Types::SnapStartResponse
#runtime_version_config => Types::RuntimeVersionConfig
#logging_config => Types::LoggingConfig

Parameters:

params (Hash) (defaults to: {}) —
a customizable set of options

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::FunctionConfiguration) —
Returns a response object which responds to the following methods:
- #function_name => String
- #function_arn => String
- #runtime => String
- #role => String
- #handler => String
- #code_size => Integer
- #description => String
- #timeout => Integer
- #memory_size => Integer
- #last_modified => Time
- #code_sha_256 => String
- #version => String
- #vpc_config => Types::VpcConfigResponse
- #dead_letter_config => Types::DeadLetterConfig
- #environment => Types::EnvironmentResponse
- #kms_key_arn => String
- #tracing_config => Types::TracingConfigResponse
- #master_arn => String
- #revision_id => String
- #layers => Array<Types::Layer>
- #state => String
- #state_reason => String
- #state_reason_code => String
- #last_update_status => String
- #last_update_status_reason => String
- #last_update_status_reason_code => String
- #file_system_configs => Array<Types::FileSystemConfig>
- #package_type => String
- #image_config_response => Types::ImageConfigResponse
- #signing_profile_version_arn => String
- #signing_job_arn => String
- #architectures => Array<String>
- #ephemeral_storage => Types::EphemeralStorage
- #snap_start => Types::SnapStartResponse
- #runtime_version_config => Types::RuntimeVersionConfig
- #logging_config => Types::LoggingConfig



123
124
125

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

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