class Aws::LexModelsV2::Types::IntentConfirmationSetting

Provides a prompt for making sure that the user is ready for the intent to be fulfilled.

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

data as a hash:

    {
      prompt_specification: { # 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
                    },
                  ],
                },
              },
            ],
          },
        ],
        max_retries: 1, # required
        allow_interrupt: false,
      },
      declination_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,
      },
      active: false,
    }

@!attribute [rw] prompt_specification

Prompts the user to confirm the intent. This question should have a
yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges
that the intent is ready for fulfillment. For example, with the
`OrderPizza` intent, you might want to confirm that the order is
correct before placing it. For other intents, such as intents that
simply respond to user questions, you might not need to ask the user
for confirmation before providing the information.
@return [Types::PromptSpecification]

@!attribute [rw] declination_response

When the user answers "no" to the question defined in
`promptSpecification`, Amazon Lex responds with this response to
acknowledge that the intent was canceled.
@return [Types::ResponseSpecification]

@!attribute [rw] active

Specifies whether the intent's confirmation is sent to the user.
When this field is false, confirmation and declination responses
aren't sent and processing continues as if the responses aren't
present. If the `active` field isn't specified, the default is
true.
@return [Boolean]

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

Constants

SENSITIVE