Class: Aws::LexModelsV2::Types::CreateSlotRequest

Inherits:

Struct

• Object
• Struct
• Aws::LexModelsV2::Types::CreateSlotRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lexmodelsv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bot_id ⇒ String

  The identifier of the bot associated with the slot.

• #bot_version ⇒ String

  The version of the bot associated with the slot.

• #description ⇒ String

  A description of the slot.

• #intent_id ⇒ String

  The identifier of the intent that contains the slot.

• #locale_id ⇒ String

  The identifier of the language and locale that the slot will be used in.

• #multiple_values_setting ⇒ Types::MultipleValuesSetting

  Indicates whether the slot returns multiple values in one response.

• #obfuscation_setting ⇒ Types::ObfuscationSetting

  Determines how slot values are used in Amazon CloudWatch logs.

• #slot_name ⇒ String

  The name of the slot.

• #slot_type_id ⇒ String

  The unique identifier for the slot type associated with this slot.

• #sub_slot_setting ⇒ Types::SubSlotSetting

  Specifications for the constituent sub slots and the expression for the composite slot.

• #value_elicitation_setting ⇒ Types::SlotValueElicitationSetting

  Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

Instance Attribute Details

#bot_id ⇒ String

The identifier of the bot associated with the slot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#bot_version ⇒ String

The version of the bot associated with the slot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the slot. Use this to help identify the slot in lists.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#intent_id ⇒ String

The identifier of the intent that contains the slot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#locale_id ⇒ String

The identifier of the language and locale that the slot will be used in. The string must match one of the supported locales. All of the bots, intents, slot types used by the slot must have the same locale. For more information, see [Supported languages].

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

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#multiple_values_setting ⇒ Types::MultipleValuesSetting

Indicates whether the slot returns multiple values in one response. Multi-value slots are only available in the ‘en-US` locale. If you set this value to `true` in any other locale, Amazon Lex throws a `ValidationException`.

If the ‘multipleValuesSetting` is not set, the default value is `false`.

Returns:

• (Types::MultipleValuesSetting)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#obfuscation_setting ⇒ Types::ObfuscationSetting

Determines how slot values are used in Amazon CloudWatch logs. If the value of the ‘obfuscationSetting` parameter is `DefaultObfuscation`, slot values are obfuscated in the log output. If the value is `None`, the actual value is present in the log output.

The default is to obfuscate values in the CloudWatch logs.

Returns:

• (Types::ObfuscationSetting)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_name ⇒ String

The name of the slot. Slot names must be unique within the bot that contains the slot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#slot_type_id ⇒ String

The unique identifier for the slot type associated with this slot. The slot type determines the values that can be entered into the slot.

Returns:

• (String)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#sub_slot_setting ⇒ Types::SubSlotSetting

Specifications for the constituent sub slots and the expression for the composite slot.

Returns:

• (Types::SubSlotSetting)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end

#value_elicitation_setting ⇒ Types::SlotValueElicitationSetting

Specifies prompts that Amazon Lex sends to the user to elicit a response that provides the value for the slot.

Returns:

• (Types::SlotValueElicitationSetting)

# File 'lib/aws-sdk-lexmodelsv2/types.rb', line 4314

class CreateSlotRequest < Struct.new(
  :slot_name,
  :description,
  :slot_type_id,
  :value_elicitation_setting,
  :obfuscation_setting,
  :bot_id,
  :bot_version,
  :locale_id,
  :intent_id,
  :multiple_values_setting,
  :sub_slot_setting)
  SENSITIVE = []
  include Aws::Structure
end