intents

Creates, updates, deletes, gets or lists an intents resource.

Overview

Name	intents
Type	Resource
Id	aws.lexv2_models.intents

Fields

The following fields are returned by SELECT queries:

describe_intent

Name	Datatype	Description
bot_id	string	The identifier of the bot associated with the intent. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_version	string	The version of the bot associated with the intent. (pattern: <code>^DRAFT$</code>)
creation_date_time	string (date-time)	A timestamp of the date and time that the intent was created.
description	string	The description of the intent.
dialog_code_hook	object	Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
fulfillment_code_hook	object	Determines if a Lambda function should be invoked for a specific intent.
initial_response_setting	object	Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
input_contexts	array	A list of contexts that must be active for the intent to be considered for sending to the user.
intent_closing_setting	object	Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
intent_confirmation_setting	object	Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
intent_display_name	string	The display name specified for the intent.
intent_id	string	The unique identifier assigned to the intent when it was created. (pattern: <code>^[0-9a-zA-Z]+$</code>)
intent_name	string	The name specified for the intent. (pattern: <code>^([0-9a-zA-Z][_-]?){1,100}$</code>)
kendra_configuration	object	Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
last_updated_date_time	string (date-time)	A timestamp of the date and time that the intent was last updated.
locale_id	string	The language and locale specified for the intent.
output_contexts	array	A list of contexts that are activated when the intent is fulfilled.
parent_intent_signature	string	The identifier of the built-in intent that this intent is derived from, if any.
q_in_connect_intent_configuration	object	The configuration details of the Qinconnect intent.
qn_a_intent_configuration	object	Details about the the configuration of the built-in Amazon.QnAIntent.
sample_utterances	array	User utterances that trigger this intent.
slot_priorities	array	The list that determines the priority that slots should be elicited from the user.

list_intents

Name	Datatype	Description
bot_id	string	The identifier of the bot that contains the intent. (pattern: <code>^[0-9a-zA-Z]+$</code>)
bot_version	string	The version of the bot that contains the intent. (pattern: <code>^(DRAFT|[0-9]+)$</code>)
intent_summaries	array	Summary information for the intents that meet the filter criteria specified in the request. The length of the list is specified in the maxResults parameter of the request. If there are more intents available, the nextToken field contains a token to get the next page of results.
locale_id	string	The language and locale of the intents in the list.
next_token	string	A token that indicates whether there are more results to return in a response to the ListIntents operation. If the nextToken field is present, you send the contents as the nextToken parameter of a ListIntents operation request to get the next page of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_intent	select	intent_id, bot_id, bot_version, locale_id, region		Returns metadata about an intent.
list_intents	select	bot_id, bot_version, locale_id, region		Get a list of intents that meet the specified criteria.
create_intent	insert	bot_id, bot_version, locale_id, region, intentName		Creates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent. When you create an intent, you must provide a name. You can optionally provide the following: Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents. Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application. How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available. A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza." A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"
update_intent	update	intent_id, bot_id, bot_version, locale_id, region, intentName		Updates the settings for an intent.
delete_intent	delete	intent_id, bot_id, bot_version, locale_id, region		Removes the specified intent. Deleting an intent also deletes the slots associated with the intent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
bot_id	string	The identifier of the bot associated with the intent.
bot_version	string	The version of the bot associated with the intent.
intent_id	string	The unique identifier of the intent to delete.
locale_id	string	The identifier of the language and locale where the bot will be deleted. The string must match one of the supported locales. For more information, see Supported languages.
region	string	AWS region (default: us-east-1)

SELECT examples

describe_intent

Returns metadata about an intent.

SELECT
bot_id,
bot_version,
creation_date_time,
description,
dialog_code_hook,
fulfillment_code_hook,
initial_response_setting,
input_contexts,
intent_closing_setting,
intent_confirmation_setting,
intent_display_name,
intent_id,
intent_name,
kendra_configuration,
last_updated_date_time,
locale_id,
output_contexts,
parent_intent_signature,
q_in_connect_intent_configuration,
qn_a_intent_configuration,
sample_utterances,
slot_priorities
FROM aws.lexv2_models.intents
WHERE intent_id = '{{ intent_id }}' -- required
AND bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;

list_intents

Get a list of intents that meet the specified criteria.

SELECT
bot_id,
bot_version,
intent_summaries,
locale_id,
next_token
FROM aws.lexv2_models.intents
WHERE bot_id = '{{ bot_id }}' -- required
AND bot_version = '{{ bot_version }}' -- required
AND locale_id = '{{ locale_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_intent

