Class: Aws::LexModelsV2::Types::WaitAndContinueSpecification

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 WaitAndContinueSpecification data as a hash:

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

Specifies the prompts that Amazon Lex uses while a bot is waiting for customer input.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#active ⇒ Boolean

Specifies whether the bot will wait for a user to respond. When this field is false, wait and continue responses for a slot aren't used and the bot expects an appropriate response within the configured timeout. If the active field isn't specified, the default is true.

Returns:

  • (Boolean) 


9757
9758
9759
9760
9761
9762
9763
9764
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9757

class WaitAndContinueSpecification < Struct.new(
  :waiting_response,
  :continue_response,
  :still_waiting_response,
  :active)
  SENSITIVE = []
  include Aws::Structure
end

#continue_response ⇒ Types::ResponseSpecification

The response that Amazon Lex sends to indicate that the bot is ready to continue the conversation.

Returns:



9757
9758
9759
9760
9761
9762
9763
9764
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9757

class WaitAndContinueSpecification < Struct.new(
  :waiting_response,
  :continue_response,
  :still_waiting_response,
  :active)
  SENSITIVE = []
  include Aws::Structure
end

#still_waiting_response ⇒ Types::StillWaitingResponseSpecification

A response that Amazon Lex sends periodically to the user to indicate that the bot is still waiting for input from the user.

Returns:



9757
9758
9759
9760
9761
9762
9763
9764
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9757

class WaitAndContinueSpecification < Struct.new(
  :waiting_response,
  :continue_response,
  :still_waiting_response,
  :active)
  SENSITIVE = []
  include Aws::Structure
end

#waiting_response ⇒ Types::ResponseSpecification

The response that Amazon Lex sends to indicate that the bot is waiting for the conversation to continue.

Returns:



9757
9758
9759
9760
9761
9762
9763
9764
 
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 9757

class WaitAndContinueSpecification < Struct.new(
  :waiting_response,
  :continue_response,
  :still_waiting_response,
  :active)
  SENSITIVE = []
  include Aws::Structure
end