Class: Aws::LexModelsV2::Types::StillWaitingResponseSpecification

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb

Overview

Note:

When making an API call, you may pass StillWaitingResponseSpecification data as a hash:

{
  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,
}

Defines the messages that Amazon Lex sends to a user to remind them that the bot is waiting for a response.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_interrupt ⇒ Boolean

Indicates that the user can interrupt the response by speaking while the message is being played.

Returns:

  • (Boolean) 


9342
9343
9344
9345
9346
9347
9348
9349
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9342

class StillWaitingResponseSpecification < Struct.new(
  :message_groups,
  :frequency_in_seconds,
  :timeout_in_seconds,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end

#frequency_in_seconds ⇒ Integer

How often a message should be sent to the user. Minimum of 1 second, maximum of 5 minutes.

Returns:

  • (Integer) 


9342
9343
9344
9345
9346
9347
9348
9349
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9342

class StillWaitingResponseSpecification < Struct.new(
  :message_groups,
  :frequency_in_seconds,
  :timeout_in_seconds,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end

#message_groups ⇒ Array<Types::MessageGroup>

One or more message groups, each containing one or more messages, that define the prompts that Amazon Lex sends to the user.

Returns:



9342
9343
9344
9345
9346
9347
9348
9349
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9342

class StillWaitingResponseSpecification < Struct.new(
  :message_groups,
  :frequency_in_seconds,
  :timeout_in_seconds,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_seconds ⇒ Integer

If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

Returns:

  • (Integer) 


9342
9343
9344
9345
9346
9347
9348
9349
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9342

class StillWaitingResponseSpecification < Struct.new(
  :message_groups,
  :frequency_in_seconds,
  :timeout_in_seconds,
  :allow_interrupt)
  SENSITIVE = []
  include Aws::Structure
end