Class: Aws::LexModelsV2::Waiters::BotLocaleBuilt

Inherits:

Object

Object
Aws::LexModelsV2::Waiters::BotLocaleBuilt

show all

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

Overview

Wait until a bot locale is built

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ BotLocaleBuilt constructor

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

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

Constructor Details

#initialize(options) ⇒ `BotLocaleBuilt`

Returns a new instance of BotLocaleBuilt.

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 302

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_locale,
      acceptors: [
        {
          "expected" => "Built",
          "matcher" => "path",
          "state" => "success",
          "argument" => "bot_locale_status"
        },
        {
          "expected" => "Deleting",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_locale_status"
        },
        {
          "expected" => "Failed",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_locale_status"
        },
        {
          "expected" => "NotBuilt",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bot_locale_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.



346
347
348

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#bot_id => String
#bot_version => String
#locale_id => String
#locale_name => String
#description => String
#nlu_intent_confidence_threshold => Float
#voice_settings => Types::VoiceSettings
#intents_count => Integer
#slot_types_count => Integer
#bot_locale_status => String
#failure_reasons => Array<String>
#creation_date_time => Time
#last_updated_date_time => Time
#last_build_submitted_date_time => Time
#bot_locale_history_events => Array<Types::BotLocaleHistoryEvent>
#recommended_actions => Array<String>
#generative_ai_settings => Types::GenerativeAISettings

Options Hash (params):

:bot_id (required, String) —

The identifier of the bot associated with the locale.
:bot_version (required, String) —

The version of the bot associated with the locale.
:locale_id (required, String) —

The unique identifier of the locale to describe. The string must match one of the supported locales. For more information, see [Supported languages].

[1]: docs.aws.amazon.com/lexv2/latest/dg/how-languages.html

Returns:

(Types::DescribeBotLocaleResponse) —
Returns a response object which responds to the following methods:
- #bot_id => String
- #bot_version => String
- #locale_id => String
- #locale_name => String
- #description => String
- #nlu_intent_confidence_threshold => Float
- #voice_settings => Types::VoiceSettings
- #intents_count => Integer
- #slot_types_count => Integer
- #bot_locale_status => String
- #failure_reasons => Array<String>
- #creation_date_time => Time
- #last_updated_date_time => Time
- #last_build_submitted_date_time => Time
- #bot_locale_history_events => Array<Types::BotLocaleHistoryEvent>
- #recommended_actions => Array<String>
- #generative_ai_settings => Types::GenerativeAISettings



341
342
343

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

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