Class: Aws::LexModelsV2::Waiters::BotAliasAvailable

Inherits:

Object

Object
Aws::LexModelsV2::Waiters::BotAliasAvailable

show all

Defined in:: lib/aws-sdk-lexmodelsv2/waiters.rb

Overview

Wait until a bot alias is available

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ BotAliasAvailable constructor

A new instance of BotAliasAvailable.
#wait(params = {}) ⇒ Types::DescribeBotAliasResponse

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

Constructor Details

#initialize(options) ⇒ `BotAliasAvailable`

Returns a new instance of BotAliasAvailable.

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 92

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_alias,
      acceptors: [
        {
          "expected" => "Available",
          "matcher" => "path",
          "state" => "success",
          "argument" => "bot_alias_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_alias_status"
        },
        {
          "expected" => "Deleting",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_alias_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.



130
131
132

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#bot_alias_id => String
#bot_alias_name => String
#description => String
#bot_version => String
#bot_alias_locale_settings => Hash<String,Types::BotAliasLocaleSettings>
#conversation_log_settings => Types::ConversationLogSettings
#sentiment_analysis_settings => Types::SentimentAnalysisSettings
#bot_alias_history_events => Array<Types::BotAliasHistoryEvent>
#bot_alias_status => String
#bot_id => String
#creation_date_time => Time
#last_updated_date_time => Time
#parent_bot_networks => Array<Types::ParentBotNetwork>

Options Hash (params):

:bot_alias_id (required, String) —

The identifier of the bot alias to describe.
:bot_id (required, String) —

The identifier of the bot associated with the bot alias to describe.

Returns:

(Types::DescribeBotAliasResponse) —
Returns a response object which responds to the following methods:
- #bot_alias_id => String
- #bot_alias_name => String
- #description => String
- #bot_version => String
- #bot_alias_locale_settings => Hash<String,Types::BotAliasLocaleSettings>
- #conversation_log_settings => Types::ConversationLogSettings
- #sentiment_analysis_settings => Types::SentimentAnalysisSettings
- #bot_alias_history_events => Array<Types::BotAliasHistoryEvent>
- #bot_alias_status => String
- #bot_id => String
- #creation_date_time => Time
- #last_updated_date_time => Time
- #parent_bot_networks => Array<Types::ParentBotNetwork>



125
126
127

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

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