Class: Aws::LexModelsV2::Types::FulfillmentUpdateResponseSpecification

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

{
  frequency_in_seconds: 1, # 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,
}

Provides settings for a message that is sent periodically to the user while a fulfillment Lambda function is running.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_interruptBoolean

Determines whether the user can interrupt an update message while it is playing.

Returns:

  • (Boolean)


5604
5605
5606
5607
5608
5609
5610
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5604

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

#frequency_in_secondsInteger

The frequency that a message is sent to the user. When the period ends, Amazon Lex chooses a message from the message groups and plays it to the user. If the fulfillment Lambda returns before the first period ends, an update message is not played to the user.

Returns:

  • (Integer)


5604
5605
5606
5607
5608
5609
5610
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5604

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

#message_groupsArray<Types::MessageGroup>

One to 5 message groups that contain update messages. Amazon Lex chooses one of the messages to play to the user.

Returns:



5604
5605
5606
5607
5608
5609
5610
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5604

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