Skip to content

UpdateSlotRequest

Source code in docs_src/capo_lex_models_v2/types/update_slot_request.py
class UpdateSlotRequest(TypedDict, closed=True):
    slot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier for the slot to update.</p>"""
    slot_name: "capo_lex_models_v2.types.name.Name"
    """<p>The new name for the slot.</p>"""
    description: NotRequired["capo_lex_models_v2.types.description.Description"]
    """<p>The new description for the slot.</p>"""
    slot_type_id: NotRequired[
        "capo_lex_models_v2.types.built_in_or_custom_slot_type_id.BuiltInOrCustomSlotTypeId"
    ]
    """<p>The unique identifier of the new slot type to associate with this slot. </p>"""
    value_elicitation_setting: "capo_lex_models_v2.types.slot_value_elicitation_setting.SlotValueElicitationSetting"
    """<p>A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.</p>"""
    obfuscation_setting: NotRequired[
        "capo_lex_models_v2.types.obfuscation_setting.ObfuscationSetting"
    ]
    """<p>New settings that determine how slot values are formatted in Amazon CloudWatch logs. </p>"""
    bot_id: "capo_lex_models_v2.types.id.Id"
    """<p>The unique identifier of the bot that contains the slot.</p>"""
    bot_version: "capo_lex_models_v2.types.draft_bot_version.DraftBotVersion"
    """<p>The version of the bot that contains the slot. Must always be <code>DRAFT</code>.</p>"""
    locale_id: "capo_lex_models_v2.types.locale_id.LocaleId"
    """<p>The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see <a href="https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html">Supported languages</a>.</p>"""
    intent_id: "capo_lex_models_v2.types.id.Id"
    """<p>The identifier of the intent that contains the slot.</p>"""
    multiple_values_setting: NotRequired[
        "capo_lex_models_v2.types.multiple_values_setting.MultipleValuesSetting"
    ]
    """<p>Determines whether the slot accepts multiple values in one response. Multiple value slots are only available in the en-US locale. If you set this value to <code>true</code> in any other locale, Amazon Lex throws a <code>ValidationException</code>.</p> <p>If the <code>multipleValuesSetting</code> is not set, the default value is <code>false</code>.</p>"""
    sub_slot_setting: NotRequired[
        "capo_lex_models_v2.types.sub_slot_setting.SubSlotSetting"
    ]
    """<p>Specifications for the constituent sub slots and the expression for the composite slot.</p>"""

bot_id instance-attribute

bot_id: Id

The unique identifier of the bot that contains the slot.

bot_version instance-attribute

bot_version: DraftBotVersion

The version of the bot that contains the slot. Must always be DRAFT.

description instance-attribute

description: NotRequired[Description]

The new description for the slot.

intent_id instance-attribute

intent_id: Id

The identifier of the intent that contains the slot.

locale_id instance-attribute

locale_id: LocaleId

The identifier of the language and locale that contains the slot. The string must match one of the supported locales. For more information, see Supported languages.

multiple_values_setting instance-attribute

multiple_values_setting: NotRequired[MultipleValuesSetting]

Determines whether the slot accepts multiple values in one response. Multiple 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.

obfuscation_setting instance-attribute

obfuscation_setting: NotRequired[ObfuscationSetting]

New settings that determine how slot values are formatted in Amazon CloudWatch logs.

slot_id instance-attribute

slot_id: Id

The unique identifier for the slot to update.

slot_name instance-attribute

slot_name: Name

The new name for the slot.

slot_type_id instance-attribute

slot_type_id: NotRequired[BuiltInOrCustomSlotTypeId]

The unique identifier of the new slot type to associate with this slot.

sub_slot_setting instance-attribute

sub_slot_setting: NotRequired[SubSlotSetting]

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

value_elicitation_setting instance-attribute

value_elicitation_setting: SlotValueElicitationSetting

A new set of prompts that Amazon Lex sends to the user to elicit a response the provides a value for the slot.