class Aws::LexModelsV2::Types::CreateSlotRequest

@note When making an API call, you may pass CreateSlotRequest

data as a hash:

    {
      slot_name: "Name", # required
      description: "Description",
      slot_type_id: "BuiltInOrCustomSlotTypeId", # required
      value_elicitation_setting: { # required
        default_value_specification: {
          default_value_list: [ # required
            {
              default_value: "SlotDefaultValueString", # required
            },
          ],
        },
        slot_constraint: "Required", # required, accepts Required, Optional
        prompt_specification: {
          message_groups: [ # required
            {
              message: { # required
                plain_text_message: {
                  value: "PlainTextMessageValue", # required
                },
                custom_payload: {
                  value: "CustomPayloadValue", # required
                },
                ssml_message: {
                  value: "SSMLMessageValue", # required
                },
                image_response_card: {
                  title: "AttachmentTitle", # required
                  subtitle: "AttachmentTitle",
                  image_url: "AttachmentUrl",
                  buttons: [
                    {
                      text: "ButtonText", # required
                      value: "ButtonValue", # required
                    },
                  ],
                },
              },
              variations: [
                {
                  plain_text_message: {
                    value: "PlainTextMessageValue", # required
                  },
                  custom_payload: {
                    value: "CustomPayloadValue", # required
                  },
                  ssml_message: {
                    value: "SSMLMessageValue", # required
                  },
                  image_response_card: {
                    title: "AttachmentTitle", # required
                    subtitle: "AttachmentTitle",
                    image_url: "AttachmentUrl",
                    buttons: [
                      {
                        text: "ButtonText", # required
                        value: "ButtonValue", # required
                      },
                    ],
                  },
                },
              ],
            },
          ],
          max_retries: 1, # required
          allow_interrupt: false,
        },
        sample_utterances: [
          {
            utterance: "Utterance", # required
          },
        ],
        wait_and_continue_specification: {
          waiting_response: { # required
            message_groups: [ # required
              {
                message: { # required
                  plain_text_message: {
                    value: "PlainTextMessageValue", # required
                  },
                  custom_payload: {
                    value: "CustomPayloadValue", # required
                  },
                  ssml_message: {
                    value: "SSMLMessageValue", # required
                  },
                  image_response_card: {
                    title: "AttachmentTitle", # required
                    subtitle: "AttachmentTitle",
                    image_url: "AttachmentUrl",
                    buttons: [
                      {
                        text: "ButtonText", # required
                        value: "ButtonValue", # required
                      },
                    ],
                  },
                },
                variations: [
                  {
                    plain_text_message: {
                      value: "PlainTextMessageValue", # required
                    },
                    custom_payload: {
                      value: "CustomPayloadValue", # required
                    },
                    ssml_message: {
                      value: "SSMLMessageValue", # required
                    },
                    image_response_card: {
                      title: "AttachmentTitle", # required
                      subtitle: "AttachmentTitle",
                      image_url: "AttachmentUrl",
                      buttons: [
                        {
                          text: "ButtonText", # required
                          value: "ButtonValue", # required
                        },
                      ],
                    },
                  },
                ],
              },
            ],
            allow_interrupt: false,
          },
          continue_response: { # required
            message_groups: [ # required
              {
                message: { # required
                  plain_text_message: {
                    value: "PlainTextMessageValue", # required
                  },
                  custom_payload: {
                    value: "CustomPayloadValue", # required
                  },
                  ssml_message: {
                    value: "SSMLMessageValue", # required
                  },
                  image_response_card: {
                    title: "AttachmentTitle", # required
                    subtitle: "AttachmentTitle",
                    image_url: "AttachmentUrl",
                    buttons: [
                      {
                        text: "ButtonText", # required
                        value: "ButtonValue", # required
                      },
                    ],
                  },
                },
                variations: [
                  {
                    plain_text_message: {
                      value: "PlainTextMessageValue", # required
                    },
                    custom_payload: {
                      value: "CustomPayloadValue", # required
                    },
                    ssml_message: {
                      value: "SSMLMessageValue", # required
                    },
                    image_response_card: {
                      title: "AttachmentTitle", # required
                      subtitle: "AttachmentTitle",
                      image_url: "AttachmentUrl",
                      buttons: [
                        {
                          text: "ButtonText", # required
                          value: "ButtonValue", # required
                        },
                      ],
                    },
                  },
                ],
              },
            ],
            allow_interrupt: false,
          },
          still_waiting_response: {
            message_groups: [ # required
              {
                message: { # required
                  plain_text_message: {
                    value: "PlainTextMessageValue", # required
                  },
                  custom_payload: {
                    value: "CustomPayloadValue", # required
                  },
                  ssml_message: {
                    value: "SSMLMessageValue", # required
                  },
                  image_response_card: {
                    title: "AttachmentTitle", # required
                    subtitle: "AttachmentTitle",
                    image_url: "AttachmentUrl",
                    buttons: [
                      {
                        text: "ButtonText", # required
                        value: "ButtonValue", # required
                      },
                    ],
                  },
                },
                variations: [
                  {
                    plain_text_message: {
                      value: "PlainTextMessageValue", # required
                    },
                    custom_payload: {
                      value: "CustomPayloadValue", # required
                    },
                    ssml_message: {
                      value: "SSMLMessageValue", # required
                    },
                    image_response_card: {
                      title: "AttachmentTitle", # required
                      subtitle: "AttachmentTitle",
                      image_url: "AttachmentUrl",
                      buttons: [
                        {
                          text: "ButtonText", # required
                          value: "ButtonValue", # required
                        },
                      ],
                    },
                  },
                ],
              },
            ],
            frequency_in_seconds: 1, # required
            timeout_in_seconds: 1, # required
            allow_interrupt: false,
          },
          active: false,
        },
      },
      obfuscation_setting: {
        obfuscation_setting_type: "None", # required, accepts None, DefaultObfuscation
      },
      bot_id: "Id", # required
      bot_version: "DraftBotVersion", # required
      locale_id: "LocaleId", # required
      intent_id: "Id", # required
      multiple_values_setting: {
        allow_multiple_values: false,
      },
    }

@!attribute [rw] slot_name

The name of the slot. Slot names must be unique within the bot that
contains the slot.
@return [String]

@!attribute [rw] description

A description of the slot. Use this to help identify the slot in
lists.
@return [String]

@!attribute [rw] slot_type_id

The unique identifier for the slot type associated with this slot.
The slot type determines the values that can be entered into the
slot.
@return [String]

@!attribute [rw] value_elicitation_setting

Specifies prompts that Amazon Lex sends to the user to elicit a
response that provides the value for the slot.
@return [Types::SlotValueElicitationSetting]

@!attribute [rw] obfuscation_setting

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.
@return [Types::ObfuscationSetting]

@!attribute [rw] bot_id

The identifier of the bot associated with the slot.
@return [String]

@!attribute [rw] bot_version

The version of the bot associated with the slot.
@return [String]

@!attribute [rw] locale_id

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].

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

@!attribute [rw] intent_id

The identifier of the intent that contains the slot.
@return [String]

@!attribute [rw] multiple_values_setting

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`.
@return [Types::MultipleValuesSetting]

@see docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/CreateSlotRequest AWS API Documentation

Constants

SENSITIVE