Creates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would create an OrderPizza intent. When you create an intent, you must provide a name. You can optionally provide the following: Sample utterances. For example, "I want to order a pizza" and "Can I order a pizza." You can't provide utterances for built-in intents. Information to be gathered. You specify slots for the information that you bot requests from the user. You can specify standard slot types, such as date and time, or custom slot types for your application. How the intent is fulfilled. You can provide a Lambda function or configure the intent to return the intent information to your client application. If you use a Lambda function, Amazon Lex invokes the function when all of the intent information is available. A confirmation prompt to send to the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent is fulfilled. For example, "I ordered your pizza." A follow-up prompt that asks the user for additional activity. For example, "Do you want a drink with your pizza?"

INSERT INTO aws.lexv2_models.intents (
intentName,
intentDisplayName,
description,
parentIntentSignature,
sampleUtterances,
dialogCodeHook,
fulfillmentCodeHook,
intentConfirmationSetting,
intentClosingSetting,
inputContexts,
outputContexts,
kendraConfiguration,
initialResponseSetting,
qnAIntentConfiguration,
qInConnectIntentConfiguration,
bot_id,
bot_version,
locale_id,
region
)
SELECT 
'{{ intentName }}' /* required */,
'{{ intentDisplayName }}',
'{{ description }}',
'{{ parentIntentSignature }}',
'{{ sampleUtterances }}',
'{{ dialogCodeHook }}',
'{{ fulfillmentCodeHook }}',
'{{ intentConfirmationSetting }}',
'{{ intentClosingSetting }}',
'{{ inputContexts }}',
'{{ outputContexts }}',
'{{ kendraConfiguration }}',
'{{ initialResponseSetting }}',
'{{ qnAIntentConfiguration }}',
'{{ qInConnectIntentConfiguration }}',
'{{ bot_id }}',
'{{ bot_version }}',
'{{ locale_id }}',
'{{ region }}'
RETURNING
bot_id,
bot_version,
creation_date_time,
description,
dialog_code_hook,
fulfillment_code_hook,
initial_response_setting,
input_contexts,
intent_closing_setting,
intent_confirmation_setting,
intent_display_name,
intent_id,
intent_name,
kendra_configuration,
locale_id,
output_contexts,
parent_intent_signature,
q_in_connect_intent_configuration,
qn_a_intent_configuration,
sample_utterances
;

Manifest

