Class: Aws::LexModelsV2::Waiters::BotAvailable

Inherits:

Object

• Object
• Aws::LexModelsV2::Waiters::BotAvailable

Defined in:

lib/aws-sdk-lexmodelsv2/waiters.rb

Overview

Wait until a bot is available

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ BotAvailable constructor

  A new instance of BotAvailable.

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

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

Constructor Details

#initialize(options) ⇒ BotAvailable

Returns a new instance of BotAvailable.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-lexmodelsv2/waiters.rb', line 143

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 35,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_bot,
      acceptors: [
        {
          "expected" => "Available",
          "matcher" => "path",
          "state" => "success",
          "argument" => "bot_status"
        },
        {
          "expected" => "Deleting",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_status"
        },
        {
          "expected" => "Inactive",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_status"
        }
      ]
    )
  }.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-lexmodelsv2/waiters.rb', line 187

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #bot_id => String

• #bot_name => String

• #description => String

• #role_arn => String

• #data_privacy => Types::DataPrivacy

• #idle_session_ttl_in_seconds => Integer

• #bot_status => String

• #creation_date_time => Time

• #last_updated_date_time => Time

• #bot_type => String

• #bot_members => Array<Types::BotMember>

• #failure_reasons => Array<String>

Options Hash (params):

• :bot_id (required, String) —

  The unique identifier of the bot to describe.

Returns:

• (Types::DescribeBotResponse) —

  Returns a response object which responds to the following methods:

  • #bot_id => String

  • #bot_name => String

  • #description => String

  • #role_arn => String

  • #data_privacy => Types::DataPrivacy

  • #idle_session_ttl_in_seconds => Integer

  • #bot_status => String

  • #creation_date_time => Time

  • #last_updated_date_time => Time

  • #bot_type => String

  • #bot_members => Array<Types::BotMember>

  • #failure_reasons => Array<String>

# File 'lib/aws-sdk-lexmodelsv2/waiters.rb', line 182

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