@aws-sdk/client-lex-models-v2 3.298.0 → 3.300.0

package/dist-types/commands/CreateIntentCommand.d.ts

@@ -63,6 +63,714 @@ export interface CreateIntentCommandOutput extends CreateIntentResponse, __Metad
  * import { LexModelsV2Client, CreateIntentCommand } from "@aws-sdk/client-lex-models-v2"; // ES Modules import
  * // const { LexModelsV2Client, CreateIntentCommand } = require("@aws-sdk/client-lex-models-v2"); // CommonJS import
  * const client = new LexModelsV2Client(config);
+ * const input = {
+ *   intentName: "STRING_VALUE", // required
+ *   description: "STRING_VALUE",
+ *   parentIntentSignature: "STRING_VALUE",
+ *   sampleUtterances: [
+ *     {
+ *       utterance: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   dialogCodeHook: {
+ *     enabled: true || false, // required
+ *   },
+ *   fulfillmentCodeHook: {
+ *     enabled: true || false, // required
+ *     postFulfillmentStatusSpecification: {
+ *       successResponse: {
+ *         messageGroups: [ // required
+ *           {
+ *             message: {
+ *               plainTextMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               customPayload: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               ssmlMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               imageResponseCard: {
+ *                 title: "STRING_VALUE", // required
+ *                 subtitle: "STRING_VALUE",
+ *                 imageUrl: "STRING_VALUE",
+ *                 buttons: [
+ *                   {
+ *                     text: "STRING_VALUE", // required
+ *                     value: "STRING_VALUE", // required
+ *                   },
+ *                 ],
+ *               },
+ *             },
+ *             variations: [
+ *               {
+ *                 plainTextMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 customPayload: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 ssmlMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 imageResponseCard: {
+ *                   title: "STRING_VALUE", // required
+ *                   subtitle: "STRING_VALUE",
+ *                   imageUrl: "STRING_VALUE",
+ *                   buttons: [
+ *                     {
+ *                       text: "STRING_VALUE", // required
+ *                       value: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                 },
+ *               },
+ *             ],
+ *           },
+ *         ],
+ *         allowInterrupt: true || false,
+ *       },
+ *       failureResponse: {
+ *         messageGroups: [ // required
+ *           {
+ *             message: {
+ *               plainTextMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               customPayload: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               ssmlMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               imageResponseCard: {
+ *                 title: "STRING_VALUE", // required
+ *                 subtitle: "STRING_VALUE",
+ *                 imageUrl: "STRING_VALUE",
+ *                 buttons: [
+ *                   {
+ *                     text: "STRING_VALUE", // required
+ *                     value: "STRING_VALUE", // required
+ *                   },
+ *                 ],
+ *               },
+ *             },
+ *             variations: [
+ *               {
+ *                 plainTextMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 customPayload: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 ssmlMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 imageResponseCard: {
+ *                   title: "STRING_VALUE", // required
+ *                   subtitle: "STRING_VALUE",
+ *                   imageUrl: "STRING_VALUE",
+ *                   buttons: [
+ *                     {
+ *                       text: "STRING_VALUE", // required
+ *                       value: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                 },
+ *               },
+ *             ],
+ *           },
+ *         ],
+ *         allowInterrupt: true || false,
+ *       },
+ *       timeoutResponse: {
+ *         messageGroups: [ // required
+ *           {
+ *             message: {
+ *               plainTextMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               customPayload: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               ssmlMessage: {
+ *                 value: "STRING_VALUE", // required
+ *               },
+ *               imageResponseCard: {
+ *                 title: "STRING_VALUE", // required
+ *                 subtitle: "STRING_VALUE",
+ *                 imageUrl: "STRING_VALUE",
+ *                 buttons: [
+ *                   {
+ *                     text: "STRING_VALUE", // required
+ *                     value: "STRING_VALUE", // required
+ *                   },
+ *                 ],
+ *               },
+ *             },
+ *             variations: [
+ *               {
+ *                 plainTextMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 customPayload: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 ssmlMessage: {
+ *                   value: "STRING_VALUE", // required
+ *                 },
+ *                 imageResponseCard: {
+ *                   title: "STRING_VALUE", // required
+ *                   subtitle: "STRING_VALUE",
+ *                   imageUrl: "STRING_VALUE",
+ *                   buttons: [
+ *                     {
+ *                       text: "STRING_VALUE", // required
+ *                       value: "STRING_VALUE", // required
+ *                     },
+ *                   ],
+ *                 },
+ *               },
+ *             ],
+ *           },
+ *         ],
+ *         allowInterrupt: true || false,
+ *       },
+ *       successNextStep: {
+ *         dialogAction: {
+ *           type: "ElicitIntent" || "StartIntent" || "ElicitSlot" || "EvaluateConditional" || "InvokeDialogCodeHook" || "ConfirmIntent" || "FulfillIntent" || "CloseIntent" || "EndConversation", // required
+ *           slotToElicit: "STRING_VALUE",
+ *           suppressNextMessage: true || false,
+ *         },
+ *         intent: {
+ *           name: "STRING_VALUE",
+ *           slots: {
+ *             "<keys>": {
+ *               shape: "Scalar" || "List",
+ *               value: {
+ *                 interpretedValue: "STRING_VALUE",
+ *               },
+ *               values: [
+ *                 {
+ *                   shape: "Scalar" || "List",
+ *                   value: {
+ *                     interpretedValue: "STRING_VALUE",
+ *                   },
+ *                   values: [
+ *                     {
+ *                       shape: "<SlotValueOverride>",
+ *                       value: "<SlotValueOverride>",
+ *                       values: "<SlotValueOverride>",
+ *                     },
+ *                   ],
+ *                 },
+ *               ],
+ *             },
+ *           },
+ *         },
+ *         sessionAttributes: {
+ *           "<keys>": "STRING_VALUE",
+ *         },
+ *       },
+ *       successConditional: {
+ *         active: true || false, // required
+ *         conditionalBranches: [ // required
+ *           {
+ *             name: "STRING_VALUE", // required
+ *             condition: {
+ *               expressionString: "STRING_VALUE", // required
+ *             },
+ *             nextStep: {
+ *               dialogAction: {
+ *                 type: "ElicitIntent" || "StartIntent" || "ElicitSlot" || "EvaluateConditional" || "InvokeDialogCodeHook" || "ConfirmIntent" || "FulfillIntent" || "CloseIntent" || "EndConversation", // required
+ *                 slotToElicit: "STRING_VALUE",
+ *                 suppressNextMessage: true || false,
+ *               },
+ *               intent: {
+ *                 name: "STRING_VALUE",
+ *                 slots: {
+ *                   "<keys>": {
+ *                     shape: "<SlotValueOverride>",
+ *                     value: "<SlotValueOverride>",
+ *                     values: "<SlotValueOverride>",
+ *                   },
+ *                 },
+ *               },
+ *               sessionAttributes: {
+ *                 "<keys>": "STRING_VALUE",
+ *               },
+ *             },
+ *             response: {
+ *               messageGroups: [ // required
+ *                 {
+ *                   message: {
+ *                     plainTextMessage: "<Message>",
+ *                     customPayload: "<Message>",
+ *                     ssmlMessage: "<Message>",
+ *                     imageResponseCard: "<Message>",
+ *                   },
+ *                   variations: [
+ *                     {
+ *                       plainTextMessage: "<Message>",
+ *                       customPayload: "<Message>",
+ *                       ssmlMessage: "<Message>",
+ *                       imageResponseCard: "<Message>",
+ *                     },
+ *                   ],
+ *                 },
+ *               ],
+ *               allowInterrupt: true || false,
+ *             },
+ *           },
+ *         ],
+ *         defaultBranch: {
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       },
+ *       failureNextStep: {
+ *         dialogAction: "<DialogState>",
+ *         intent: "<DialogState>",
+ *         sessionAttributes: "<DialogState>",
+ *       },
+ *       failureConditional: {
+ *         active: true || false, // required
+ *         conditionalBranches: [ // required
+ *           {
+ *             name: "STRING_VALUE", // required
+ *             condition: {
+ *               expressionString: "STRING_VALUE", // required
+ *             },
+ *             nextStep: {
+ *               dialogAction: "<DialogState>",
+ *               intent: "<DialogState>",
+ *               sessionAttributes: "<DialogState>",
+ *             },
+ *             response: {
+ *               messageGroups: "<ResponseSpecification>",
+ *               allowInterrupt: "<ResponseSpecification>",
+ *             },
+ *           },
+ *         ],
+ *         defaultBranch: {
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       },
+ *       timeoutNextStep: {
+ *         dialogAction: "<DialogState>",
+ *         intent: "<DialogState>",
+ *         sessionAttributes: "<DialogState>",
+ *       },
+ *       timeoutConditional: {
+ *         active: true || false, // required
+ *         conditionalBranches: [ // required
+ *           {
+ *             name: "STRING_VALUE", // required
+ *             condition: {
+ *               expressionString: "STRING_VALUE", // required
+ *             },
+ *             nextStep: {
+ *               dialogAction: "<DialogState>",
+ *               intent: "<DialogState>",
+ *               sessionAttributes: "<DialogState>",
+ *             },
+ *             response: {
+ *               messageGroups: "<ResponseSpecification>",
+ *               allowInterrupt: "<ResponseSpecification>",
+ *             },
+ *           },
+ *         ],
+ *         defaultBranch: {
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       },
+ *     },
+ *     fulfillmentUpdatesSpecification: {
+ *       active: true || false, // required
+ *       startResponse: {
+ *         delayInSeconds: Number("int"), // required
+ *         messageGroups: [ // required
+ *           {
+ *             message: {
+ *               plainTextMessage: "<Message>",
+ *               customPayload: "<Message>",
+ *               ssmlMessage: "<Message>",
+ *               imageResponseCard: "<Message>",
+ *             },
+ *             variations: [
+ *               {
+ *                 plainTextMessage: "<Message>",
+ *                 customPayload: "<Message>",
+ *                 ssmlMessage: "<Message>",
+ *                 imageResponseCard: "<Message>",
+ *               },
+ *             ],
+ *           },
+ *         ],
+ *         allowInterrupt: true || false,
+ *       },
+ *       updateResponse: {
+ *         frequencyInSeconds: Number("int"), // required
+ *         messageGroups: [ // required
+ *           {
+ *             message: {
+ *               plainTextMessage: "<Message>",
+ *               customPayload: "<Message>",
+ *               ssmlMessage: "<Message>",
+ *               imageResponseCard: "<Message>",
+ *             },
+ *             variations: [
+ *               {
+ *                 plainTextMessage: "<Message>",
+ *                 customPayload: "<Message>",
+ *                 ssmlMessage: "<Message>",
+ *                 imageResponseCard: "<Message>",
+ *               },
+ *             ],
+ *           },
+ *         ],
+ *         allowInterrupt: true || false,
+ *       },
+ *       timeoutInSeconds: Number("int"),
+ *     },
+ *     active: true || false,
+ *   },
+ *   intentConfirmationSetting: {
+ *     promptSpecification: {
+ *       messageGroups: [ // required
+ *         "<MessageGroupsList>",
+ *       ],
+ *       maxRetries: Number("int"), // required
+ *       allowInterrupt: true || false,
+ *       messageSelectionStrategy: "Random" || "Ordered",
+ *       promptAttemptsSpecification: {
+ *         "<keys>": {
+ *           allowInterrupt: true || false,
+ *           allowedInputTypes: {
+ *             allowAudioInput: true || false, // required
+ *             allowDTMFInput: true || false, // required
+ *           },
+ *           audioAndDTMFInputSpecification: {
+ *             startTimeoutMs: Number("int"), // required
+ *             audioSpecification: {
+ *               maxLengthMs: Number("int"), // required
+ *               endTimeoutMs: Number("int"), // required
+ *             },
+ *             dtmfSpecification: {
+ *               maxLength: Number("int"), // required
+ *               endTimeoutMs: Number("int"), // required
+ *               deletionCharacter: "STRING_VALUE", // required
+ *               endCharacter: "STRING_VALUE", // required
+ *             },
+ *           },
+ *           textInputSpecification: {
+ *             startTimeoutMs: Number("int"), // required
+ *           },
+ *         },
+ *       },
+ *     },
+ *     declinationResponse: {
+ *       messageGroups: "<ResponseSpecification>",
+ *       allowInterrupt: "<ResponseSpecification>",
+ *     },
+ *     active: true || false,
+ *     confirmationResponse: {
+ *       messageGroups: "<ResponseSpecification>",
+ *       allowInterrupt: "<ResponseSpecification>",
+ *     },
+ *     confirmationNextStep: {
+ *       dialogAction: "<DialogState>",
+ *       intent: "<DialogState>",
+ *       sessionAttributes: "<DialogState>",
+ *     },
+ *     confirmationConditional: {
+ *       active: true || false, // required
+ *       conditionalBranches: [ // required
+ *         {
+ *           name: "STRING_VALUE", // required
+ *           condition: {
+ *             expressionString: "STRING_VALUE", // required
+ *           },
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       ],
+ *       defaultBranch: {
+ *         nextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         response: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *       },
+ *     },
+ *     declinationNextStep: {
+ *       dialogAction: "<DialogState>",
+ *       intent: "<DialogState>",
+ *       sessionAttributes: "<DialogState>",
+ *     },
+ *     declinationConditional: {
+ *       active: true || false, // required
+ *       conditionalBranches: [ // required
+ *         {
+ *           name: "STRING_VALUE", // required
+ *           condition: {
+ *             expressionString: "STRING_VALUE", // required
+ *           },
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       ],
+ *       defaultBranch: {
+ *         nextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         response: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *       },
+ *     },
+ *     failureResponse: {
+ *       messageGroups: "<ResponseSpecification>",
+ *       allowInterrupt: "<ResponseSpecification>",
+ *     },
+ *     failureNextStep: {
+ *       dialogAction: "<DialogState>",
+ *       intent: "<DialogState>",
+ *       sessionAttributes: "<DialogState>",
+ *     },
+ *     failureConditional: {
+ *       active: true || false, // required
+ *       conditionalBranches: [ // required
+ *         {
+ *           name: "STRING_VALUE", // required
+ *           condition: {
+ *             expressionString: "STRING_VALUE", // required
+ *           },
+ *           nextStep: {
+ *             dialogAction: "<DialogState>",
+ *             intent: "<DialogState>",
+ *             sessionAttributes: "<DialogState>",
+ *           },
+ *           response: {
+ *             messageGroups: "<ResponseSpecification>",
+ *             allowInterrupt: "<ResponseSpecification>",
+ *           },
+ *         },
+ *       ],
+ *       defaultBranch: {
+ *         nextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         response: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *       },
+ *     },
+ *     codeHook: {
+ *       enableCodeHookInvocation: true || false, // required
+ *       active: true || false, // required
+ *       invocationLabel: "STRING_VALUE",
+ *       postCodeHookSpecification: {
+ *         successResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         successNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         successConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *         failureResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         failureNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         failureConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *         timeoutResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         timeoutNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         timeoutConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *       },
+ *     },
+ *     elicitationCodeHook: {
+ *       enableCodeHookInvocation: true || false, // required
+ *       invocationLabel: "STRING_VALUE",
+ *     },
+ *   },
+ *   intentClosingSetting: {
+ *     closingResponse: {
+ *       messageGroups: "<ResponseSpecification>",
+ *       allowInterrupt: "<ResponseSpecification>",
+ *     },
+ *     active: true || false,
+ *     nextStep: {
+ *       dialogAction: "<DialogState>",
+ *       intent: "<DialogState>",
+ *       sessionAttributes: "<DialogState>",
+ *     },
+ *     conditional: {
+ *       active: "<ConditionalSpecification>",
+ *       conditionalBranches: "<ConditionalSpecification>",
+ *       defaultBranch: "<ConditionalSpecification>",
+ *     },
+ *   },
+ *   inputContexts: [
+ *     {
+ *       name: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   outputContexts: [
+ *     {
+ *       name: "STRING_VALUE", // required
+ *       timeToLiveInSeconds: Number("int"), // required
+ *       turnsToLive: Number("int"), // required
+ *     },
+ *   ],
+ *   kendraConfiguration: {
+ *     kendraIndex: "STRING_VALUE", // required
+ *     queryFilterStringEnabled: true || false,
+ *     queryFilterString: "STRING_VALUE",
+ *   },
+ *   botId: "STRING_VALUE", // required
+ *   botVersion: "STRING_VALUE", // required
+ *   localeId: "STRING_VALUE", // required
+ *   initialResponseSetting: {
+ *     initialResponse: {
+ *       messageGroups: "<ResponseSpecification>",
+ *       allowInterrupt: "<ResponseSpecification>",
+ *     },
+ *     nextStep: {
+ *       dialogAction: "<DialogState>",
+ *       intent: "<DialogState>",
+ *       sessionAttributes: "<DialogState>",
+ *     },
+ *     conditional: {
+ *       active: "<ConditionalSpecification>",
+ *       conditionalBranches: "<ConditionalSpecification>",
+ *       defaultBranch: "<ConditionalSpecification>",
+ *     },
+ *     codeHook: {
+ *       enableCodeHookInvocation: true || false, // required
+ *       active: true || false, // required
+ *       invocationLabel: "STRING_VALUE",
+ *       postCodeHookSpecification: {
+ *         successResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         successNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         successConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *         failureResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         failureNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         failureConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *         timeoutResponse: {
+ *           messageGroups: "<ResponseSpecification>",
+ *           allowInterrupt: "<ResponseSpecification>",
+ *         },
+ *         timeoutNextStep: {
+ *           dialogAction: "<DialogState>",
+ *           intent: "<DialogState>",
+ *           sessionAttributes: "<DialogState>",
+ *         },
+ *         timeoutConditional: {
+ *           active: "<ConditionalSpecification>",
+ *           conditionalBranches: "<ConditionalSpecification>",
+ *           defaultBranch: "<ConditionalSpecification>",
+ *         },
+ *       },
+ *     },
+ *   },
+ * };
  * const command = new CreateIntentCommand(input);
  * const response = await client.send(command);
  * ```