# Description fields are for documentation purposes
- name: intents
props:
  - name: bot_id
    value: "{{ bot_id }}"
    description: Required parameter for the intents resource.
  - name: bot_version
    value: "{{ bot_version }}"
    description: Required parameter for the intents resource.
  - name: locale_id
    value: "{{ locale_id }}"
    description: Required parameter for the intents resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the intents resource.
  - name: intentName
    value: "{{ intentName }}"
  - name: intentDisplayName
    value: "{{ intentDisplayName }}"
  - name: description
    value: "{{ description }}"
  - name: parentIntentSignature
    value: "{{ parentIntentSignature }}"
  - name: sampleUtterances
    value:
      - utterance: "{{ utterance }}"
  - name: dialogCodeHook
    description: |
      Settings that determine the Lambda function that Amazon Lex uses for processing user responses.
    value:
      enabled: {{ enabled }}
  - name: fulfillmentCodeHook
    description: |
      Determines if a Lambda function should be invoked for a specific intent.
    value:
      enabled: {{ enabled }}
      postFulfillmentStatusSpecification:
        successResponse:
          messageGroups:
            - message:
                plainTextMessage: "{{ plainTextMessage }}"
                customPayload: "{{ customPayload }}"
                ssmlMessage: "{{ ssmlMessage }}"
                imageResponseCard: "{{ imageResponseCard }}"
              variations: "{{ variations }}"
          allowInterrupt: {{ allowInterrupt }}
        failureResponse:
          messageGroups:
            - message:
                plainTextMessage: "{{ plainTextMessage }}"
                customPayload: "{{ customPayload }}"
                ssmlMessage: "{{ ssmlMessage }}"
                imageResponseCard: "{{ imageResponseCard }}"
              variations: "{{ variations }}"
          allowInterrupt: {{ allowInterrupt }}
        timeoutResponse:
          messageGroups:
            - message:
                plainTextMessage: "{{ plainTextMessage }}"
                customPayload: "{{ customPayload }}"
                ssmlMessage: "{{ ssmlMessage }}"
                imageResponseCard: "{{ imageResponseCard }}"
              variations: "{{ variations }}"
          allowInterrupt: {{ allowInterrupt }}
        successNextStep:
          dialogAction:
            type_: "{{ type_ }}"
            slotToElicit: "{{ slotToElicit }}"
            suppressNextMessage: {{ suppressNextMessage }}
          intent:
            name: "{{ name }}"
            slots: "{{ slots }}"
          sessionAttributes: "{{ sessionAttributes }}"
        successConditional:
          active: {{ active }}
          conditionalBranches:
            - name: "{{ name }}"
              condition:
                expressionString: "{{ expressionString }}"
              nextStep:
                dialogAction: "{{ dialogAction }}"
                intent: "{{ intent }}"
                sessionAttributes: "{{ sessionAttributes }}"
              response:
                messageGroups: "{{ messageGroups }}"
                allowInterrupt: {{ allowInterrupt }}
          defaultBranch:
            nextStep:
              dialogAction: "{{ dialogAction }}"
              intent: "{{ intent }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups: "{{ messageGroups }}"
              allowInterrupt: {{ allowInterrupt }}
        failureNextStep:
          dialogAction:
            type_: "{{ type_ }}"
            slotToElicit: "{{ slotToElicit }}"
            suppressNextMessage: {{ suppressNextMessage }}
          intent:
            name: "{{ name }}"
            slots: "{{ slots }}"
          sessionAttributes: "{{ sessionAttributes }}"
        failureConditional:
          active: {{ active }}
          conditionalBranches:
            - name: "{{ name }}"
              condition:
                expressionString: "{{ expressionString }}"
              nextStep:
                dialogAction: "{{ dialogAction }}"
                intent: "{{ intent }}"
                sessionAttributes: "{{ sessionAttributes }}"
              response:
                messageGroups: "{{ messageGroups }}"
                allowInterrupt: {{ allowInterrupt }}
          defaultBranch:
            nextStep:
              dialogAction: "{{ dialogAction }}"
              intent: "{{ intent }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups: "{{ messageGroups }}"
              allowInterrupt: {{ allowInterrupt }}
        timeoutNextStep:
          dialogAction:
            type_: "{{ type_ }}"
            slotToElicit: "{{ slotToElicit }}"
            suppressNextMessage: {{ suppressNextMessage }}
          intent:
            name: "{{ name }}"
            slots: "{{ slots }}"
          sessionAttributes: "{{ sessionAttributes }}"
        timeoutConditional:
          active: {{ active }}
          conditionalBranches:
            - name: "{{ name }}"
              condition:
                expressionString: "{{ expressionString }}"
              nextStep:
                dialogAction: "{{ dialogAction }}"
                intent: "{{ intent }}"
                sessionAttributes: "{{ sessionAttributes }}"
              response:
                messageGroups: "{{ messageGroups }}"
                allowInterrupt: {{ allowInterrupt }}
          defaultBranch:
            nextStep:
              dialogAction: "{{ dialogAction }}"
              intent: "{{ intent }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups: "{{ messageGroups }}"
              allowInterrupt: {{ allowInterrupt }}
      fulfillmentUpdatesSpecification:
        active: {{ active }}
        startResponse:
          delayInSeconds: {{ delayInSeconds }}
          messageGroups:
            - message:
                plainTextMessage: "{{ plainTextMessage }}"
                customPayload: "{{ customPayload }}"
                ssmlMessage: "{{ ssmlMessage }}"
                imageResponseCard: "{{ imageResponseCard }}"
              variations: "{{ variations }}"
          allowInterrupt: {{ allowInterrupt }}
        updateResponse:
          frequencyInSeconds: {{ frequencyInSeconds }}
          messageGroups:
            - message:
                plainTextMessage: "{{ plainTextMessage }}"
                customPayload: "{{ customPayload }}"
                ssmlMessage: "{{ ssmlMessage }}"
                imageResponseCard: "{{ imageResponseCard }}"
              variations: "{{ variations }}"
          allowInterrupt: {{ allowInterrupt }}
        timeoutInSeconds: {{ timeoutInSeconds }}
      active: {{ active }}
  - name: intentConfirmationSetting
    description: |
      Provides a prompt for making sure that the user is ready for the intent to be fulfilled.
    value:
      promptSpecification:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        maxRetries: {{ maxRetries }}
        allowInterrupt: {{ allowInterrupt }}
        messageSelectionStrategy: "{{ messageSelectionStrategy }}"
        promptAttemptsSpecification: "{{ promptAttemptsSpecification }}"
      declinationResponse:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        allowInterrupt: {{ allowInterrupt }}
      active: {{ active }}
      confirmationResponse:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        allowInterrupt: {{ allowInterrupt }}
      confirmationNextStep:
        dialogAction:
          type_: "{{ type_ }}"
          slotToElicit: "{{ slotToElicit }}"
          suppressNextMessage: {{ suppressNextMessage }}
        intent:
          name: "{{ name }}"
          slots: "{{ slots }}"
        sessionAttributes: "{{ sessionAttributes }}"
      confirmationConditional:
        active: {{ active }}
        conditionalBranches:
          - name: "{{ name }}"
            condition:
              expressionString: "{{ expressionString }}"
            nextStep:
              dialogAction:
                type_: "{{ type_ }}"
                slotToElicit: "{{ slotToElicit }}"
                suppressNextMessage: {{ suppressNextMessage }}
              intent:
                name: "{{ name }}"
                slots: "{{ slots }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups:
                - message:
                    plainTextMessage: "{{ plainTextMessage }}"
                    customPayload: "{{ customPayload }}"
                    ssmlMessage: "{{ ssmlMessage }}"
                    imageResponseCard: "{{ imageResponseCard }}"
                  variations: "{{ variations }}"
              allowInterrupt: {{ allowInterrupt }}
        defaultBranch:
          nextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          response:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
      declinationNextStep:
        dialogAction:
          type_: "{{ type_ }}"
          slotToElicit: "{{ slotToElicit }}"
          suppressNextMessage: {{ suppressNextMessage }}
        intent:
          name: "{{ name }}"
          slots: "{{ slots }}"
        sessionAttributes: "{{ sessionAttributes }}"
      declinationConditional:
        active: {{ active }}
        conditionalBranches:
          - name: "{{ name }}"
            condition:
              expressionString: "{{ expressionString }}"
            nextStep:
              dialogAction:
                type_: "{{ type_ }}"
                slotToElicit: "{{ slotToElicit }}"
                suppressNextMessage: {{ suppressNextMessage }}
              intent:
                name: "{{ name }}"
                slots: "{{ slots }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups:
                - message:
                    plainTextMessage: "{{ plainTextMessage }}"
                    customPayload: "{{ customPayload }}"
                    ssmlMessage: "{{ ssmlMessage }}"
                    imageResponseCard: "{{ imageResponseCard }}"
                  variations: "{{ variations }}"
              allowInterrupt: {{ allowInterrupt }}
        defaultBranch:
          nextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          response:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
      failureResponse:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        allowInterrupt: {{ allowInterrupt }}
      failureNextStep:
        dialogAction:
          type_: "{{ type_ }}"
          slotToElicit: "{{ slotToElicit }}"
          suppressNextMessage: {{ suppressNextMessage }}
        intent:
          name: "{{ name }}"
          slots: "{{ slots }}"
        sessionAttributes: "{{ sessionAttributes }}"
      failureConditional:
        active: {{ active }}
        conditionalBranches:
          - name: "{{ name }}"
            condition:
              expressionString: "{{ expressionString }}"
            nextStep:
              dialogAction:
                type_: "{{ type_ }}"
                slotToElicit: "{{ slotToElicit }}"
                suppressNextMessage: {{ suppressNextMessage }}
              intent:
                name: "{{ name }}"
                slots: "{{ slots }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups:
                - message:
                    plainTextMessage: "{{ plainTextMessage }}"
                    customPayload: "{{ customPayload }}"
                    ssmlMessage: "{{ ssmlMessage }}"
                    imageResponseCard: "{{ imageResponseCard }}"
                  variations: "{{ variations }}"
              allowInterrupt: {{ allowInterrupt }}
        defaultBranch:
          nextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          response:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
      codeHook:
        enableCodeHookInvocation: {{ enableCodeHookInvocation }}
        active: {{ active }}
        invocationLabel: "{{ invocationLabel }}"
        postCodeHookSpecification:
          successResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          successNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          successConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
          failureResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          failureNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          failureConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
          timeoutResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          timeoutNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          timeoutConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
      elicitationCodeHook:
        enableCodeHookInvocation: {{ enableCodeHookInvocation }}
        invocationLabel: "{{ invocationLabel }}"
  - name: intentClosingSetting
    description: |
      Provides a statement the Amazon Lex conveys to the user when the intent is successfully fulfilled.
    value:
      closingResponse:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        allowInterrupt: {{ allowInterrupt }}
      active: {{ active }}
      nextStep:
        dialogAction:
          type_: "{{ type_ }}"
          slotToElicit: "{{ slotToElicit }}"
          suppressNextMessage: {{ suppressNextMessage }}
        intent:
          name: "{{ name }}"
          slots: "{{ slots }}"
        sessionAttributes: "{{ sessionAttributes }}"
      conditional:
        active: {{ active }}
        conditionalBranches:
          - name: "{{ name }}"
            condition:
              expressionString: "{{ expressionString }}"
            nextStep:
              dialogAction:
                type_: "{{ type_ }}"
                slotToElicit: "{{ slotToElicit }}"
                suppressNextMessage: {{ suppressNextMessage }}
              intent:
                name: "{{ name }}"
                slots: "{{ slots }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups:
                - message:
                    plainTextMessage: "{{ plainTextMessage }}"
                    customPayload: "{{ customPayload }}"
                    ssmlMessage: "{{ ssmlMessage }}"
                    imageResponseCard: "{{ imageResponseCard }}"
                  variations: "{{ variations }}"
              allowInterrupt: {{ allowInterrupt }}
        defaultBranch:
          nextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          response:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
  - name: inputContexts
    value:
      - name: "{{ name }}"
  - name: outputContexts
    value:
      - name: "{{ name }}"
        timeToLiveInSeconds: {{ timeToLiveInSeconds }}
        turnsToLive: {{ turnsToLive }}
  - name: kendraConfiguration
    description: |
      Provides configuration information for the AMAZON.KendraSearchIntent intent. When you use this intent, Amazon Lex searches the specified Amazon Kendra index and returns documents from the index that match the user's utterance.
    value:
      kendraIndex: "{{ kendraIndex }}"
      queryFilterStringEnabled: {{ queryFilterStringEnabled }}
      queryFilterString: "{{ queryFilterString }}"
  - name: initialResponseSetting
    description: |
      Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.
    value:
      initialResponse:
        messageGroups:
          - message:
              plainTextMessage:
                value: "{{ value }}"
              customPayload:
                value: "{{ value }}"
              ssmlMessage:
                value: "{{ value }}"
              imageResponseCard:
                title_: "{{ title_ }}"
                subtitle: "{{ subtitle }}"
                imageUrl: "{{ imageUrl }}"
                buttons: "{{ buttons }}"
            variations: "{{ variations }}"
        allowInterrupt: {{ allowInterrupt }}
      nextStep:
        dialogAction:
          type_: "{{ type_ }}"
          slotToElicit: "{{ slotToElicit }}"
          suppressNextMessage: {{ suppressNextMessage }}
        intent:
          name: "{{ name }}"
          slots: "{{ slots }}"
        sessionAttributes: "{{ sessionAttributes }}"
      conditional:
        active: {{ active }}
        conditionalBranches:
          - name: "{{ name }}"
            condition:
              expressionString: "{{ expressionString }}"
            nextStep:
              dialogAction:
                type_: "{{ type_ }}"
                slotToElicit: "{{ slotToElicit }}"
                suppressNextMessage: {{ suppressNextMessage }}
              intent:
                name: "{{ name }}"
                slots: "{{ slots }}"
              sessionAttributes: "{{ sessionAttributes }}"
            response:
              messageGroups:
                - message:
                    plainTextMessage: "{{ plainTextMessage }}"
                    customPayload: "{{ customPayload }}"
                    ssmlMessage: "{{ ssmlMessage }}"
                    imageResponseCard: "{{ imageResponseCard }}"
                  variations: "{{ variations }}"
              allowInterrupt: {{ allowInterrupt }}
        defaultBranch:
          nextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          response:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
      codeHook:
        enableCodeHookInvocation: {{ enableCodeHookInvocation }}
        active: {{ active }}
        invocationLabel: "{{ invocationLabel }}"
        postCodeHookSpecification:
          successResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          successNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          successConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
          failureResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          failureNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          failureConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
          timeoutResponse:
            messageGroups:
              - message:
                  plainTextMessage: "{{ plainTextMessage }}"
                  customPayload: "{{ customPayload }}"
                  ssmlMessage: "{{ ssmlMessage }}"
                  imageResponseCard: "{{ imageResponseCard }}"
                variations: "{{ variations }}"
            allowInterrupt: {{ allowInterrupt }}
          timeoutNextStep:
            dialogAction:
              type_: "{{ type_ }}"
              slotToElicit: "{{ slotToElicit }}"
              suppressNextMessage: {{ suppressNextMessage }}
            intent:
              name: "{{ name }}"
              slots: "{{ slots }}"
            sessionAttributes: "{{ sessionAttributes }}"
          timeoutConditional:
            active: {{ active }}
            conditionalBranches:
              - name: "{{ name }}"
                condition:
                  expressionString: "{{ expressionString }}"
                nextStep:
                  dialogAction: "{{ dialogAction }}"
                  intent: "{{ intent }}"
                  sessionAttributes: "{{ sessionAttributes }}"
                response:
                  messageGroups: "{{ messageGroups }}"
                  allowInterrupt: {{ allowInterrupt }}
            defaultBranch:
              nextStep: "{{ nextStep }}"
              response: "{{ response }}"
  - name: qnAIntentConfiguration
    description: |
      Details about the the configuration of the built-in Amazon.QnAIntent.
    value:
      dataSourceConfiguration:
        opensearchConfiguration:
          domainEndpoint: "{{ domainEndpoint }}"
          indexName: "{{ indexName }}"
          exactResponse: {{ exactResponse }}
          exactResponseFields:
            questionField: "{{ questionField }}"
            answerField: "{{ answerField }}"
          includeFields:
            - "{{ includeFields }}"
        kendraConfiguration:
          kendraIndex: "{{ kendraIndex }}"
          queryFilterStringEnabled: {{ queryFilterStringEnabled }}
          queryFilterString: "{{ queryFilterString }}"
          exactResponse: {{ exactResponse }}
        bedrockKnowledgeStoreConfiguration:
          bedrockKnowledgeBaseArn: "{{ bedrockKnowledgeBaseArn }}"
          exactResponse: {{ exactResponse }}
          exactResponseFields:
            answerField: "{{ answerField }}"
      bedrockModelConfiguration:
        modelArn: "{{ modelArn }}"
        guardrail:
          identifier: "{{ identifier }}"
          version: "{{ version }}"
        traceStatus: "{{ traceStatus }}"
        customPrompt: "{{ customPrompt }}"
  - name: qInConnectIntentConfiguration
    description: |
      The configuration details of the Qinconnect intent.
    value:
      qInConnectAssistantConfiguration:
        assistantArn: "{{ assistantArn }}"

UPDATE examples

update_intent

Updates the settings for an intent.

UPDATE aws.lexv2_models.intents
SET 
intentName = '{{ intentName }}',
intentDisplayName = '{{ intentDisplayName }}',
description = '{{ description }}',
parentIntentSignature = '{{ parentIntentSignature }}',
sampleUtterances = '{{ sampleUtterances }}',
dialogCodeHook = '{{ dialogCodeHook }}',
fulfillmentCodeHook = '{{ fulfillmentCodeHook }}',
slotPriorities = '{{ slotPriorities }}',
intentConfirmationSetting = '{{ intentConfirmationSetting }}',
intentClosingSetting = '{{ intentClosingSetting }}',
inputContexts = '{{ inputContexts }}',
outputContexts = '{{ outputContexts }}',
kendraConfiguration = '{{ kendraConfiguration }}',
initialResponseSetting = '{{ initialResponseSetting }}',
qnAIntentConfiguration = '{{ qnAIntentConfiguration }}',
qInConnectIntentConfiguration = '{{ qInConnectIntentConfiguration }}'
WHERE 
intent_id = '{{ intent_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND bot_version = '{{ bot_version }}' --required
AND locale_id = '{{ locale_id }}' --required
AND region = '{{ region }}' --required
AND intentName = '{{ intentName }}' --required
RETURNING
bot_id,
bot_version,
creation_date_time,
description,
dialog_code_hook,
fulfillment_code_hook,
initial_response_setting,
input_contexts,
intent_closing_setting,
intent_confirmation_setting,
intent_display_name,
intent_id,
intent_name,
kendra_configuration,
last_updated_date_time,
locale_id,
output_contexts,
parent_intent_signature,
q_in_connect_intent_configuration,
qn_a_intent_configuration,
sample_utterances,
slot_priorities;

DELETE examples

delete_intent

Removes the specified intent. Deleting an intent also deletes the slots associated with the intent.

DELETE FROM aws.lexv2_models.intents
WHERE intent_id = '{{ intent_id }}' --required
AND bot_id = '{{ bot_id }}' --required
AND bot_version = '{{ bot_version }}' --required
AND locale_id = '{{ locale_id }}' --required
AND region = '{{ region }}' --required
;