DescribeIntent - Amazon Lex API Reference

DescribeIntent

Returns metadata about an intent.

Request Syntax

GET /bots/botId/botversions/botVersion/botlocales/localeId/intents/intentId/ HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

botId

The identifier of the bot associated with the intent.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

botVersion

The version of the bot associated with the intent.

Length Constraints: Minimum length of 1. Maximum length of 5.

Pattern: ^(DRAFT|[0-9]+)$

Required: Yes

intentId

The identifier of the intent to describe.

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

Required: Yes

localeId

The identifier of the language and locale of the intent to describe. The string must match one of the supported locales. For more information, see Supported languages.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "botId": "string", "botVersion": "string", "creationDateTime": number, "description": "string", "dialogCodeHook": { "enabled": boolean }, "fulfillmentCodeHook": { "active": boolean, "enabled": boolean, "fulfillmentUpdatesSpecification": { "active": boolean, "startResponse": { "allowInterrupt": boolean, "delayInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutInSeconds": number, "updateResponse": { "allowInterrupt": boolean, "frequencyInSeconds": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } }, "postFulfillmentStatusSpecification": { "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "successNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "timeoutNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "initialResponseSetting": { "codeHook": { "active": boolean, "enableCodeHookInvocation": boolean, "invocationLabel": "string", "postCodeHookSpecification": { "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "successNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "timeoutNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "conditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "initialResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } } }, "inputContexts": [ { "name": "string" } ], "intentClosingSetting": { "active": boolean, "closingResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "conditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } } }, "intentConfirmationSetting": { "active": boolean, "codeHook": { "active": boolean, "enableCodeHookInvocation": boolean, "invocationLabel": "string", "postCodeHookSpecification": { "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "successConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "successNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "successResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "timeoutConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "timeoutNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "timeoutResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "confirmationConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "confirmationNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "confirmationResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "declinationConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "declinationNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "declinationResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "elicitationCodeHook": { "enableCodeHookInvocation": boolean, "invocationLabel": "string" }, "failureConditional": { "active": boolean, "conditionalBranches": [ { "condition": { "expressionString": "string" }, "name": "string", "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } ], "defaultBranch": { "nextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "response": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] } } }, "failureNextStep": { "dialogAction": { "slotToElicit": "string", "suppressNextMessage": boolean, "type": "string" }, "intent": { "name": "string", "slots": { "string" : { "shape": "string", "value": { "interpretedValue": "string" }, "values": [ "SlotValueOverride" ] } } }, "sessionAttributes": { "string" : "string" } }, "failureResponse": { "allowInterrupt": boolean, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ] }, "promptSpecification": { "allowInterrupt": boolean, "maxRetries": number, "messageGroups": [ { "message": { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } }, "variations": [ { "customPayload": { "value": "string" }, "imageResponseCard": { "buttons": [ { "text": "string", "value": "string" } ], "imageUrl": "string", "subtitle": "string", "title": "string" }, "plainTextMessage": { "value": "string" }, "ssmlMessage": { "value": "string" } } ] } ], "messageSelectionStrategy": "string", "promptAttemptsSpecification": { "string" : { "allowedInputTypes": { "allowAudioInput": boolean, "allowDTMFInput": boolean }, "allowInterrupt": boolean, "audioAndDTMFInputSpecification": { "audioSpecification": { "endTimeoutMs": number, "maxLengthMs": number }, "dtmfSpecification": { "deletionCharacter": "string", "endCharacter": "string", "endTimeoutMs": number, "maxLength": number }, "startTimeoutMs": number }, "textInputSpecification": { "startTimeoutMs": number } } } } }, "intentId": "string", "intentName": "string", "kendraConfiguration": { "kendraIndex": "string", "queryFilterString": "string", "queryFilterStringEnabled": boolean }, "lastUpdatedDateTime": number, "localeId": "string", "outputContexts": [ { "name": "string", "timeToLiveInSeconds": number, "turnsToLive": number } ], "parentIntentSignature": "string", "sampleUtterances": [ { "utterance": "string" } ], "slotPriorities": [ { "priority": number, "slotId": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

botId

The identifier of the bot associated with the intent.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

botVersion

The version of the bot associated with the intent.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^DRAFT$

creationDateTime

A timestamp of the date and time that the intent was created.

Type: Timestamp

description

The description of the intent.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

dialogCodeHook

The Lambda function called during each turn of a conversation with the intent.

Type: DialogCodeHookSettings object

fulfillmentCodeHook

The Lambda function called when the intent is complete and ready for fulfillment.

Type: FulfillmentCodeHookSettings object

initialResponseSetting

Configuration setting for a response sent to the user before Amazon Lex starts eliciting slots.

Type: InitialResponseSetting object

inputContexts

A list of contexts that must be active for the intent to be considered for sending to the user.

Type: Array of InputContext objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

intentClosingSetting

The response that Amazon Lex sends to when the intent is closed.

Type: IntentClosingSetting object

intentConfirmationSetting

Prompts that Amazon Lex sends to the user to confirm completion of an intent.

Type: IntentConfirmationSetting object

intentId

The unique identifier assigned to the intent when it was created.

Type: String

Length Constraints: Fixed length of 10.

Pattern: ^[0-9a-zA-Z]+$

intentName

The name specified for the intent.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^([0-9a-zA-Z][_-]?)+$

kendraConfiguration

Configuration information required to use the AMAZON.KendraSearchIntent intent.

Type: KendraConfiguration object

lastUpdatedDateTime

A timestamp of the date and time that the intent was last updated.

Type: Timestamp

localeId

The language and locale specified for the intent.

Type: String

outputContexts

A list of contexts that are activated when the intent is fulfilled.

Type: Array of OutputContext objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

parentIntentSignature

The identifier of the built-in intent that this intent is derived from, if any.

Type: String

sampleUtterances

User utterances that trigger this intent.

Type: Array of SampleUtterance objects

slotPriorities

The list that determines the priority that slots should be elicited from the user.

Type: Array of SlotPriority objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

The service encountered an unexpected condition. Try your request again.

HTTP Status Code: 500

ResourceNotFoundException

You asked to describe a resource that doesn't exist. Check the resource that you are requesting and try again.

HTTP Status Code: 404

ServiceQuotaExceededException

You have reached a quota for your bot.

HTTP Status Code: 402

ThrottlingException

Your request rate is too high. Reduce the frequency of requests.

HTTP Status Code: 429

ValidationException

One of the input parameters in your request isn't valid. Check the parameters and try your request again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: