1{ 2 "version": "2.0", 3 "service": "<fullname>Amazon Lex Build-Time Actions</fullname> <p> Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications. </p>", 4 "operations": { 5 "CreateBotVersion": "<p>Creates a new version of the bot based on the <code>$LATEST</code> version. If the <code>$LATEST</code> version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.</p> <note> <p>You can update only the <code>$LATEST</code> version of the bot. You can't update the numbered versions that you create with the <code>CreateBotVersion</code> operation.</p> </note> <p> When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see <a>versioning-intro</a>. </p> <p> This operation requires permission for the <code>lex:CreateBotVersion</code> action. </p>", 6 "CreateIntentVersion": "<p>Creates a new version of an intent based on the <code>$LATEST</code> version of the intent. If the <code>$LATEST</code> version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.</p> <note> <p>You can update only the <code>$LATEST</code> version of the intent. You can't update the numbered versions that you create with the <code>CreateIntentVersion</code> operation.</p> </note> <p> When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see <a>versioning-intro</a>. </p> <p>This operation requires permissions to perform the <code>lex:CreateIntentVersion</code> action. </p>", 7 "CreateSlotTypeVersion": "<p>Creates a new version of a slot type based on the <code>$LATEST</code> version of the specified slot type. If the <code>$LATEST</code> version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created. </p> <note> <p>You can update only the <code>$LATEST</code> version of a slot type. You can't update the numbered versions that you create with the <code>CreateSlotTypeVersion</code> operation.</p> </note> <p>When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see <a>versioning-intro</a>. </p> <p>This operation requires permissions for the <code>lex:CreateSlotTypeVersion</code> action.</p>", 8 "DeleteBot": "<p>Deletes all versions of the bot, including the <code>$LATEST</code> version. To delete a specific version of the bot, use the <a>DeleteBotVersion</a> operation. The <code>DeleteBot</code> operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later.</p> <p>Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the <a>DeleteUtterances</a> operation.</p> <p>If a bot has an alias, you can't delete it. Instead, the <code>DeleteBot</code> operation returns a <code>ResourceInUseException</code> exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the <code>DeleteBot</code> operation is successful.</p> <p>This operation requires permissions for the <code>lex:DeleteBot</code> action.</p>", 9 "DeleteBotAlias": "<p>Deletes an alias for the specified bot. </p> <p>You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the <code>DeleteBot</code> operation returns a <code>ResourceInUseException</code> exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the <code>DeleteBotAlias</code> operation is successful.</p>", 10 "DeleteBotChannelAssociation": "<p>Deletes the association between an Amazon Lex bot and a messaging platform.</p> <p>This operation requires permission for the <code>lex:DeleteBotChannelAssociation</code> action.</p>", 11 "DeleteBotVersion": "<p>Deletes a specific version of a bot. To delete all versions of a bot, use the <a>DeleteBot</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteBotVersion</code> action.</p>", 12 "DeleteIntent": "<p>Deletes all versions of the intent, including the <code>$LATEST</code> version. To delete a specific version of the intent, use the <a>DeleteIntentVersion</a> operation.</p> <p> You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see <a>how-it-works</a>), you must remove those references first. </p> <note> <p> If you get the <code>ResourceInUseException</code> exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to <code>DeleteIntent</code> is successful. </p> </note> <p> This operation requires permission for the <code>lex:DeleteIntent</code> action. </p>", 13 "DeleteIntentVersion": "<p>Deletes a specific version of an intent. To delete all versions of a intent, use the <a>DeleteIntent</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteIntentVersion</code> action.</p>", 14 "DeleteSlotType": "<p>Deletes all versions of the slot type, including the <code>$LATEST</code> version. To delete a specific version of the slot type, use the <a>DeleteSlotTypeVersion</a> operation.</p> <p> You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first. </p> <note> <p> If you get the <code>ResourceInUseException</code> exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the <code>DeleteSlotType</code> call is successful. </p> </note> <p>This operation requires permission for the <code>lex:DeleteSlotType</code> action.</p>", 15 "DeleteSlotTypeVersion": "<p>Deletes a specific version of a slot type. To delete all versions of a slot type, use the <a>DeleteSlotType</a> operation. </p> <p>This operation requires permissions for the <code>lex:DeleteSlotTypeVersion</code> action.</p>", 16 "DeleteUtterances": "<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteUtterances</code> operation to manually delete stored utterances for a specific user. When you use the <code>DeleteUtterances</code> operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the <code>GetUtterancesView</code> operation are deleted after 15 days.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>", 17 "GetBot": "<p>Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. </p> <p> This operation requires permissions for the <code>lex:GetBot</code> action. </p>", 18 "GetBotAlias": "<p>Returns information about an Amazon Lex bot alias. For more information about aliases, see <a>versioning-aliases</a>.</p> <p>This operation requires permissions for the <code>lex:GetBotAlias</code> action.</p>", 19 "GetBotAliases": "<p>Returns a list of aliases for a specified Amazon Lex bot.</p> <p>This operation requires permissions for the <code>lex:GetBotAliases</code> action.</p>", 20 "GetBotChannelAssociation": "<p>Returns information about the association between an Amazon Lex bot and a messaging platform.</p> <p>This operation requires permissions for the <code>lex:GetBotChannelAssociation</code> action.</p>", 21 "GetBotChannelAssociations": "<p> Returns a list of all of the channels associated with the specified bot. </p> <p>The <code>GetBotChannelAssociations</code> operation requires permissions for the <code>lex:GetBotChannelAssociations</code> action.</p>", 22 "GetBotVersions": "<p>Gets information about all of the versions of a bot.</p> <p>The <code>GetBotVersions</code> operation returns a <code>BotMetadata</code> object for each version of a bot. For example, if a bot has three numbered versions, the <code>GetBotVersions</code> operation returns four <code>BotMetadata</code> objects in the response, one for each numbered version and one for the <code>$LATEST</code> version. </p> <p>The <code>GetBotVersions</code> operation always returns at least one version, the <code>$LATEST</code> version.</p> <p>This operation requires permissions for the <code>lex:GetBotVersions</code> action.</p>", 23 "GetBots": "<p>Returns bot information as follows: </p> <ul> <li> <p>If you provide the <code>nameContains</code> field, the response includes information for the <code>$LATEST</code> version of all bots whose name contains the specified string.</p> </li> <li> <p>If you don't specify the <code>nameContains</code> field, the operation returns information about the <code>$LATEST</code> version of all of your bots.</p> </li> </ul> <p>This operation requires permission for the <code>lex:GetBots</code> action.</p>", 24 "GetBuiltinIntent": "<p>Returns information about a built-in intent.</p> <p>This operation requires permission for the <code>lex:GetBuiltinIntent</code> action.</p>", 25 "GetBuiltinIntents": "<p>Gets a list of built-in intents that meet the specified criteria.</p> <p>This operation requires permission for the <code>lex:GetBuiltinIntents</code> action.</p>", 26 "GetBuiltinSlotTypes": "<p>Gets a list of built-in slot types that meet the specified criteria.</p> <p>For a list of built-in slot types, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference\">Slot Type Reference</a> in the <i>Alexa Skills Kit</i>.</p> <p>This operation requires permission for the <code>lex:GetBuiltInSlotTypes</code> action.</p>", 27 "GetExport": "<p>Exports the contents of a Amazon Lex resource in a specified format. </p>", 28 "GetImport": "<p>Gets information about an import job started with the <code>StartImport</code> operation.</p>", 29 "GetIntent": "<p> Returns information about an intent. In addition to the intent name, you must specify the intent version. </p> <p> This operation requires permissions to perform the <code>lex:GetIntent</code> action. </p>", 30 "GetIntentVersions": "<p>Gets information about all of the versions of an intent.</p> <p>The <code>GetIntentVersions</code> operation returns an <code>IntentMetadata</code> object for each version of an intent. For example, if an intent has three numbered versions, the <code>GetIntentVersions</code> operation returns four <code>IntentMetadata</code> objects in the response, one for each numbered version and one for the <code>$LATEST</code> version. </p> <p>The <code>GetIntentVersions</code> operation always returns at least one version, the <code>$LATEST</code> version.</p> <p>This operation requires permissions for the <code>lex:GetIntentVersions</code> action.</p>", 31 "GetIntents": "<p>Returns intent information as follows: </p> <ul> <li> <p>If you specify the <code>nameContains</code> field, returns the <code>$LATEST</code> version of all intents that contain the specified string.</p> </li> <li> <p> If you don't specify the <code>nameContains</code> field, returns information about the <code>$LATEST</code> version of all intents. </p> </li> </ul> <p> The operation requires permission for the <code>lex:GetIntents</code> action. </p>", 32 "GetMigration": "<p>Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.</p>", 33 "GetMigrations": "<p>Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.</p>", 34 "GetSlotType": "<p>Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.</p> <p>This operation requires permissions for the <code>lex:GetSlotType</code> action.</p>", 35 "GetSlotTypeVersions": "<p>Gets information about all versions of a slot type.</p> <p>The <code>GetSlotTypeVersions</code> operation returns a <code>SlotTypeMetadata</code> object for each version of a slot type. For example, if a slot type has three numbered versions, the <code>GetSlotTypeVersions</code> operation returns four <code>SlotTypeMetadata</code> objects in the response, one for each numbered version and one for the <code>$LATEST</code> version. </p> <p>The <code>GetSlotTypeVersions</code> operation always returns at least one version, the <code>$LATEST</code> version.</p> <p>This operation requires permissions for the <code>lex:GetSlotTypeVersions</code> action.</p>", 36 "GetSlotTypes": "<p>Returns slot type information as follows: </p> <ul> <li> <p>If you specify the <code>nameContains</code> field, returns the <code>$LATEST</code> version of all slot types that contain the specified string.</p> </li> <li> <p> If you don't specify the <code>nameContains</code> field, returns information about the <code>$LATEST</code> version of all slot types. </p> </li> </ul> <p> The operation requires permission for the <code>lex:GetSlotTypes</code> action. </p>", 37 "GetUtterancesView": "<p>Use the <code>GetUtterancesView</code> operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.</p> <p>For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the <code>GetUtterancesView</code> operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the <code>OrderFlowers</code> intent so that your bot recognizes that utterance.</p> <p>After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. </p> <p>Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version.</p> <p>If you set <code>childDirected</code> field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available.</p> <p>This operation requires permissions for the <code>lex:GetUtterancesView</code> action.</p>", 38 "ListTagsForResource": "<p>Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.</p>", 39 "PutBot": "<p>Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the <code/> response <code>FAILED</code>. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see <a>how-it-works</a>. </p> <p>If you specify the name of an existing bot, the fields in the request replace the existing values in the <code>$LATEST</code> version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the <code>idleTTLInSeconds</code> and <code>privacySettings</code> fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.</p> <p>This operation requires permissions for the <code>lex:PutBot</code> action. For more information, see <a>security-iam</a>.</p>", 40 "PutBotAlias": "<p>Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see <a>versioning-aliases</a>.</p> <p>This operation requires permissions for the <code>lex:PutBotAlias</code> action. </p>", 41 "PutIntent": "<p>Creates an intent or replaces an existing intent.</p> <p>To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an <code>OrderPizza</code> intent. </p> <p>To create an intent or replace an existing intent, you must provide the following:</p> <ul> <li> <p>Intent name. For example, <code>OrderPizza</code>.</p> </li> <li> <p>Sample utterances. For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"</p> </li> <li> <p>Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.</p> </li> <li> <p>How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application. </p> </li> </ul> <p>You can specify other optional information in the request, such as:</p> <ul> <li> <p>A confirmation prompt to ask the user to confirm an intent. For example, \"Shall I order your pizza?\"</p> </li> <li> <p>A conclusion statement to send to the user after the intent has been fulfilled. For example, \"I placed your pizza order.\"</p> </li> <li> <p>A follow-up prompt that asks the user for additional activity. For example, asking \"Do you want to order a drink with your pizza?\"</p> </li> </ul> <p>If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the <code>$LATEST</code> version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the <code>$LATEST</code> version of an intent, the <code>status</code> field of any bot that uses the <code>$LATEST</code> version of the intent is set to <code>NOT_BUILT</code>.</p> <p>For more information, see <a>how-it-works</a>.</p> <p>This operation requires permissions for the <code>lex:PutIntent</code> action.</p>", 42 "PutSlotType": "<p>Creates a custom slot type or replaces an existing custom slot type.</p> <p>To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see <a>how-it-works</a>.</p> <p>If you specify the name of an existing slot type, the fields in the request replace the existing values in the <code>$LATEST</code> version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the <code>$LATEST</code> version of a slot type, if a bot uses the <code>$LATEST</code> version of an intent that contains the slot type, the bot's <code>status</code> field is set to <code>NOT_BUILT</code>.</p> <p>This operation requires permissions for the <code>lex:PutSlotType</code> action.</p>", 43 "StartImport": "<p>Starts a job to import a resource to Amazon Lex.</p>", 44 "StartMigration": "<p>Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/migrate.html\">Migrating a bot</a> in the <i>Amazon Lex developer guide</i>.</p>", 45 "TagResource": "<p>Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.</p>", 46 "UntagResource": "<p>Removes tags from a bot, bot alias or bot channel.</p>" 47 }, 48 "shapes": { 49 "AccessDeniedException": { 50 "base": "<p>Your IAM user or role does not have permission to call the Amazon Lex V2 APIs required to migrate your bot.</p>", 51 "refs": { 52 } 53 }, 54 "AliasName": { 55 "base": null, 56 "refs": { 57 "BotAliasMetadata$name": "<p>The name of the bot alias.</p>", 58 "BotChannelAssociation$botAlias": "<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made. </p>", 59 "DeleteBotAliasRequest$name": "<p>The name of the alias to delete. The name is case sensitive. </p>", 60 "DeleteBotChannelAssociationRequest$botAlias": "<p>An alias that points to the specific version of the Amazon Lex bot to which this association is being made.</p>", 61 "GetBotAliasRequest$name": "<p>The name of the bot alias. The name is case sensitive.</p>", 62 "GetBotAliasResponse$name": "<p>The name of the bot alias.</p>", 63 "GetBotAliasesRequest$nameContains": "<p>Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>", 64 "GetBotChannelAssociationRequest$botAlias": "<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.</p>", 65 "GetBotChannelAssociationResponse$botAlias": "<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.</p>", 66 "PutBotAliasRequest$name": "<p>The name of the alias. The name is <i>not</i> case sensitive.</p>", 67 "PutBotAliasResponse$name": "<p>The name of the alias.</p>" 68 } 69 }, 70 "AliasNameOrListAll": { 71 "base": null, 72 "refs": { 73 "GetBotChannelAssociationsRequest$botAlias": "<p>An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.</p>" 74 } 75 }, 76 "AmazonResourceName": { 77 "base": null, 78 "refs": { 79 "ListTagsForResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource to get a list of tags for.</p>", 80 "TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.</p>", 81 "UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource to remove the tags from.</p>" 82 } 83 }, 84 "BadRequestException": { 85 "base": "<p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.</p>", 86 "refs": { 87 } 88 }, 89 "Blob": { 90 "base": null, 91 "refs": { 92 "StartImportRequest$payload": "<p>A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the <code>resourceType</code> field.</p>" 93 } 94 }, 95 "Boolean": { 96 "base": null, 97 "refs": { 98 "CreateBotVersionResponse$childDirected": "<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.</p> <p>If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"https://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ.</a> </p>", 99 "CreateBotVersionResponse$enableModelImprovements": "<p>Indicates whether the bot uses accuracy improvements. <code>true</code> indicates that the bot is using the improvements, otherwise, <code>false</code>.</p>", 100 "CreateBotVersionResponse$detectSentiment": "<p>Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.</p>", 101 "GetBotResponse$enableModelImprovements": "<p>Indicates whether the bot uses accuracy improvements. <code>true</code> indicates that the bot is using the improvements, otherwise, <code>false</code>.</p>", 102 "GetBotResponse$childDirected": "<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.</p> <p>If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"https://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ.</a> </p>", 103 "GetBotResponse$detectSentiment": "<p>Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.</p>", 104 "PutBotRequest$enableModelImprovements": "<p>Set to <code>true</code> to enable access to natural language understanding improvements. </p> <p>When you set the <code>enableModelImprovements</code> parameter to <code>true</code> you can use the <code>nluIntentConfidenceThreshold</code> parameter to configure confidence scores. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/confidence-scores.html\">Confidence Scores</a>.</p> <p>You can only set the <code>enableModelImprovements</code> parameter in certain Regions. If you set the parameter to <code>true</code>, your bot has access to accuracy improvements.</p> <p>The Regions where you can set the <code>enableModelImprovements</code> parameter to <code>true</code> are:</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default. In these Regions setting the parameter to <code>false</code> throws a <code>ValidationException</code> exception.</p>", 105 "PutBotRequest$childDirected": "<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.</p> <p>If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"https://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ.</a> </p>", 106 "PutBotRequest$detectSentiment": "<p>When set to <code>true</code> user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify <code>detectSentiment</code>, the default is <code>false</code>.</p>", 107 "PutBotRequest$createVersion": "<p>When set to <code>true</code> a new numbered version of the bot is created. This is the same as calling the <code>CreateBotVersion</code> operation. If you don't specify <code>createVersion</code>, the default is <code>false</code>.</p>", 108 "PutBotResponse$enableModelImprovements": "<p>Indicates whether the bot uses accuracy improvements. <code>true</code> indicates that the bot is using the improvements, otherwise, <code>false</code>.</p>", 109 "PutBotResponse$childDirected": "<p>For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying <code>true</code> or <code>false</code> in the <code>childDirected</code> field. By specifying <code>true</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying <code>false</code> in the <code>childDirected</code> field, you confirm that your use of Amazon Lex <b>is not</b> related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the <code>childDirected</code> field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.</p> <p>If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the <a href=\"https://aws.amazon.com/lex/faqs#data-security\">Amazon Lex FAQ.</a> </p>", 110 "PutBotResponse$createVersion": "<p> <code>True</code> if a new version of the bot was created. If the <code>createVersion</code> field was not specified in the request, the <code>createVersion</code> field is set to false in the response.</p>", 111 "PutBotResponse$detectSentiment": "<p> <code>true</code> if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the <code>detectSentiment</code> field was not specified in the request, the <code>detectSentiment</code> field is <code>false</code> in the response.</p>", 112 "PutIntentRequest$createVersion": "<p>When set to <code>true</code> a new numbered version of the intent is created. This is the same as calling the <code>CreateIntentVersion</code> operation. If you do not specify <code>createVersion</code>, the default is <code>false</code>.</p>", 113 "PutIntentResponse$createVersion": "<p> <code>True</code> if a new version of the intent was created. If the <code>createVersion</code> field was not specified in the request, the <code>createVersion</code> field is set to false in the response.</p>", 114 "PutSlotTypeRequest$createVersion": "<p>When set to <code>true</code> a new numbered version of the slot type is created. This is the same as calling the <code>CreateSlotTypeVersion</code> operation. If you do not specify <code>createVersion</code>, the default is <code>false</code>.</p>", 115 "PutSlotTypeResponse$createVersion": "<p> <code>True</code> if a new version of the slot type was created. If the <code>createVersion</code> field was not specified in the request, the <code>createVersion</code> field is set to false in the response.</p>" 116 } 117 }, 118 "BotAliasMetadata": { 119 "base": "<p>Provides information about a bot alias.</p>", 120 "refs": { 121 "BotAliasMetadataList$member": null 122 } 123 }, 124 "BotAliasMetadataList": { 125 "base": null, 126 "refs": { 127 "GetBotAliasesResponse$BotAliases": "<p>An array of <code>BotAliasMetadata</code> objects, each describing a bot alias.</p>" 128 } 129 }, 130 "BotChannelAssociation": { 131 "base": "<p>Represents an association between an Amazon Lex bot and an external messaging platform.</p>", 132 "refs": { 133 "BotChannelAssociationList$member": null 134 } 135 }, 136 "BotChannelAssociationList": { 137 "base": null, 138 "refs": { 139 "GetBotChannelAssociationsResponse$botChannelAssociations": "<p>An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel. </p>" 140 } 141 }, 142 "BotChannelName": { 143 "base": null, 144 "refs": { 145 "BotChannelAssociation$name": "<p>The name of the association between the bot and the channel. </p>", 146 "DeleteBotChannelAssociationRequest$name": "<p>The name of the association. The name is case sensitive. </p>", 147 "GetBotChannelAssociationRequest$name": "<p>The name of the association between the bot and the channel. The name is case sensitive. </p>", 148 "GetBotChannelAssociationResponse$name": "<p>The name of the association between the bot and the channel.</p>", 149 "GetBotChannelAssociationsRequest$nameContains": "<p>Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\" To return all bot channel associations, use a hyphen (\"-\") as the <code>nameContains</code> parameter.</p>" 150 } 151 }, 152 "BotMetadata": { 153 "base": "<p>Provides information about a bot. .</p>", 154 "refs": { 155 "BotMetadataList$member": null 156 } 157 }, 158 "BotMetadataList": { 159 "base": null, 160 "refs": { 161 "GetBotVersionsResponse$bots": "<p>An array of <code>BotMetadata</code> objects, one for each numbered version of the bot plus one for the <code>$LATEST</code> version.</p>", 162 "GetBotsResponse$bots": "<p>An array of <code>botMetadata</code> objects, with one entry for each bot. </p>" 163 } 164 }, 165 "BotName": { 166 "base": null, 167 "refs": { 168 "BotAliasMetadata$botName": "<p>The name of the bot to which the alias points.</p>", 169 "BotChannelAssociation$botName": "<p>The name of the Amazon Lex bot to which this association is being made. </p> <note> <p>Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.</p> </note>", 170 "BotMetadata$name": "<p>The name of the bot. </p>", 171 "CreateBotVersionRequest$name": "<p>The name of the bot that you want to create a new version of. The name is case sensitive. </p>", 172 "CreateBotVersionResponse$name": "<p>The name of the bot.</p>", 173 "DeleteBotAliasRequest$botName": "<p>The name of the bot that the alias points to.</p>", 174 "DeleteBotChannelAssociationRequest$botName": "<p>The name of the Amazon Lex bot.</p>", 175 "DeleteBotRequest$name": "<p>The name of the bot. The name is case sensitive. </p>", 176 "DeleteBotVersionRequest$name": "<p>The name of the bot.</p>", 177 "DeleteUtterancesRequest$botName": "<p>The name of the bot that stored the utterances.</p>", 178 "GetBotAliasRequest$botName": "<p>The name of the bot.</p>", 179 "GetBotAliasResponse$botName": "<p>The name of the bot that the alias points to.</p>", 180 "GetBotAliasesRequest$botName": "<p>The name of the bot.</p>", 181 "GetBotChannelAssociationRequest$botName": "<p>The name of the Amazon Lex bot.</p>", 182 "GetBotChannelAssociationResponse$botName": "<p>The name of the Amazon Lex bot.</p>", 183 "GetBotChannelAssociationsRequest$botName": "<p>The name of the Amazon Lex bot in the association.</p>", 184 "GetBotRequest$name": "<p>The name of the bot. The name is case sensitive. </p>", 185 "GetBotResponse$name": "<p>The name of the bot.</p>", 186 "GetBotVersionsRequest$name": "<p>The name of the bot for which versions should be returned.</p>", 187 "GetBotsRequest$nameContains": "<p>Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>", 188 "GetMigrationResponse$v1BotName": "<p>The name of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>", 189 "GetMigrationsRequest$v1BotNameContains": "<p>Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.</p>", 190 "GetUtterancesViewRequest$botName": "<p>The name of the bot for which utterance information should be returned.</p>", 191 "GetUtterancesViewResponse$botName": "<p>The name of the bot for which utterance information was returned.</p>", 192 "MigrationSummary$v1BotName": "<p>The name of the Amazon Lex V1 bot that is the source of the migration.</p>", 193 "PutBotAliasRequest$botName": "<p>The name of the bot.</p>", 194 "PutBotAliasResponse$botName": "<p>The name of the bot that the alias points to.</p>", 195 "PutBotRequest$name": "<p>The name of the bot. The name is <i>not</i> case sensitive. </p>", 196 "PutBotResponse$name": "<p>The name of the bot.</p>", 197 "StartMigrationRequest$v1BotName": "<p>The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.</p>", 198 "StartMigrationResponse$v1BotName": "<p>The name of the Amazon Lex V1 bot that you are migrating to Amazon Lex V2.</p>" 199 } 200 }, 201 "BotVersions": { 202 "base": null, 203 "refs": { 204 "GetUtterancesViewRequest$botVersions": "<p>An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.</p>" 205 } 206 }, 207 "BuiltinIntentMetadata": { 208 "base": "<p>Provides metadata for a built-in intent.</p>", 209 "refs": { 210 "BuiltinIntentMetadataList$member": null 211 } 212 }, 213 "BuiltinIntentMetadataList": { 214 "base": null, 215 "refs": { 216 "GetBuiltinIntentsResponse$intents": "<p>An array of <code>builtinIntentMetadata</code> objects, one for each intent in the response.</p>" 217 } 218 }, 219 "BuiltinIntentSignature": { 220 "base": null, 221 "refs": { 222 "BuiltinIntentMetadata$signature": "<p>A unique identifier for the built-in intent. To find the signature for an intent, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>", 223 "CreateIntentVersionResponse$parentIntentSignature": "<p>A unique identifier for a built-in intent.</p>", 224 "GetBuiltinIntentRequest$signature": "<p>The unique identifier for a built-in intent. To find the signature for an intent, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>", 225 "GetBuiltinIntentResponse$signature": "<p>The unique identifier for a built-in intent.</p>", 226 "GetIntentResponse$parentIntentSignature": "<p>A unique identifier for a built-in intent.</p>", 227 "PutIntentRequest$parentIntentSignature": "<p>A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>", 228 "PutIntentResponse$parentIntentSignature": "<p>A unique identifier for the built-in intent that this intent is based on.</p>" 229 } 230 }, 231 "BuiltinIntentSlot": { 232 "base": "<p>Provides information about a slot used in a built-in intent.</p>", 233 "refs": { 234 "BuiltinIntentSlotList$member": null 235 } 236 }, 237 "BuiltinIntentSlotList": { 238 "base": null, 239 "refs": { 240 "GetBuiltinIntentResponse$slots": "<p>An array of <code>BuiltinIntentSlot</code> objects, one entry for each slot type in the intent.</p>" 241 } 242 }, 243 "BuiltinSlotTypeMetadata": { 244 "base": "<p>Provides information about a built in slot type.</p>", 245 "refs": { 246 "BuiltinSlotTypeMetadataList$member": null 247 } 248 }, 249 "BuiltinSlotTypeMetadataList": { 250 "base": null, 251 "refs": { 252 "GetBuiltinSlotTypesResponse$slotTypes": "<p>An array of <code>BuiltInSlotTypeMetadata</code> objects, one entry for each slot type returned.</p>" 253 } 254 }, 255 "BuiltinSlotTypeSignature": { 256 "base": null, 257 "refs": { 258 "BuiltinSlotTypeMetadata$signature": "<p>A unique identifier for the built-in slot type. To find the signature for a slot type, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference\">Slot Type Reference</a> in the <i>Alexa Skills Kit</i>.</p>" 259 } 260 }, 261 "ChannelConfigurationMap": { 262 "base": null, 263 "refs": { 264 "BotChannelAssociation$botConfiguration": "<p>Provides information necessary to communicate with the messaging platform. </p>", 265 "GetBotChannelAssociationResponse$botConfiguration": "<p>Provides information that the messaging platform needs to communicate with the Amazon Lex bot.</p>" 266 } 267 }, 268 "ChannelStatus": { 269 "base": null, 270 "refs": { 271 "BotChannelAssociation$status": "<p>The status of the bot channel. </p> <ul> <li> <p> <code>CREATED</code> - The channel has been created and is ready for use.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Channel creation is in progress.</p> </li> <li> <p> <code>FAILED</code> - There was an error creating the channel. For information about the reason for the failure, see the <code>failureReason</code> field.</p> </li> </ul>", 272 "GetBotChannelAssociationResponse$status": "<p>The status of the bot channel. </p> <ul> <li> <p> <code>CREATED</code> - The channel has been created and is ready for use.</p> </li> <li> <p> <code>IN_PROGRESS</code> - Channel creation is in progress.</p> </li> <li> <p> <code>FAILED</code> - There was an error creating the channel. For information about the reason for the failure, see the <code>failureReason</code> field.</p> </li> </ul>" 273 } 274 }, 275 "ChannelType": { 276 "base": null, 277 "refs": { 278 "BotChannelAssociation$type": "<p>Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.</p>", 279 "GetBotChannelAssociationResponse$type": "<p>The type of the messaging platform.</p>" 280 } 281 }, 282 "CodeHook": { 283 "base": "<p>Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..</p>", 284 "refs": { 285 "CreateIntentVersionResponse$dialogCodeHook": "<p>If defined, Amazon Lex invokes this Lambda function for each user input.</p>", 286 "FulfillmentActivity$codeHook": "<p> A description of the Lambda function that is run to fulfill the intent. </p>", 287 "GetIntentResponse$dialogCodeHook": "<p>If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see <a>PutIntent</a>. </p>", 288 "PutIntentRequest$dialogCodeHook": "<p> Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction. </p> <p>For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, <code>GlutenIntolerant</code>, to true. You might find John's phone number and set the corresponding session attribute. </p>", 289 "PutIntentResponse$dialogCodeHook": "<p>If defined in the intent, Amazon Lex invokes this Lambda function for each user input.</p>" 290 } 291 }, 292 "ConfidenceThreshold": { 293 "base": null, 294 "refs": { 295 "GetBotResponse$nluIntentConfidenceThreshold": "<p>The score that determines where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> response. <code>AMAZON.FallbackIntent</code> is inserted if the confidence score for all intents is below this value. <code>AMAZON.KendraSearchIntent</code> is only inserted if it is configured for the bot.</p>", 296 "PutBotRequest$nluIntentConfidenceThreshold": "<p>Determines the threshold where Amazon Lex will insert the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> response. <code>AMAZON.FallbackIntent</code> and <code>AMAZON.KendraSearchIntent</code> are only inserted if they are configured for the bot.</p> <p>You must set the <code>enableModelImprovements</code> parameter to <code>true</code> to use confidence scores in the following regions.</p> <ul> <li> <p>US East (N. Virginia) (us-east-1)</p> </li> <li> <p>US West (Oregon) (us-west-2)</p> </li> <li> <p>Asia Pacific (Sydney) (ap-southeast-2)</p> </li> <li> <p>EU (Ireland) (eu-west-1)</p> </li> </ul> <p>In other Regions, the <code>enableModelImprovements</code> parameter is set to <code>true</code> by default.</p> <p>For example, suppose a bot is configured with the confidence threshold of 0.80 and the <code>AMAZON.FallbackIntent</code>. Amazon Lex returns three alternative intents with the following confidence scores: IntentA (0.70), IntentB (0.60), IntentC (0.50). The response from the <code>PostText</code> operation would be:</p> <ul> <li> <p>AMAZON.FallbackIntent</p> </li> <li> <p>IntentA</p> </li> <li> <p>IntentB</p> </li> <li> <p>IntentC</p> </li> </ul>", 297 "PutBotResponse$nluIntentConfidenceThreshold": "<p>The score that determines where Amazon Lex inserts the <code>AMAZON.FallbackIntent</code>, <code>AMAZON.KendraSearchIntent</code>, or both when returning alternative intents in a <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"https://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> response. <code>AMAZON.FallbackIntent</code> is inserted if the confidence score for all intents is below this value. <code>AMAZON.KendraSearchIntent</code> is only inserted if it is configured for the bot.</p>" 298 } 299 }, 300 "ConflictException": { 301 "base": "<p> There was a conflict processing the request. Try your request again. </p>", 302 "refs": { 303 } 304 }, 305 "ContentString": { 306 "base": null, 307 "refs": { 308 "Message$content": "<p>The text of the message.</p>" 309 } 310 }, 311 "ContentType": { 312 "base": null, 313 "refs": { 314 "Message$contentType": "<p>The content type of the message string.</p>" 315 } 316 }, 317 "ContextTimeToLiveInSeconds": { 318 "base": null, 319 "refs": { 320 "OutputContext$timeToLiveInSeconds": "<p>The number of seconds that the context should be active after it is first sent in a <code>PostContent</code> or <code>PostText</code> response. You can set the value between 5 and 86,400 seconds (24 hours).</p>" 321 } 322 }, 323 "ContextTurnsToLive": { 324 "base": null, 325 "refs": { 326 "OutputContext$turnsToLive": "<p>The number of conversation turns that the context should be active. A conversation turn is one <code>PostContent</code> or <code>PostText</code> request and the corresponding response from Amazon Lex.</p>" 327 } 328 }, 329 "ConversationLogsRequest": { 330 "base": "<p>Provides the settings needed for conversation logs.</p>", 331 "refs": { 332 "PutBotAliasRequest$conversationLogs": "<p>Settings for conversation logs for the alias.</p>" 333 } 334 }, 335 "ConversationLogsResponse": { 336 "base": "<p>Contains information about conversation log settings.</p>", 337 "refs": { 338 "BotAliasMetadata$conversationLogs": "<p>Settings that determine how Amazon Lex uses conversation logs for the alias.</p>", 339 "GetBotAliasResponse$conversationLogs": "<p>The settings that determine how Amazon Lex uses conversation logs for the alias.</p>", 340 "PutBotAliasResponse$conversationLogs": "<p>The settings that determine how Amazon Lex uses conversation logs for the alias.</p>" 341 } 342 }, 343 "Count": { 344 "base": null, 345 "refs": { 346 "UtteranceData$count": "<p>The number of times that the utterance was processed.</p>", 347 "UtteranceData$distinctUsers": "<p>The total number of individuals that used the utterance.</p>" 348 } 349 }, 350 "CreateBotVersionRequest": { 351 "base": null, 352 "refs": { 353 } 354 }, 355 "CreateBotVersionResponse": { 356 "base": null, 357 "refs": { 358 } 359 }, 360 "CreateIntentVersionRequest": { 361 "base": null, 362 "refs": { 363 } 364 }, 365 "CreateIntentVersionResponse": { 366 "base": null, 367 "refs": { 368 } 369 }, 370 "CreateSlotTypeVersionRequest": { 371 "base": null, 372 "refs": { 373 } 374 }, 375 "CreateSlotTypeVersionResponse": { 376 "base": null, 377 "refs": { 378 } 379 }, 380 "CustomOrBuiltinSlotTypeName": { 381 "base": null, 382 "refs": { 383 "CreateSlotTypeVersionResponse$parentSlotTypeSignature": "<p>The built-in slot type used a the parent of the slot type.</p>", 384 "GetSlotTypeResponse$parentSlotTypeSignature": "<p>The built-in slot type used as a parent for the slot type.</p>", 385 "PutSlotTypeRequest$parentSlotTypeSignature": "<p>The built-in slot type used as the parent of the slot type. When you define a parent slot type, the new slot type has all of the same configuration as the parent.</p> <p>Only <code>AMAZON.AlphaNumeric</code> is supported.</p>", 386 "PutSlotTypeResponse$parentSlotTypeSignature": "<p>The built-in slot type used as the parent of the slot type.</p>", 387 "Slot$slotType": "<p>The type of the slot, either a custom slot type that you defined or one of the built-in slot types.</p>" 388 } 389 }, 390 "DeleteBotAliasRequest": { 391 "base": null, 392 "refs": { 393 } 394 }, 395 "DeleteBotChannelAssociationRequest": { 396 "base": null, 397 "refs": { 398 } 399 }, 400 "DeleteBotRequest": { 401 "base": null, 402 "refs": { 403 } 404 }, 405 "DeleteBotVersionRequest": { 406 "base": null, 407 "refs": { 408 } 409 }, 410 "DeleteIntentRequest": { 411 "base": null, 412 "refs": { 413 } 414 }, 415 "DeleteIntentVersionRequest": { 416 "base": null, 417 "refs": { 418 } 419 }, 420 "DeleteSlotTypeRequest": { 421 "base": null, 422 "refs": { 423 } 424 }, 425 "DeleteSlotTypeVersionRequest": { 426 "base": null, 427 "refs": { 428 } 429 }, 430 "DeleteUtterancesRequest": { 431 "base": null, 432 "refs": { 433 } 434 }, 435 "Description": { 436 "base": null, 437 "refs": { 438 "BotAliasMetadata$description": "<p>A description of the bot alias.</p>", 439 "BotChannelAssociation$description": "<p>A text description of the association you are creating. </p>", 440 "BotMetadata$description": "<p>A description of the bot.</p>", 441 "CreateBotVersionResponse$description": "<p>A description of the bot.</p>", 442 "CreateIntentVersionResponse$description": "<p>A description of the intent.</p>", 443 "CreateSlotTypeVersionResponse$description": "<p>A description of the slot type.</p>", 444 "GetBotAliasResponse$description": "<p>A description of the bot alias.</p>", 445 "GetBotChannelAssociationResponse$description": "<p>A description of the association between the bot and the channel.</p>", 446 "GetBotResponse$description": "<p>A description of the bot.</p>", 447 "GetIntentResponse$description": "<p>A description of the intent.</p>", 448 "GetSlotTypeResponse$description": "<p>A description of the slot type.</p>", 449 "IntentMetadata$description": "<p>A description of the intent.</p>", 450 "PutBotAliasRequest$description": "<p>A description of the alias.</p>", 451 "PutBotAliasResponse$description": "<p>A description of the alias.</p>", 452 "PutBotRequest$description": "<p>A description of the bot.</p>", 453 "PutBotResponse$description": "<p>A description of the bot.</p>", 454 "PutIntentRequest$description": "<p>A description of the intent.</p>", 455 "PutIntentResponse$description": "<p>A description of the intent.</p>", 456 "PutSlotTypeRequest$description": "<p>A description of the slot type.</p>", 457 "PutSlotTypeResponse$description": "<p>A description of the slot type.</p>", 458 "Slot$description": "<p>A description of the slot.</p>", 459 "SlotTypeMetadata$description": "<p>A description of the slot type.</p>" 460 } 461 }, 462 "Destination": { 463 "base": null, 464 "refs": { 465 "LogSettingsRequest$destination": "<p>Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.</p>", 466 "LogSettingsResponse$destination": "<p>The destination where logs are delivered.</p>" 467 } 468 }, 469 "EnumerationValue": { 470 "base": "<p>Each slot type can have a set of values. Each enumeration value represents a value the slot type can take. </p> <p>For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values </p> <ul> <li> <p>thick</p> </li> <li> <p>thin</p> </li> <li> <p>stuffed</p> </li> </ul>", 471 "refs": { 472 "EnumerationValues$member": null 473 } 474 }, 475 "EnumerationValues": { 476 "base": null, 477 "refs": { 478 "CreateSlotTypeVersionResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>", 479 "GetSlotTypeResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>", 480 "PutSlotTypeRequest$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take. Each value can have a list of <code>synonyms</code>, which are additional values that help train the machine learning model about the values that it resolves for a slot. </p> <p>A regular expression slot type doesn't require enumeration values. All other slot types require a list of enumeration values.</p> <p>When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The <code>valueSelectionStrategy</code> field indicates the option to use. </p>", 481 "PutSlotTypeResponse$enumerationValues": "<p>A list of <code>EnumerationValue</code> objects that defines the values that the slot type can take.</p>" 482 } 483 }, 484 "ExportStatus": { 485 "base": null, 486 "refs": { 487 "GetExportResponse$exportStatus": "<p>The status of the export. </p> <ul> <li> <p> <code>IN_PROGRESS</code> - The export is in progress.</p> </li> <li> <p> <code>READY</code> - The export is complete.</p> </li> <li> <p> <code>FAILED</code> - The export could not be completed.</p> </li> </ul>" 488 } 489 }, 490 "ExportType": { 491 "base": null, 492 "refs": { 493 "GetExportRequest$exportType": "<p>The format of the exported data.</p>", 494 "GetExportResponse$exportType": "<p>The format of the exported data.</p>" 495 } 496 }, 497 "FollowUpPrompt": { 498 "base": "<p>A prompt for additional activity after an intent is fulfilled. For example, after the <code>OrderPizza</code> intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.</p>", 499 "refs": { 500 "CreateIntentVersionResponse$followUpPrompt": "<p>If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. </p>", 501 "GetIntentResponse$followUpPrompt": "<p>If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see <a>PutIntent</a>.</p>", 502 "PutIntentRequest$followUpPrompt": "<p>Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the <code>OrderPizza</code> intent is fulfilled, you might prompt the user to order a drink.</p> <p>The action that Amazon Lex takes depends on the user's response, as follows:</p> <ul> <li> <p>If the user says \"Yes\" it responds with the clarification prompt that is configured for the bot.</p> </li> <li> <p>if the user says \"Yes\" and continues with an utterance that triggers an intent it starts a conversation for the intent.</p> </li> <li> <p>If the user says \"No\" it responds with the rejection statement configured for the the follow-up prompt.</p> </li> <li> <p>If it doesn't recognize the utterance it repeats the follow-up prompt again.</p> </li> </ul> <p>The <code>followUpPrompt</code> field and the <code>conclusionStatement</code> field are mutually exclusive. You can specify only one. </p>", 503 "PutIntentResponse$followUpPrompt": "<p>If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.</p>" 504 } 505 }, 506 "FulfillmentActivity": { 507 "base": "<p> Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application. </p> <p>Consider the following examples:</p> <ul> <li> <p>In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria. </p> </li> <li> <p>In a gaming application, when a user says \"pick up a rock,\" this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client. </p> </li> </ul>", 508 "refs": { 509 "CreateIntentVersionResponse$fulfillmentActivity": "<p> Describes how the intent is fulfilled. </p>", 510 "GetIntentResponse$fulfillmentActivity": "<p>Describes how the intent is fulfilled. For more information, see <a>PutIntent</a>. </p>", 511 "PutIntentRequest$fulfillmentActivity": "<p>Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, <code>fulfillmentActivity</code> defines how the bot places an order with a local pizza store. </p> <p> You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria). </p>", 512 "PutIntentResponse$fulfillmentActivity": "<p>If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.</p>" 513 } 514 }, 515 "FulfillmentActivityType": { 516 "base": null, 517 "refs": { 518 "FulfillmentActivity$type": "<p> How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application. </p>" 519 } 520 }, 521 "GetBotAliasRequest": { 522 "base": null, 523 "refs": { 524 } 525 }, 526 "GetBotAliasResponse": { 527 "base": null, 528 "refs": { 529 } 530 }, 531 "GetBotAliasesRequest": { 532 "base": null, 533 "refs": { 534 } 535 }, 536 "GetBotAliasesResponse": { 537 "base": null, 538 "refs": { 539 } 540 }, 541 "GetBotChannelAssociationRequest": { 542 "base": null, 543 "refs": { 544 } 545 }, 546 "GetBotChannelAssociationResponse": { 547 "base": null, 548 "refs": { 549 } 550 }, 551 "GetBotChannelAssociationsRequest": { 552 "base": null, 553 "refs": { 554 } 555 }, 556 "GetBotChannelAssociationsResponse": { 557 "base": null, 558 "refs": { 559 } 560 }, 561 "GetBotRequest": { 562 "base": null, 563 "refs": { 564 } 565 }, 566 "GetBotResponse": { 567 "base": null, 568 "refs": { 569 } 570 }, 571 "GetBotVersionsRequest": { 572 "base": null, 573 "refs": { 574 } 575 }, 576 "GetBotVersionsResponse": { 577 "base": null, 578 "refs": { 579 } 580 }, 581 "GetBotsRequest": { 582 "base": null, 583 "refs": { 584 } 585 }, 586 "GetBotsResponse": { 587 "base": null, 588 "refs": { 589 } 590 }, 591 "GetBuiltinIntentRequest": { 592 "base": null, 593 "refs": { 594 } 595 }, 596 "GetBuiltinIntentResponse": { 597 "base": null, 598 "refs": { 599 } 600 }, 601 "GetBuiltinIntentsRequest": { 602 "base": null, 603 "refs": { 604 } 605 }, 606 "GetBuiltinIntentsResponse": { 607 "base": null, 608 "refs": { 609 } 610 }, 611 "GetBuiltinSlotTypesRequest": { 612 "base": null, 613 "refs": { 614 } 615 }, 616 "GetBuiltinSlotTypesResponse": { 617 "base": null, 618 "refs": { 619 } 620 }, 621 "GetExportRequest": { 622 "base": null, 623 "refs": { 624 } 625 }, 626 "GetExportResponse": { 627 "base": null, 628 "refs": { 629 } 630 }, 631 "GetImportRequest": { 632 "base": null, 633 "refs": { 634 } 635 }, 636 "GetImportResponse": { 637 "base": null, 638 "refs": { 639 } 640 }, 641 "GetIntentRequest": { 642 "base": null, 643 "refs": { 644 } 645 }, 646 "GetIntentResponse": { 647 "base": null, 648 "refs": { 649 } 650 }, 651 "GetIntentVersionsRequest": { 652 "base": null, 653 "refs": { 654 } 655 }, 656 "GetIntentVersionsResponse": { 657 "base": null, 658 "refs": { 659 } 660 }, 661 "GetIntentsRequest": { 662 "base": null, 663 "refs": { 664 } 665 }, 666 "GetIntentsResponse": { 667 "base": null, 668 "refs": { 669 } 670 }, 671 "GetMigrationRequest": { 672 "base": null, 673 "refs": { 674 } 675 }, 676 "GetMigrationResponse": { 677 "base": null, 678 "refs": { 679 } 680 }, 681 "GetMigrationsRequest": { 682 "base": null, 683 "refs": { 684 } 685 }, 686 "GetMigrationsResponse": { 687 "base": null, 688 "refs": { 689 } 690 }, 691 "GetSlotTypeRequest": { 692 "base": null, 693 "refs": { 694 } 695 }, 696 "GetSlotTypeResponse": { 697 "base": null, 698 "refs": { 699 } 700 }, 701 "GetSlotTypeVersionsRequest": { 702 "base": null, 703 "refs": { 704 } 705 }, 706 "GetSlotTypeVersionsResponse": { 707 "base": null, 708 "refs": { 709 } 710 }, 711 "GetSlotTypesRequest": { 712 "base": null, 713 "refs": { 714 } 715 }, 716 "GetSlotTypesResponse": { 717 "base": null, 718 "refs": { 719 } 720 }, 721 "GetUtterancesViewRequest": { 722 "base": null, 723 "refs": { 724 } 725 }, 726 "GetUtterancesViewResponse": { 727 "base": null, 728 "refs": { 729 } 730 }, 731 "GroupNumber": { 732 "base": null, 733 "refs": { 734 "Message$groupNumber": "<p>Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.</p>" 735 } 736 }, 737 "IamRoleArn": { 738 "base": null, 739 "refs": { 740 "ConversationLogsRequest$iamRoleArn": "<p>The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the AWS KMS key used for encrypting audio logs. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/conversation-logs-role-and-policy.html\">Creating an IAM Role and Policy for Conversation Logs</a>.</p>", 741 "ConversationLogsResponse$iamRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.</p>", 742 "GetMigrationResponse$v2BotRole": "<p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>", 743 "MigrationSummary$v2BotRole": "<p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>", 744 "StartMigrationRequest$v2BotRole": "<p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>", 745 "StartMigrationResponse$v2BotRole": "<p>The IAM role that Amazon Lex uses to run the Amazon Lex V2 bot.</p>" 746 } 747 }, 748 "ImportStatus": { 749 "base": null, 750 "refs": { 751 "GetImportResponse$importStatus": "<p>The status of the import job. If the status is <code>FAILED</code>, you can get the reason for the failure from the <code>failureReason</code> field.</p>", 752 "StartImportResponse$importStatus": "<p>The status of the import job. If the status is <code>FAILED</code>, you can get the reason for the failure using the <code>GetImport</code> operation.</p>" 753 } 754 }, 755 "InputContext": { 756 "base": "<p>The name of a context that must be active for an intent to be selected by Amazon Lex.</p>", 757 "refs": { 758 "InputContextList$member": null 759 } 760 }, 761 "InputContextList": { 762 "base": null, 763 "refs": { 764 "CreateIntentVersionResponse$inputContexts": "<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>", 765 "GetIntentResponse$inputContexts": "<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>", 766 "PutIntentRequest$inputContexts": "<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>", 767 "PutIntentResponse$inputContexts": "<p>An array of <code>InputContext</code> objects that lists the contexts that must be active for Amazon Lex to choose the intent in a conversation with the user.</p>" 768 } 769 }, 770 "InputContextName": { 771 "base": null, 772 "refs": { 773 "InputContext$name": "<p>The name of the context.</p>" 774 } 775 }, 776 "Intent": { 777 "base": "<p>Identifies the specific version of an intent.</p>", 778 "refs": { 779 "IntentList$member": null 780 } 781 }, 782 "IntentList": { 783 "base": null, 784 "refs": { 785 "CreateBotVersionResponse$intents": "<p>An array of <code>Intent</code> objects. For more information, see <a>PutBot</a>.</p>", 786 "GetBotResponse$intents": "<p>An array of <code>intent</code> objects. For more information, see <a>PutBot</a>.</p>", 787 "PutBotRequest$intents": "<p>An array of <code>Intent</code> objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see <a>how-it-works</a>.</p>", 788 "PutBotResponse$intents": "<p>An array of <code>Intent</code> objects. For more information, see <a>PutBot</a>.</p>" 789 } 790 }, 791 "IntentMetadata": { 792 "base": "<p>Provides information about an intent.</p>", 793 "refs": { 794 "IntentMetadataList$member": null 795 } 796 }, 797 "IntentMetadataList": { 798 "base": null, 799 "refs": { 800 "GetIntentVersionsResponse$intents": "<p>An array of <code>IntentMetadata</code> objects, one for each numbered version of the intent plus one for the <code>$LATEST</code> version.</p>", 801 "GetIntentsResponse$intents": "<p>An array of <code>Intent</code> objects. For more information, see <a>PutBot</a>.</p>" 802 } 803 }, 804 "IntentName": { 805 "base": null, 806 "refs": { 807 "CreateIntentVersionRequest$name": "<p>The name of the intent that you want to create a new version of. The name is case sensitive. </p>", 808 "CreateIntentVersionResponse$name": "<p>The name of the intent.</p>", 809 "DeleteIntentRequest$name": "<p>The name of the intent. The name is case sensitive. </p>", 810 "DeleteIntentVersionRequest$name": "<p>The name of the intent.</p>", 811 "GetIntentRequest$name": "<p>The name of the intent. The name is case sensitive. </p>", 812 "GetIntentResponse$name": "<p>The name of the intent.</p>", 813 "GetIntentVersionsRequest$name": "<p>The name of the intent for which versions should be returned.</p>", 814 "GetIntentsRequest$nameContains": "<p>Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>", 815 "Intent$intentName": "<p>The name of the intent.</p>", 816 "IntentMetadata$name": "<p>The name of the intent.</p>", 817 "PutIntentRequest$name": "<p>The name of the intent. The name is <i>not</i> case sensitive. </p> <p>The name can't match a built-in intent name, or a built-in intent name with \"AMAZON.\" removed. For example, because there is a built-in intent called <code>AMAZON.HelpIntent</code>, you can't create a custom intent called <code>HelpIntent</code>.</p> <p>For a list of built-in intents, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>", 818 "PutIntentResponse$name": "<p>The name of the intent.</p>" 819 } 820 }, 821 "IntentUtteranceList": { 822 "base": null, 823 "refs": { 824 "CreateIntentVersionResponse$sampleUtterances": "<p>An array of sample utterances configured for the intent. </p>", 825 "GetIntentResponse$sampleUtterances": "<p>An array of sample utterances configured for the intent.</p>", 826 "PutIntentRequest$sampleUtterances": "<p>An array of utterances (strings) that a user might say to signal the intent. For example, \"I want {PizzaSize} pizza\", \"Order {Quantity} {PizzaSize} pizzas\". </p> <p>In each utterance, a slot name is enclosed in curly braces. </p>", 827 "PutIntentResponse$sampleUtterances": "<p> An array of sample utterances that are configured for the intent. </p>" 828 } 829 }, 830 "InternalFailureException": { 831 "base": "<p>An internal Amazon Lex error occurred. Try your request again.</p>", 832 "refs": { 833 } 834 }, 835 "KendraConfiguration": { 836 "base": "<p>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. For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html\"> AMAZON.KendraSearchIntent</a>.</p>", 837 "refs": { 838 "CreateIntentVersionResponse$kendraConfiguration": "<p>Configuration information, if any, for connecting an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>", 839 "GetIntentResponse$kendraConfiguration": "<p>Configuration information, if any, to connect to an Amazon Kendra index with the <code>AMAZON.KendraSearchIntent</code> intent.</p>", 840 "PutIntentRequest$kendraConfiguration": "<p>Configuration information required to use the <code>AMAZON.KendraSearchIntent</code> intent to connect to an Amazon Kendra index. For more information, see <a href=\"http://docs.aws.amazon.com/lex/latest/dg/built-in-intent-kendra-search.html\"> AMAZON.KendraSearchIntent</a>.</p>", 841 "PutIntentResponse$kendraConfiguration": "<p>Configuration information, if any, required to connect to an Amazon Kendra index and use the <code>AMAZON.KendraSearchIntent</code> intent.</p>" 842 } 843 }, 844 "KendraIndexArn": { 845 "base": null, 846 "refs": { 847 "KendraConfiguration$kendraIndex": "<p>The Amazon Resource Name (ARN) of the Amazon Kendra index that you want the AMAZON.KendraSearchIntent intent to search. The index must be in the same account and Region as the Amazon Lex bot. If the Amazon Kendra index does not exist, you get an exception when you call the <code>PutIntent</code> operation.</p>" 848 } 849 }, 850 "KmsKeyArn": { 851 "base": null, 852 "refs": { 853 "LogSettingsRequest$kmsKeyArn": "<p>The Amazon Resource Name (ARN) of the AWS KMS customer managed key for encrypting audio logs delivered to an S3 bucket. The key does not apply to CloudWatch Logs and is optional for S3 buckets.</p>", 854 "LogSettingsResponse$kmsKeyArn": "<p>The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.</p>" 855 } 856 }, 857 "LambdaARN": { 858 "base": null, 859 "refs": { 860 "CodeHook$uri": "<p>The Amazon Resource Name (ARN) of the Lambda function.</p>" 861 } 862 }, 863 "LimitExceededException": { 864 "base": "<p>The request exceeded a limit. Try your request again.</p>", 865 "refs": { 866 } 867 }, 868 "ListOfUtterance": { 869 "base": null, 870 "refs": { 871 "UtteranceList$utterances": "<p>One or more <a>UtteranceData</a> objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.</p>" 872 } 873 }, 874 "ListTagsForResourceRequest": { 875 "base": null, 876 "refs": { 877 } 878 }, 879 "ListTagsForResourceResponse": { 880 "base": null, 881 "refs": { 882 } 883 }, 884 "ListsOfUtterances": { 885 "base": null, 886 "refs": { 887 "GetUtterancesViewResponse$utterances": "<p>An array of <a>UtteranceList</a> objects, each containing a list of <a>UtteranceData</a> objects describing the utterances that were processed by your bot. The response contains a maximum of 100 <code>UtteranceData</code> objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days.</p>" 888 } 889 }, 890 "Locale": { 891 "base": null, 892 "refs": { 893 "CreateBotVersionResponse$locale": "<p> Specifies the target locale for the bot. </p>", 894 "GetBotResponse$locale": "<p> The target locale for the bot. </p>", 895 "GetBuiltinIntentsRequest$locale": "<p>A list of locales that the intent supports.</p>", 896 "GetBuiltinSlotTypesRequest$locale": "<p>A list of locales that the slot type supports.</p>", 897 "GetMigrationResponse$v1BotLocale": "<p>The locale of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>", 898 "LocaleList$member": null, 899 "MigrationSummary$v1BotLocale": "<p>The locale of the Amazon Lex V1 bot that is the source of the migration.</p>", 900 "PutBotRequest$locale": "<p> Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. </p> <p>The default is <code>en-US</code>.</p>", 901 "PutBotResponse$locale": "<p> The target locale for the bot. </p>", 902 "StartMigrationResponse$v1BotLocale": "<p>The locale used for the Amazon Lex V1 bot. </p>" 903 } 904 }, 905 "LocaleList": { 906 "base": null, 907 "refs": { 908 "BuiltinIntentMetadata$supportedLocales": "<p>A list of identifiers for the locales that the intent supports.</p>", 909 "BuiltinSlotTypeMetadata$supportedLocales": "<p>A list of target locales for the slot. </p>", 910 "GetBuiltinIntentResponse$supportedLocales": "<p>A list of locales that the intent supports.</p>" 911 } 912 }, 913 "LogSettingsRequest": { 914 "base": "<p>Settings used to configure delivery mode and destination for conversation logs.</p>", 915 "refs": { 916 "LogSettingsRequestList$member": null 917 } 918 }, 919 "LogSettingsRequestList": { 920 "base": null, 921 "refs": { 922 "ConversationLogsRequest$logSettings": "<p>The settings for your conversation logs. You can log the conversation text, conversation audio, or both.</p>" 923 } 924 }, 925 "LogSettingsResponse": { 926 "base": "<p>The settings for conversation logs.</p>", 927 "refs": { 928 "LogSettingsResponseList$member": null 929 } 930 }, 931 "LogSettingsResponseList": { 932 "base": null, 933 "refs": { 934 "ConversationLogsResponse$logSettings": "<p>The settings for your conversation logs. You can log text, audio, or both.</p>" 935 } 936 }, 937 "LogType": { 938 "base": null, 939 "refs": { 940 "LogSettingsRequest$logType": "<p>The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.</p>", 941 "LogSettingsResponse$logType": "<p>The type of logging that is enabled.</p>" 942 } 943 }, 944 "MaxResults": { 945 "base": null, 946 "refs": { 947 "GetBotAliasesRequest$maxResults": "<p>The maximum number of aliases to return in the response. The default is 50. . </p>", 948 "GetBotChannelAssociationsRequest$maxResults": "<p>The maximum number of associations to return in the response. The default is 50. </p>", 949 "GetBotVersionsRequest$maxResults": "<p>The maximum number of bot versions to return in the response. The default is 10.</p>", 950 "GetBotsRequest$maxResults": "<p>The maximum number of bots to return in the response that the request will return. The default is 10.</p>", 951 "GetBuiltinIntentsRequest$maxResults": "<p>The maximum number of intents to return in the response. The default is 10.</p>", 952 "GetBuiltinSlotTypesRequest$maxResults": "<p>The maximum number of slot types to return in the response. The default is 10.</p>", 953 "GetIntentVersionsRequest$maxResults": "<p>The maximum number of intent versions to return in the response. The default is 10.</p>", 954 "GetIntentsRequest$maxResults": "<p>The maximum number of intents to return in the response. The default is 10.</p>", 955 "GetMigrationsRequest$maxResults": "<p>The maximum number of migrations to return in the response. The default is 10.</p>", 956 "GetSlotTypeVersionsRequest$maxResults": "<p>The maximum number of slot type versions to return in the response. The default is 10.</p>", 957 "GetSlotTypesRequest$maxResults": "<p>The maximum number of slot types to return in the response. The default is 10.</p>" 958 } 959 }, 960 "MergeStrategy": { 961 "base": null, 962 "refs": { 963 "GetImportResponse$mergeStrategy": "<p>The action taken when there was a conflict between an existing resource and a resource in the import file.</p>", 964 "StartImportRequest$mergeStrategy": "<p>Specifies the action that the <code>StartImport</code> operation should take when there is an existing resource with the same name.</p> <ul> <li> <p>FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the <code>failureReason</code> field of the response to the <code>GetImport</code> operation.</p> <p>OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.</p> </li> </ul>", 965 "StartImportResponse$mergeStrategy": "<p>The action to take when there is a merge conflict.</p>" 966 } 967 }, 968 "Message": { 969 "base": "<p>The message object that provides the message text and its type.</p>", 970 "refs": { 971 "MessageList$member": null 972 } 973 }, 974 "MessageList": { 975 "base": null, 976 "refs": { 977 "Prompt$messages": "<p>An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).</p>", 978 "Statement$messages": "<p>A collection of message objects.</p>" 979 } 980 }, 981 "MessageVersion": { 982 "base": null, 983 "refs": { 984 "CodeHook$messageVersion": "<p>The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see <a>using-lambda</a>.</p>" 985 } 986 }, 987 "MigrationAlert": { 988 "base": "<p>Provides information about alerts and warnings that Amazon Lex sends during a migration. The alerts include information about how to resolve the issue.</p>", 989 "refs": { 990 "MigrationAlerts$member": null 991 } 992 }, 993 "MigrationAlertDetail": { 994 "base": null, 995 "refs": { 996 "MigrationAlertDetails$member": null 997 } 998 }, 999 "MigrationAlertDetails": { 1000 "base": null, 1001 "refs": { 1002 "MigrationAlert$details": "<p>Additional details about the alert.</p>" 1003 } 1004 }, 1005 "MigrationAlertMessage": { 1006 "base": null, 1007 "refs": { 1008 "MigrationAlert$message": "<p>A message that describes why the alert was issued.</p>" 1009 } 1010 }, 1011 "MigrationAlertReferenceURL": { 1012 "base": null, 1013 "refs": { 1014 "MigrationAlertReferenceURLs$member": null 1015 } 1016 }, 1017 "MigrationAlertReferenceURLs": { 1018 "base": null, 1019 "refs": { 1020 "MigrationAlert$referenceURLs": "<p>A link to the Amazon Lex documentation that describes how to resolve the alert.</p>" 1021 } 1022 }, 1023 "MigrationAlertType": { 1024 "base": null, 1025 "refs": { 1026 "MigrationAlert$type": "<p>The type of alert. There are two kinds of alerts:</p> <ul> <li> <p> <code>ERROR</code> - There was an issue with the migration that can't be resolved. The migration stops.</p> </li> <li> <p> <code>WARN</code> - There was an issue with the migration that requires manual changes to the new Amazon Lex V2 bot. The migration continues.</p> </li> </ul>" 1027 } 1028 }, 1029 "MigrationAlerts": { 1030 "base": null, 1031 "refs": { 1032 "GetMigrationResponse$alerts": "<p>A list of alerts and warnings that indicate issues with the migration for the Amazon Lex V1 bot to Amazon Lex V2. You receive a warning when an Amazon Lex V1 feature has a different implementation if Amazon Lex V2.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/lexv2/latest/dg/migrate.html\">Migrating a bot</a> in the <i>Amazon Lex V2 developer guide</i>.</p>" 1033 } 1034 }, 1035 "MigrationId": { 1036 "base": null, 1037 "refs": { 1038 "GetMigrationRequest$migrationId": "<p>The unique identifier of the migration to view. The <code>migrationID</code> is returned by the operation.</p>", 1039 "GetMigrationResponse$migrationId": "<p>The unique identifier of the migration. This is the same as the identifier used when calling the <code>GetMigration</code> operation.</p>", 1040 "MigrationSummary$migrationId": "<p>The unique identifier that Amazon Lex assigned to the migration.</p>", 1041 "StartMigrationResponse$migrationId": "<p>The unique identifier that Amazon Lex assigned to the migration.</p>" 1042 } 1043 }, 1044 "MigrationSortAttribute": { 1045 "base": null, 1046 "refs": { 1047 "GetMigrationsRequest$sortByAttribute": "<p>The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.</p>" 1048 } 1049 }, 1050 "MigrationStatus": { 1051 "base": null, 1052 "refs": { 1053 "GetMigrationResponse$migrationStatus": "<p>Indicates the status of the migration. When the status is <code>COMPLETE</code> the migration is finished and the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.</p>", 1054 "GetMigrationsRequest$migrationStatusEquals": "<p>Filters the list to contain only migrations in the specified state.</p>", 1055 "MigrationSummary$migrationStatus": "<p>The status of the operation. When the status is <code>COMPLETE</code> the bot is available in Amazon Lex V2. There may be alerts and warnings that need to be resolved to complete the migration.</p>" 1056 } 1057 }, 1058 "MigrationStrategy": { 1059 "base": null, 1060 "refs": { 1061 "GetMigrationResponse$migrationStrategy": "<p>The strategy used to conduct the migration.</p> <ul> <li> <p> <code>CREATE_NEW</code> - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.</p> </li> <li> <p> <code>UPDATE_EXISTING</code> - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.</p> </li> </ul>", 1062 "MigrationSummary$migrationStrategy": "<p>The strategy used to conduct the migration.</p>", 1063 "StartMigrationRequest$migrationStrategy": "<p>The strategy used to conduct the migration.</p> <ul> <li> <p> <code>CREATE_NEW</code> - Creates a new Amazon Lex V2 bot and migrates the Amazon Lex V1 bot to the new bot.</p> </li> <li> <p> <code>UPDATE_EXISTING</code> - Overwrites the existing Amazon Lex V2 bot metadata and the locale being migrated. It doesn't change any other locales in the Amazon Lex V2 bot. If the locale doesn't exist, a new locale is created in the Amazon Lex V2 bot.</p> </li> </ul>", 1064 "StartMigrationResponse$migrationStrategy": "<p>The strategy used to conduct the migration.</p>" 1065 } 1066 }, 1067 "MigrationSummary": { 1068 "base": "<p>Provides information about migrating a bot from Amazon Lex V1 to Amazon Lex V2.</p>", 1069 "refs": { 1070 "MigrationSummaryList$member": null 1071 } 1072 }, 1073 "MigrationSummaryList": { 1074 "base": null, 1075 "refs": { 1076 "GetMigrationsResponse$migrationSummaries": "<p>An array of summaries for migrations from Amazon Lex V1 to Amazon Lex V2. To see details of the migration, use the <code>migrationId</code> from the summary in a call to the operation.</p>" 1077 } 1078 }, 1079 "Name": { 1080 "base": null, 1081 "refs": { 1082 "GetExportRequest$name": "<p>The name of the bot to export.</p>", 1083 "GetExportResponse$name": "<p>The name of the bot being exported.</p>", 1084 "GetImportResponse$name": "<p>The name given to the import job.</p>", 1085 "ResourceReference$name": "<p>The name of the resource that is using the resource that you are trying to delete.</p>", 1086 "StartImportResponse$name": "<p>The name given to the import job.</p>" 1087 } 1088 }, 1089 "NextToken": { 1090 "base": null, 1091 "refs": { 1092 "GetBotAliasesRequest$nextToken": "<p>A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. </p>", 1093 "GetBotAliasesResponse$nextToken": "<p>A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request. </p>", 1094 "GetBotChannelAssociationsRequest$nextToken": "<p>A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request. </p>", 1095 "GetBotChannelAssociationsResponse$nextToken": "<p>A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request. </p>", 1096 "GetBotVersionsRequest$nextToken": "<p>A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1097 "GetBotVersionsResponse$nextToken": "<p>A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1098 "GetBotsRequest$nextToken": "<p>A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request. </p>", 1099 "GetBotsResponse$nextToken": "<p>If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots. </p>", 1100 "GetBuiltinIntentsRequest$nextToken": "<p>A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.</p>", 1101 "GetBuiltinIntentsResponse$nextToken": "<p>A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.</p>", 1102 "GetBuiltinSlotTypesRequest$nextToken": "<p>A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.</p>", 1103 "GetBuiltinSlotTypesResponse$nextToken": "<p>If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.</p>", 1104 "GetIntentVersionsRequest$nextToken": "<p>A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1105 "GetIntentVersionsResponse$nextToken": "<p>A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1106 "GetIntentsRequest$nextToken": "<p>A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request. </p>", 1107 "GetIntentsResponse$nextToken": "<p>If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents. </p>", 1108 "GetMigrationsRequest$nextToken": "<p>A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.</p>", 1109 "GetMigrationsResponse$nextToken": "<p>If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of migrations.</p>", 1110 "GetSlotTypeVersionsRequest$nextToken": "<p>A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1111 "GetSlotTypeVersionsResponse$nextToken": "<p>A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request. </p>", 1112 "GetSlotTypesRequest$nextToken": "<p>A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.</p>", 1113 "GetSlotTypesResponse$nextToken": "<p>If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.</p>" 1114 } 1115 }, 1116 "NotFoundException": { 1117 "base": "<p>The resource specified in the request was not found. Check the resource and try again.</p>", 1118 "refs": { 1119 } 1120 }, 1121 "NumericalVersion": { 1122 "base": null, 1123 "refs": { 1124 "DeleteBotVersionRequest$version": "<p>The version of the bot to delete. You cannot delete the <code>$LATEST</code> version of the bot. To delete the <code>$LATEST</code> version, use the <a>DeleteBot</a> operation.</p>", 1125 "DeleteIntentVersionRequest$version": "<p>The version of the intent to delete. You cannot delete the <code>$LATEST</code> version of the intent. To delete the <code>$LATEST</code> version, use the <a>DeleteIntent</a> operation.</p>", 1126 "DeleteSlotTypeVersionRequest$version": "<p>The version of the slot type to delete. You cannot delete the <code>$LATEST</code> version of the slot type. To delete the <code>$LATEST</code> version, use the <a>DeleteSlotType</a> operation.</p>", 1127 "GetExportRequest$version": "<p>The version of the bot to export.</p>", 1128 "GetExportResponse$version": "<p>The version of the bot being exported.</p>" 1129 } 1130 }, 1131 "ObfuscationSetting": { 1132 "base": null, 1133 "refs": { 1134 "Slot$obfuscationSetting": "<p>Determines whether a slot is obfuscated in conversation logs and stored utterances. When you obfuscate a slot, the value is replaced by the slot name in curly braces ({}). For example, if the slot name is \"full_name\", obfuscated values are replaced with \"{full_name}\". For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/how-obfuscate.html\"> Slot Obfuscation </a>. </p>" 1135 } 1136 }, 1137 "OutputContext": { 1138 "base": "<p>The specification of an output context that is set when an intent is fulfilled.</p>", 1139 "refs": { 1140 "OutputContextList$member": null 1141 } 1142 }, 1143 "OutputContextList": { 1144 "base": null, 1145 "refs": { 1146 "CreateIntentVersionResponse$outputContexts": "<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>", 1147 "GetIntentResponse$outputContexts": "<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>", 1148 "PutIntentRequest$outputContexts": "<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>", 1149 "PutIntentResponse$outputContexts": "<p>An array of <code>OutputContext</code> objects that lists the contexts that the intent activates when the intent is fulfilled.</p>" 1150 } 1151 }, 1152 "OutputContextName": { 1153 "base": null, 1154 "refs": { 1155 "OutputContext$name": "<p>The name of the context.</p>" 1156 } 1157 }, 1158 "PreconditionFailedException": { 1159 "base": "<p> The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.</p>", 1160 "refs": { 1161 } 1162 }, 1163 "Priority": { 1164 "base": null, 1165 "refs": { 1166 "Slot$priority": "<p> Directs Amazon Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Amazon Lex first elicits a value for the slot with priority 1.</p> <p>If multiple slots share the same priority, the order in which Amazon Lex elicits values is arbitrary.</p>" 1167 } 1168 }, 1169 "ProcessBehavior": { 1170 "base": null, 1171 "refs": { 1172 "PutBotRequest$processBehavior": "<p>If you set the <code>processBehavior</code> element to <code>BUILD</code>, Amazon Lex builds the bot so that it can be run. If you set the element to <code>SAVE</code> Amazon Lex saves the bot, but doesn't build it. </p> <p>If you don't specify this value, the default value is <code>BUILD</code>.</p>" 1173 } 1174 }, 1175 "Prompt": { 1176 "base": "<p>Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see <a>how-it-works</a>.</p>", 1177 "refs": { 1178 "CreateBotVersionResponse$clarificationPrompt": "<p>The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see <a>PutBot</a>. </p>", 1179 "CreateIntentVersionResponse$confirmationPrompt": "<p>If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it. </p>", 1180 "FollowUpPrompt$prompt": "<p>Prompts for information from the user. </p>", 1181 "GetBotResponse$clarificationPrompt": "<p>The message Amazon Lex uses when it doesn't understand the user's request. For more information, see <a>PutBot</a>. </p>", 1182 "GetIntentResponse$confirmationPrompt": "<p>If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see <a>PutIntent</a>. </p>", 1183 "PutBotRequest$clarificationPrompt": "<p>When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeat the clarification prompt, use the <code>maxAttempts</code> field. If Amazon Lex still doesn't understand, it sends the message in the <code>abortStatement</code> field. </p> <p>When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: \"What would you like to do? You can say 'Order a pizza' or 'Order a drink.'\"</p> <p>If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the <code>maxAttempts</code> field. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html\"> AMAZON.FallbackIntent</a>.</p> <p>If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases: </p> <ul> <li> <p>Follow-up prompt - When the user responds to a follow-up prompt but does not provide an intent. For example, in response to a follow-up prompt that says \"Would you like anything else today?\" the user says \"Yes.\" Amazon Lex will return a 400 Bad Request exception because it does not have a clarification prompt to send to the user to get an intent.</p> </li> <li> <p>Lambda function - When using a Lambda function, you return an <code>ElicitIntent</code> dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.</p> </li> <li> <p>PutSession operation - When using the <code>PutSession</code> operation, you send an <code>ElicitIntent</code> dialog type. Since Amazon Lex does not have a clarification prompt to get an intent from the user, it returns a 400 Bad Request exception.</p> </li> </ul>", 1184 "PutBotResponse$clarificationPrompt": "<p> The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see <a>PutBot</a>. </p>", 1185 "PutIntentRequest$confirmationPrompt": "<p>Prompts the user to confirm the intent. This question should have a yes or no answer.</p> <p>Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the <code>OrderPizza</code> intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. </p> <note> <p>You you must provide both the <code>rejectionStatement</code> and the <code>confirmationPrompt</code>, or neither.</p> </note>", 1186 "PutIntentResponse$confirmationPrompt": "<p>If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.</p>", 1187 "Slot$valueElicitationPrompt": "<p>The prompt that Amazon Lex uses to elicit the slot value from the user.</p>" 1188 } 1189 }, 1190 "PromptMaxAttempts": { 1191 "base": null, 1192 "refs": { 1193 "Prompt$maxAttempts": "<p>The number of times to prompt the user for information.</p>" 1194 } 1195 }, 1196 "PutBotAliasRequest": { 1197 "base": null, 1198 "refs": { 1199 } 1200 }, 1201 "PutBotAliasResponse": { 1202 "base": null, 1203 "refs": { 1204 } 1205 }, 1206 "PutBotRequest": { 1207 "base": null, 1208 "refs": { 1209 } 1210 }, 1211 "PutBotResponse": { 1212 "base": null, 1213 "refs": { 1214 } 1215 }, 1216 "PutIntentRequest": { 1217 "base": null, 1218 "refs": { 1219 } 1220 }, 1221 "PutIntentResponse": { 1222 "base": null, 1223 "refs": { 1224 } 1225 }, 1226 "PutSlotTypeRequest": { 1227 "base": null, 1228 "refs": { 1229 } 1230 }, 1231 "PutSlotTypeResponse": { 1232 "base": null, 1233 "refs": { 1234 } 1235 }, 1236 "QueryFilterString": { 1237 "base": null, 1238 "refs": { 1239 "KendraConfiguration$queryFilterString": "<p>A query filter that Amazon Lex sends to Amazon Kendra to filter the response from the query. The filter is in the format defined by Amazon Kendra. For more information, see <a href=\"http://docs.aws.amazon.com/kendra/latest/dg/filtering.html\">Filtering queries</a>.</p> <p>You can override this filter string with a new filter string at runtime.</p>" 1240 } 1241 }, 1242 "ReferenceType": { 1243 "base": null, 1244 "refs": { 1245 "ResourceInUseException$referenceType": null 1246 } 1247 }, 1248 "RegexPattern": { 1249 "base": null, 1250 "refs": { 1251 "SlotTypeRegexConfiguration$pattern": "<p>A regular expression used to validate the value of a slot. </p> <p>Use a standard regular expression. Amazon Lex supports the following characters in the regular expression:</p> <ul> <li> <p>A-Z, a-z</p> </li> <li> <p>0-9</p> </li> <li> <p>Unicode characters (\"\\ u<Unicode>\")</p> </li> </ul> <p>Represent Unicode characters with four digits, for example \"\\u0041\" or \"\\u005A\".</p> <p>The following regular expression operators are not supported:</p> <ul> <li> <p>Infinite repeaters: *, +, or {x,} with no upper bound.</p> </li> <li> <p>Wild card (.)</p> </li> </ul>" 1252 } 1253 }, 1254 "ResourceArn": { 1255 "base": null, 1256 "refs": { 1257 "LogSettingsRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.</p>", 1258 "LogSettingsResponse$resourceArn": "<p>The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.</p>" 1259 } 1260 }, 1261 "ResourceInUseException": { 1262 "base": "<p>The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.</p> <p>The body of the exception contains a JSON object that describes the resource.</p> <p> <code>{ \"resourceType\": BOT | BOTALIAS | BOTCHANNEL | INTENT,</code> </p> <p> <code>\"resourceReference\": {</code> </p> <p> <code>\"name\": <i>string</i>, \"version\": <i>string</i> } }</code> </p>", 1263 "refs": { 1264 } 1265 }, 1266 "ResourcePrefix": { 1267 "base": null, 1268 "refs": { 1269 "LogSettingsResponse$resourcePrefix": "<p>The resource prefix is the first part of the S3 object key within the S3 bucket that you specified to contain audio logs. For CloudWatch Logs it is the prefix of the log stream name within the log group that you specified. </p>" 1270 } 1271 }, 1272 "ResourceReference": { 1273 "base": "<p>Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the <code>ResourceInUseException</code> exception. </p>", 1274 "refs": { 1275 "ResourceInUseException$exampleReference": null 1276 } 1277 }, 1278 "ResourceType": { 1279 "base": null, 1280 "refs": { 1281 "GetExportRequest$resourceType": "<p>The type of resource to export. </p>", 1282 "GetExportResponse$resourceType": "<p>The type of the exported resource.</p>", 1283 "GetImportResponse$resourceType": "<p>The type of resource imported.</p>", 1284 "StartImportRequest$resourceType": "<p>Specifies the type of resource to export. Each resource also exports any resources that it depends on. </p> <ul> <li> <p>A bot exports dependent intents.</p> </li> <li> <p>An intent exports dependent slot types.</p> </li> </ul>", 1285 "StartImportResponse$resourceType": "<p>The type of resource to import.</p>" 1286 } 1287 }, 1288 "ResponseCard": { 1289 "base": null, 1290 "refs": { 1291 "Prompt$responseCard": "<p>A response card. Amazon Lex uses this prompt at runtime, in the <code>PostText</code> API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see <a>ex-resp-card</a>. </p>", 1292 "Slot$responseCard": "<p> A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply. </p>", 1293 "Statement$responseCard": "<p> At runtime, if the client is using the <a href=\"http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card. </p>" 1294 } 1295 }, 1296 "SessionTTL": { 1297 "base": null, 1298 "refs": { 1299 "CreateBotVersionResponse$idleSessionTTLInSeconds": "<p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see <a>PutBot</a>.</p>", 1300 "GetBotResponse$idleSessionTTLInSeconds": "<p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see <a>PutBot</a>.</p>", 1301 "PutBotRequest$idleSessionTTLInSeconds": "<p>The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.</p> <p>A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.</p> <p>For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.</p> <p>If you don't include the <code>idleSessionTTLInSeconds</code> element in a <code>PutBot</code> operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.</p> <p>The default is 300 seconds (5 minutes).</p>", 1302 "PutBotResponse$idleSessionTTLInSeconds": "<p>The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see <a>PutBot</a>.</p>" 1303 } 1304 }, 1305 "Slot": { 1306 "base": "<p>Identifies the version of a specific slot.</p>", 1307 "refs": { 1308 "SlotList$member": null 1309 } 1310 }, 1311 "SlotConstraint": { 1312 "base": null, 1313 "refs": { 1314 "Slot$slotConstraint": "<p>Specifies whether the slot is required or optional. </p>" 1315 } 1316 }, 1317 "SlotDefaultValue": { 1318 "base": "<p>A default value for a slot.</p>", 1319 "refs": { 1320 "SlotDefaultValueList$member": null 1321 } 1322 }, 1323 "SlotDefaultValueList": { 1324 "base": null, 1325 "refs": { 1326 "SlotDefaultValueSpec$defaultValueList": "<p>The default values for a slot. You can specify more than one default. For example, you can specify a default value to use from a matching context variable, a session attribute, or a fixed value.</p> <p>The default value chosen is selected based on the order that you specify them in the list. For example, if you specify a context variable and a fixed value in that order, Amazon Lex uses the context variable if it is available, else it uses the fixed value.</p>" 1327 } 1328 }, 1329 "SlotDefaultValueSpec": { 1330 "base": "<p>Contains the default values for a slot. Default values are used when Amazon Lex hasn't determined a value for a slot.</p>", 1331 "refs": { 1332 "Slot$defaultValueSpec": "<p>A list of default values for the slot. Default values are used when Amazon Lex hasn't determined a value for a slot. You can specify default values from context variables, session attributes, and defined values.</p>" 1333 } 1334 }, 1335 "SlotDefaultValueString": { 1336 "base": null, 1337 "refs": { 1338 "SlotDefaultValue$defaultValue": "<p>The default value for the slot. You can specify one of the following:</p> <ul> <li> <p> <code>#context-name.slot-name</code> - The slot value \"slot-name\" in the context \"context-name.\"</p> </li> <li> <p> <code>{attribute}</code> - The slot value of the session attribute \"attribute.\"</p> </li> <li> <p> <code>'value'</code> - The discrete value \"value.\"</p> </li> </ul>" 1339 } 1340 }, 1341 "SlotList": { 1342 "base": null, 1343 "refs": { 1344 "CreateIntentVersionResponse$slots": "<p>An array of slot types that defines the information required to fulfill the intent.</p>", 1345 "GetIntentResponse$slots": "<p>An array of intent slots configured for the intent.</p>", 1346 "PutIntentRequest$slots": "<p>An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see <a>how-it-works</a>. </p>", 1347 "PutIntentResponse$slots": "<p>An array of intent slots that are configured for the intent.</p>" 1348 } 1349 }, 1350 "SlotName": { 1351 "base": null, 1352 "refs": { 1353 "Slot$name": "<p>The name of the slot.</p>" 1354 } 1355 }, 1356 "SlotTypeConfiguration": { 1357 "base": "<p>Provides configuration information for a slot type.</p>", 1358 "refs": { 1359 "SlotTypeConfigurations$member": null 1360 } 1361 }, 1362 "SlotTypeConfigurations": { 1363 "base": null, 1364 "refs": { 1365 "CreateSlotTypeVersionResponse$slotTypeConfigurations": "<p>Configuration information that extends the parent built-in slot type.</p>", 1366 "GetSlotTypeResponse$slotTypeConfigurations": "<p>Configuration information that extends the parent built-in slot type.</p>", 1367 "PutSlotTypeRequest$slotTypeConfigurations": "<p>Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.</p>", 1368 "PutSlotTypeResponse$slotTypeConfigurations": "<p>Configuration information that extends the parent built-in slot type.</p>" 1369 } 1370 }, 1371 "SlotTypeMetadata": { 1372 "base": "<p>Provides information about a slot type..</p>", 1373 "refs": { 1374 "SlotTypeMetadataList$member": null 1375 } 1376 }, 1377 "SlotTypeMetadataList": { 1378 "base": null, 1379 "refs": { 1380 "GetSlotTypeVersionsResponse$slotTypes": "<p>An array of <code>SlotTypeMetadata</code> objects, one for each numbered version of the slot type plus one for the <code>$LATEST</code> version.</p>", 1381 "GetSlotTypesResponse$slotTypes": "<p>An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.</p>" 1382 } 1383 }, 1384 "SlotTypeName": { 1385 "base": null, 1386 "refs": { 1387 "CreateSlotTypeVersionRequest$name": "<p>The name of the slot type that you want to create a new version for. The name is case sensitive. </p>", 1388 "CreateSlotTypeVersionResponse$name": "<p>The name of the slot type.</p>", 1389 "DeleteSlotTypeRequest$name": "<p>The name of the slot type. The name is case sensitive. </p>", 1390 "DeleteSlotTypeVersionRequest$name": "<p>The name of the slot type.</p>", 1391 "GetSlotTypeRequest$name": "<p>The name of the slot type. The name is case sensitive. </p>", 1392 "GetSlotTypeResponse$name": "<p>The name of the slot type.</p>", 1393 "GetSlotTypeVersionsRequest$name": "<p>The name of the slot type for which versions should be returned.</p>", 1394 "GetSlotTypesRequest$nameContains": "<p>Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>", 1395 "PutSlotTypeRequest$name": "<p>The name of the slot type. The name is <i>not</i> case sensitive. </p> <p>The name can't match a built-in slot type name, or a built-in slot type name with \"AMAZON.\" removed. For example, because there is a built-in slot type called <code>AMAZON.DATE</code>, you can't create a custom slot type called <code>DATE</code>.</p> <p>For a list of built-in slot types, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/slot-type-reference\">Slot Type Reference</a> in the <i>Alexa Skills Kit</i>.</p>", 1396 "PutSlotTypeResponse$name": "<p>The name of the slot type.</p>", 1397 "SlotTypeMetadata$name": "<p>The name of the slot type.</p>" 1398 } 1399 }, 1400 "SlotTypeRegexConfiguration": { 1401 "base": "<p>Provides a regular expression used to validate the value of a slot.</p>", 1402 "refs": { 1403 "SlotTypeConfiguration$regexConfiguration": "<p>A regular expression used to validate the value of a slot.</p>" 1404 } 1405 }, 1406 "SlotUtteranceList": { 1407 "base": null, 1408 "refs": { 1409 "Slot$sampleUtterances": "<p> If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances. </p>" 1410 } 1411 }, 1412 "SlotValueSelectionStrategy": { 1413 "base": null, 1414 "refs": { 1415 "CreateSlotTypeVersionResponse$valueSelectionStrategy": "<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>", 1416 "GetSlotTypeResponse$valueSelectionStrategy": "<p>The strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>", 1417 "PutSlotTypeRequest$valueSelectionStrategy": "<p>Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:</p> <ul> <li> <p> <code>ORIGINAL_VALUE</code> - Returns the value entered by the user, if the user value is similar to the slot value.</p> </li> <li> <p> <code>TOP_RESOLUTION</code> - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.</p> </li> </ul> <p>If you don't specify the <code>valueSelectionStrategy</code>, the default is <code>ORIGINAL_VALUE</code>.</p>", 1418 "PutSlotTypeResponse$valueSelectionStrategy": "<p>The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see <a>PutSlotType</a>.</p>" 1419 } 1420 }, 1421 "SortOrder": { 1422 "base": null, 1423 "refs": { 1424 "GetMigrationsRequest$sortByOrder": "<p>The order so sort the list.</p>" 1425 } 1426 }, 1427 "StartImportRequest": { 1428 "base": null, 1429 "refs": { 1430 } 1431 }, 1432 "StartImportResponse": { 1433 "base": null, 1434 "refs": { 1435 } 1436 }, 1437 "StartMigrationRequest": { 1438 "base": null, 1439 "refs": { 1440 } 1441 }, 1442 "StartMigrationResponse": { 1443 "base": null, 1444 "refs": { 1445 } 1446 }, 1447 "Statement": { 1448 "base": "<p>A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey. </p>", 1449 "refs": { 1450 "CreateBotVersionResponse$abortStatement": "<p>The message that Amazon Lex uses to cancel a conversation. For more information, see <a>PutBot</a>.</p>", 1451 "CreateIntentVersionResponse$rejectionStatement": "<p>If the user answers \"no\" to the question defined in <code>confirmationPrompt</code>, Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p>", 1452 "CreateIntentVersionResponse$conclusionStatement": "<p>After the Lambda function specified in the <code>fulfillmentActivity</code> field fulfills the intent, Amazon Lex conveys this statement to the user. </p>", 1453 "FollowUpPrompt$rejectionStatement": "<p>If the user answers \"no\" to the question defined in the <code>prompt</code> field, Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p>", 1454 "GetBotResponse$abortStatement": "<p>The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see <a>PutBot</a>.</p>", 1455 "GetIntentResponse$rejectionStatement": "<p>If the user answers \"no\" to the question defined in <code>confirmationPrompt</code>, Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p>", 1456 "GetIntentResponse$conclusionStatement": "<p>After the Lambda function specified in the <code>fulfillmentActivity</code> element fulfills the intent, Amazon Lex conveys this statement to the user.</p>", 1457 "PutBotRequest$abortStatement": "<p>When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in <code>abortStatement</code> to the user, and then cancels the conversation. To set the number of retries, use the <code>valueElicitationPrompt</code> field for the slot type. </p> <p>For example, in a pizza ordering bot, Amazon Lex might ask a user \"What type of crust would you like?\" If the user's response is not one of the expected responses (for example, \"thin crust, \"deep dish,\" etc.), Amazon Lex tries to elicit a correct response a few more times. </p> <p>For example, in a pizza ordering application, <code>OrderPizza</code> might be one of the intents. This intent might require the <code>CrustType</code> slot. You specify the <code>valueElicitationPrompt</code> field when you create the <code>CrustType</code> slot.</p> <p>If you have defined a fallback intent the cancel statement will not be sent to the user, the fallback intent is used instead. For more information, see <a href=\"https://docs.aws.amazon.com/lex/latest/dg/built-in-intent-fallback.html\"> AMAZON.FallbackIntent</a>.</p>", 1458 "PutBotResponse$abortStatement": "<p>The message that Amazon Lex uses to cancel a conversation. For more information, see <a>PutBot</a>.</p>", 1459 "PutIntentRequest$rejectionStatement": "<p>When the user answers \"no\" to the question defined in <code>confirmationPrompt</code>, Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p> <note> <p>You must provide both the <code>rejectionStatement</code> and the <code>confirmationPrompt</code>, or neither.</p> </note>", 1460 "PutIntentRequest$conclusionStatement": "<p> The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. </p> <p>This element is relevant only if you provide a Lambda function in the <code>fulfillmentActivity</code>. If you return the intent to the client application, you can't specify this element.</p> <note> <p>The <code>followUpPrompt</code> and <code>conclusionStatement</code> are mutually exclusive. You can specify only one.</p> </note>", 1461 "PutIntentResponse$rejectionStatement": "<p>If the user answers \"no\" to the question defined in <code>confirmationPrompt</code> Amazon Lex responds with this statement to acknowledge that the intent was canceled. </p>", 1462 "PutIntentResponse$conclusionStatement": "<p>After the Lambda function specified in the<code>fulfillmentActivity</code>intent fulfills the intent, Amazon Lex conveys this statement to the user.</p>" 1463 } 1464 }, 1465 "Status": { 1466 "base": null, 1467 "refs": { 1468 "BotMetadata$status": "<p>The status of the bot.</p>", 1469 "CreateBotVersionResponse$status": "<p> When you send a request to create or update a bot, Amazon Lex sets the <code>status</code> response element to <code>BUILDING</code>. After Amazon Lex builds the bot, it sets <code>status</code> to <code>READY</code>. If Amazon Lex can't build the bot, it sets <code>status</code> to <code>FAILED</code>. Amazon Lex returns the reason for the failure in the <code>failureReason</code> response element. </p>", 1470 "GetBotResponse$status": "<p>The status of the bot. </p> <p>When the status is <code>BUILDING</code> Amazon Lex is building the bot for testing and use.</p> <p>If the status of the bot is <code>READY_BASIC_TESTING</code>, you can test the bot using the exact utterances specified in the bot's intents. When the bot is ready for full testing or to run, the status is <code>READY</code>.</p> <p>If there was a problem with building the bot, the status is <code>FAILED</code> and the <code>failureReason</code> field explains why the bot did not build.</p> <p>If the bot was saved but not built, the status is <code>NOT_BUILT</code>.</p>", 1471 "PutBotResponse$status": "<p> When you send a request to create a bot with <code>processBehavior</code> set to <code>BUILD</code>, Amazon Lex sets the <code>status</code> response element to <code>BUILDING</code>.</p> <p>In the <code>READY_BASIC_TESTING</code> state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.</p> <p>If Amazon Lex can't build the bot, Amazon Lex sets <code>status</code> to <code>FAILED</code>. Amazon Lex returns the reason for the failure in the <code>failureReason</code> response element. </p> <p>When you set <code>processBehavior</code> to <code>SAVE</code>, Amazon Lex sets the status code to <code>NOT BUILT</code>.</p> <p>When the bot is in the <code>READY</code> state you can test and publish the bot.</p>" 1472 } 1473 }, 1474 "StatusType": { 1475 "base": null, 1476 "refs": { 1477 "GetUtterancesViewRequest$statusType": "<p>To return utterances that were recognized and handled, use <code>Detected</code>. To return utterances that were not recognized, use <code>Missed</code>.</p>" 1478 } 1479 }, 1480 "String": { 1481 "base": null, 1482 "refs": { 1483 "AccessDeniedException$message": null, 1484 "BadRequestException$message": null, 1485 "BotAliasMetadata$checksum": "<p>Checksum of the bot alias.</p>", 1486 "BotChannelAssociation$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.</p>", 1487 "BuiltinIntentSlot$name": "<p>A list of the slots defined for the intent.</p>", 1488 "ChannelConfigurationMap$key": null, 1489 "ChannelConfigurationMap$value": null, 1490 "ConflictException$message": null, 1491 "CreateBotVersionRequest$checksum": "<p>Identifies a specific revision of the <code>$LATEST</code> version of the bot. If you specify a checksum and the <code>$LATEST</code> version of the bot has a different checksum, a <code>PreconditionFailedException</code> exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the <code>$LATEST</code> version.</p>", 1492 "CreateBotVersionResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to build the bot.</p>", 1493 "CreateBotVersionResponse$voiceId": "<p>The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.</p>", 1494 "CreateBotVersionResponse$checksum": "<p>Checksum identifying the version of the bot that was created.</p>", 1495 "CreateIntentVersionRequest$checksum": "<p>Checksum of the <code>$LATEST</code> version of the intent that should be used to create the new version. If you specify a checksum and the <code>$LATEST</code> version of the intent has a different checksum, Amazon Lex returns a <code>PreconditionFailedException</code> exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the <code>$LATEST</code> version.</p>", 1496 "CreateIntentVersionResponse$checksum": "<p>Checksum of the intent version created.</p>", 1497 "CreateSlotTypeVersionRequest$checksum": "<p>Checksum for the <code>$LATEST</code> version of the slot type that you want to publish. If you specify a checksum and the <code>$LATEST</code> version of the slot type has a different checksum, Amazon Lex returns a <code>PreconditionFailedException</code> exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the <code>$LATEST</code> version.</p>", 1498 "CreateSlotTypeVersionResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>", 1499 "GetBotAliasResponse$checksum": "<p>Checksum of the bot alias.</p>", 1500 "GetBotChannelAssociationResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to create the association.</p>", 1501 "GetBotRequest$versionOrAlias": "<p>The version or alias of the bot.</p>", 1502 "GetBotResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex explains why it failed to build the bot.</p>", 1503 "GetBotResponse$voiceId": "<p>The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see <a>PutBot</a>.</p>", 1504 "GetBotResponse$checksum": "<p>Checksum of the bot used to identify a specific revision of the bot's <code>$LATEST</code> version.</p>", 1505 "GetBuiltinIntentsRequest$signatureContains": "<p>Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\" To find the signature for an intent, see <a href=\"https://developer.amazon.com/public/solutions/alexa/alexa-skills-kit/docs/built-in-intent-ref/standard-intents\">Standard Built-in Intents</a> in the <i>Alexa Skills Kit</i>.</p>", 1506 "GetBuiltinSlotTypesRequest$signatureContains": "<p>Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"</p>", 1507 "GetExportResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to export the resource.</p>", 1508 "GetExportResponse$url": "<p>An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.</p>", 1509 "GetImportRequest$importId": "<p>The identifier of the import job information to return.</p>", 1510 "GetImportResponse$importId": "<p>The identifier for the specific import job.</p>", 1511 "GetIntentResponse$checksum": "<p>Checksum of the intent.</p>", 1512 "GetSlotTypeResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>", 1513 "InternalFailureException$message": null, 1514 "LimitExceededException$retryAfterSeconds": null, 1515 "LimitExceededException$message": null, 1516 "NotFoundException$message": null, 1517 "PreconditionFailedException$message": null, 1518 "PutBotAliasRequest$checksum": "<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new bot alias, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a bot alias, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>", 1519 "PutBotAliasResponse$checksum": "<p>The checksum for the current version of the alias.</p>", 1520 "PutBotRequest$voiceId": "<p>The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see <a href=\"https://docs.aws.amazon.com/polly/latest/dg/voicelist.html\">Voices in Amazon Polly</a> in the <i>Amazon Polly Developer Guide</i>.</p>", 1521 "PutBotRequest$checksum": "<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new bot, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a bot, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>", 1522 "PutBotResponse$failureReason": "<p>If <code>status</code> is <code>FAILED</code>, Amazon Lex provides the reason that it failed to build the bot.</p>", 1523 "PutBotResponse$voiceId": "<p>The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see <a>PutBot</a>.</p>", 1524 "PutBotResponse$checksum": "<p>Checksum of the bot that you created.</p>", 1525 "PutIntentRequest$checksum": "<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new intent, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a intent, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>", 1526 "PutIntentResponse$checksum": "<p>Checksum of the <code>$LATEST</code>version of the intent created or updated.</p>", 1527 "PutSlotTypeRequest$checksum": "<p>Identifies a specific revision of the <code>$LATEST</code> version.</p> <p>When you create a new slot type, leave the <code>checksum</code> field blank. If you specify a checksum you get a <code>BadRequestException</code> exception.</p> <p>When you want to update a slot type, set the <code>checksum</code> field to the checksum of the most recent revision of the <code>$LATEST</code> version. If you don't specify the <code> checksum</code> field, or if the checksum does not match the <code>$LATEST</code> version, you get a <code>PreconditionFailedException</code> exception.</p>", 1528 "PutSlotTypeResponse$checksum": "<p>Checksum of the <code>$LATEST</code> version of the slot type.</p>", 1529 "StartImportResponse$importId": "<p>The identifier for the specific import job.</p>", 1530 "StringList$member": null 1531 } 1532 }, 1533 "StringList": { 1534 "base": null, 1535 "refs": { 1536 "GetImportResponse$failureReason": "<p>A string that describes why an import job failed to complete.</p>" 1537 } 1538 }, 1539 "SynonymList": { 1540 "base": null, 1541 "refs": { 1542 "EnumerationValue$synonyms": "<p>Additional values related to the slot type value.</p>" 1543 } 1544 }, 1545 "Tag": { 1546 "base": "<p>A list of key/value pairs that identify a bot, bot alias, or bot channel. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. </p>", 1547 "refs": { 1548 "TagList$member": null 1549 } 1550 }, 1551 "TagKey": { 1552 "base": null, 1553 "refs": { 1554 "Tag$key": "<p>The key for the tag. Keys are not case-sensitive and must be unique.</p>", 1555 "TagKeyList$member": null 1556 } 1557 }, 1558 "TagKeyList": { 1559 "base": null, 1560 "refs": { 1561 "UntagResourceRequest$tagKeys": "<p>A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.</p>" 1562 } 1563 }, 1564 "TagList": { 1565 "base": null, 1566 "refs": { 1567 "ListTagsForResourceResponse$tags": "<p>The tags associated with a resource.</p>", 1568 "PutBotAliasRequest$tags": "<p>A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the <code>PutBotAlias</code> operation to update the tags on a bot alias. To update tags, use the <code>TagResource</code> operation.</p>", 1569 "PutBotAliasResponse$tags": "<p>A list of tags associated with a bot.</p>", 1570 "PutBotRequest$tags": "<p>A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the <code>PutBot</code> operation to update the tags on a bot. To update tags, use the <code>TagResource</code> operation.</p>", 1571 "PutBotResponse$tags": "<p>A list of tags associated with the bot.</p>", 1572 "StartImportRequest$tags": "<p>A list of tags to add to the imported bot. You can only add tags when you import a bot, you can't add tags to an intent or slot type.</p>", 1573 "StartImportResponse$tags": "<p>A list of tags added to the imported bot.</p>", 1574 "TagResourceRequest$tags": "<p>A list of tag keys to add to the resource. If a tag key already exists, the existing value is replaced with the new value.</p>" 1575 } 1576 }, 1577 "TagResourceRequest": { 1578 "base": null, 1579 "refs": { 1580 } 1581 }, 1582 "TagResourceResponse": { 1583 "base": null, 1584 "refs": { 1585 } 1586 }, 1587 "TagValue": { 1588 "base": null, 1589 "refs": { 1590 "Tag$value": "<p>The value associated with a key. The value may be an empty string but it can't be null.</p>" 1591 } 1592 }, 1593 "Timestamp": { 1594 "base": null, 1595 "refs": { 1596 "BotAliasMetadata$lastUpdatedDate": "<p>The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.</p>", 1597 "BotAliasMetadata$createdDate": "<p>The date that the bot alias was created.</p>", 1598 "BotChannelAssociation$createdDate": "<p>The date that the association between the Amazon Lex bot and the channel was created. </p>", 1599 "BotMetadata$lastUpdatedDate": "<p>The date that the bot was updated. When you create a bot, the creation date and last updated date are the same. </p>", 1600 "BotMetadata$createdDate": "<p>The date that the bot was created.</p>", 1601 "CreateBotVersionResponse$lastUpdatedDate": "<p>The date when the <code>$LATEST</code> version of this bot was updated. </p>", 1602 "CreateBotVersionResponse$createdDate": "<p>The date when the bot version was created.</p>", 1603 "CreateIntentVersionResponse$lastUpdatedDate": "<p>The date that the intent was updated. </p>", 1604 "CreateIntentVersionResponse$createdDate": "<p>The date that the intent was created.</p>", 1605 "CreateSlotTypeVersionResponse$lastUpdatedDate": "<p>The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.</p>", 1606 "CreateSlotTypeVersionResponse$createdDate": "<p>The date that the slot type was created.</p>", 1607 "GetBotAliasResponse$lastUpdatedDate": "<p>The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.</p>", 1608 "GetBotAliasResponse$createdDate": "<p>The date that the bot alias was created.</p>", 1609 "GetBotChannelAssociationResponse$createdDate": "<p>The date that the association between the bot and the channel was created.</p>", 1610 "GetBotResponse$lastUpdatedDate": "<p>The date that the bot was updated. When you create a resource, the creation date and last updated date are the same. </p>", 1611 "GetBotResponse$createdDate": "<p>The date that the bot was created.</p>", 1612 "GetImportResponse$createdDate": "<p>A timestamp for the date and time that the import job was created.</p>", 1613 "GetIntentResponse$lastUpdatedDate": "<p>The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same. </p>", 1614 "GetIntentResponse$createdDate": "<p>The date that the intent was created.</p>", 1615 "GetMigrationResponse$migrationTimestamp": "<p>The date and time that the migration started.</p>", 1616 "GetSlotTypeResponse$lastUpdatedDate": "<p>The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.</p>", 1617 "GetSlotTypeResponse$createdDate": "<p>The date that the slot type was created.</p>", 1618 "IntentMetadata$lastUpdatedDate": "<p>The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.</p>", 1619 "IntentMetadata$createdDate": "<p>The date that the intent was created.</p>", 1620 "MigrationSummary$migrationTimestamp": "<p>The date and time that the migration started.</p>", 1621 "PutBotAliasResponse$lastUpdatedDate": "<p>The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.</p>", 1622 "PutBotAliasResponse$createdDate": "<p>The date that the bot alias was created.</p>", 1623 "PutBotResponse$lastUpdatedDate": "<p>The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.</p>", 1624 "PutBotResponse$createdDate": "<p>The date that the bot was created.</p>", 1625 "PutIntentResponse$lastUpdatedDate": "<p>The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.</p>", 1626 "PutIntentResponse$createdDate": "<p>The date that the intent was created.</p>", 1627 "PutSlotTypeResponse$lastUpdatedDate": "<p>The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.</p>", 1628 "PutSlotTypeResponse$createdDate": "<p>The date that the slot type was created.</p>", 1629 "SlotTypeMetadata$lastUpdatedDate": "<p>The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same. </p>", 1630 "SlotTypeMetadata$createdDate": "<p>The date that the slot type was created.</p>", 1631 "StartImportResponse$createdDate": "<p>A timestamp for the date and time that the import job was requested.</p>", 1632 "StartMigrationResponse$migrationTimestamp": "<p>The date and time that the migration started.</p>", 1633 "UtteranceData$firstUtteredDate": "<p>The date that the utterance was first recorded.</p>", 1634 "UtteranceData$lastUtteredDate": "<p>The date that the utterance was last recorded.</p>" 1635 } 1636 }, 1637 "UntagResourceRequest": { 1638 "base": null, 1639 "refs": { 1640 } 1641 }, 1642 "UntagResourceResponse": { 1643 "base": null, 1644 "refs": { 1645 } 1646 }, 1647 "UserId": { 1648 "base": null, 1649 "refs": { 1650 "DeleteUtterancesRequest$userId": "<p> The unique identifier for the user that made the utterances. This is the user ID that was sent in the <a href=\"http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostContent.html\">PostContent</a> or <a href=\"http://docs.aws.amazon.com/lex/latest/dg/API_runtime_PostText.html\">PostText</a> operation request that contained the utterance.</p>" 1651 } 1652 }, 1653 "Utterance": { 1654 "base": null, 1655 "refs": { 1656 "IntentUtteranceList$member": null, 1657 "SlotUtteranceList$member": null 1658 } 1659 }, 1660 "UtteranceData": { 1661 "base": "<p>Provides information about a single utterance that was made to your bot. </p>", 1662 "refs": { 1663 "ListOfUtterance$member": null 1664 } 1665 }, 1666 "UtteranceList": { 1667 "base": "<p>Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.</p>", 1668 "refs": { 1669 "ListsOfUtterances$member": null 1670 } 1671 }, 1672 "UtteranceString": { 1673 "base": null, 1674 "refs": { 1675 "UtteranceData$utteranceString": "<p>The text that was entered by the user or the text representation of an audio clip.</p>" 1676 } 1677 }, 1678 "V2BotId": { 1679 "base": null, 1680 "refs": { 1681 "GetMigrationResponse$v2BotId": "<p>The unique identifier of the Amazon Lex V2 bot that the Amazon Lex V1 is being migrated to.</p>", 1682 "MigrationSummary$v2BotId": "<p>The unique identifier of the Amazon Lex V2 that is the destination of the migration.</p>", 1683 "StartMigrationResponse$v2BotId": "<p>The unique identifier for the Amazon Lex V2 bot. </p>" 1684 } 1685 }, 1686 "V2BotName": { 1687 "base": null, 1688 "refs": { 1689 "StartMigrationRequest$v2BotName": "<p>The name of the Amazon Lex V2 bot that you are migrating the Amazon Lex V1 bot to. </p> <ul> <li> <p>If the Amazon Lex V2 bot doesn't exist, you must use the <code>CREATE_NEW</code> migration strategy.</p> </li> <li> <p>If the Amazon Lex V2 bot exists, you must use the <code>UPDATE_EXISTING</code> migration strategy to change the contents of the Amazon Lex V2 bot.</p> </li> </ul>" 1690 } 1691 }, 1692 "Value": { 1693 "base": null, 1694 "refs": { 1695 "EnumerationValue$value": "<p>The value of the slot type.</p>", 1696 "SynonymList$member": null 1697 } 1698 }, 1699 "Version": { 1700 "base": null, 1701 "refs": { 1702 "BotAliasMetadata$botVersion": "<p>The version of the Amazon Lex bot to which the alias points.</p>", 1703 "BotMetadata$version": "<p>The version of the bot. For a new bot, the version is always <code>$LATEST</code>.</p>", 1704 "BotVersions$member": null, 1705 "CreateBotVersionResponse$version": "<p>The version of the bot. </p>", 1706 "CreateIntentVersionResponse$version": "<p>The version number assigned to the new version of the intent.</p>", 1707 "CreateSlotTypeVersionResponse$version": "<p>The version assigned to the new slot type version. </p>", 1708 "GetBotAliasResponse$botVersion": "<p>The version of the bot that the alias points to.</p>", 1709 "GetBotResponse$version": "<p>The version of the bot. For a new bot, the version is always <code>$LATEST</code>.</p>", 1710 "GetIntentRequest$version": "<p>The version of the intent.</p>", 1711 "GetIntentResponse$version": "<p>The version of the intent.</p>", 1712 "GetMigrationResponse$v1BotVersion": "<p>The version of the Amazon Lex V1 bot migrated to Amazon Lex V2.</p>", 1713 "GetSlotTypeRequest$version": "<p>The version of the slot type. </p>", 1714 "GetSlotTypeResponse$version": "<p>The version of the slot type.</p>", 1715 "Intent$intentVersion": "<p>The version of the intent.</p>", 1716 "IntentMetadata$version": "<p>The version of the intent.</p>", 1717 "MigrationSummary$v1BotVersion": "<p>The version of the Amazon Lex V1 bot that is the source of the migration.</p>", 1718 "PutBotAliasRequest$botVersion": "<p>The version of the bot.</p>", 1719 "PutBotAliasResponse$botVersion": "<p>The version of the bot that the alias points to.</p>", 1720 "PutBotResponse$version": "<p>The version of the bot. For a new bot, the version is always <code>$LATEST</code>.</p>", 1721 "PutIntentResponse$version": "<p>The version of the intent. For a new intent, the version is always <code>$LATEST</code>.</p>", 1722 "PutSlotTypeResponse$version": "<p>The version of the slot type. For a new slot type, the version is always <code>$LATEST</code>. </p>", 1723 "ResourceReference$version": "<p>The version of the resource that is using the resource that you are trying to delete.</p>", 1724 "Slot$slotTypeVersion": "<p>The version of the slot type.</p>", 1725 "SlotTypeMetadata$version": "<p>The version of the slot type.</p>", 1726 "StartMigrationRequest$v1BotVersion": "<p>The version of the bot to migrate to Amazon Lex V2. You can migrate the <code>$LATEST</code> version as well as any numbered version.</p>", 1727 "StartMigrationResponse$v1BotVersion": "<p>The version of the bot to migrate to Amazon Lex V2. </p>", 1728 "UtteranceList$botVersion": "<p>The version of the bot that processed the list.</p>" 1729 } 1730 }, 1731 "roleArn": { 1732 "base": null, 1733 "refs": { 1734 "KendraConfiguration$role": "<p>The Amazon Resource Name (ARN) of an IAM role that has permission to search the Amazon Kendra index. The role must be in the same account and Region as the Amazon Lex bot. If the role does not exist, you get an exception when you call the <code>PutIntent</code> operation.</p>" 1735 } 1736 } 1737 } 1738} 1739