Class: Aws::LexModelsV2::Types::FulfillmentStartResponseSpecification

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

{
  delay_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 to the user when a fulfillment Lambda function starts running.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_interruptBoolean

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

Returns:

  • (Boolean)


5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5824

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

#delay_in_secondsInteger

The delay between when the Lambda fulfillment function starts running and the start message is played. If the Lambda function returns before the delay is over, the start message isn't played.

Returns:

  • (Integer)


5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5824

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

#message_groupsArray<Types::MessageGroup>

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

Returns:



5824
5825
5826
5827
5828
5829
5830
# File 'gems/aws-sdk-lexmodelsv2/lib/aws-sdk-lexmodelsv2/types.rb', line 5824

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