UNPKG

138 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class LexModelBuildingService extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: LexModelBuildingService.Types.ClientConfiguration)
13 config: Config & LexModelBuildingService.Types.ClientConfiguration;
14 /**
15 * Creates a new version of the bot based on the $LATEST version. If the $LATEST 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. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. 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 versioning-intro. This operation requires permission for the lex:CreateBotVersion action.
16 */
17 createBotVersion(params: LexModelBuildingService.Types.CreateBotVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request<LexModelBuildingService.Types.CreateBotVersionResponse, AWSError>;
18 /**
19 * Creates a new version of the bot based on the $LATEST version. If the $LATEST 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. You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation. 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 versioning-intro. This operation requires permission for the lex:CreateBotVersion action.
20 */
21 createBotVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateBotVersionResponse) => void): Request<LexModelBuildingService.Types.CreateBotVersionResponse, AWSError>;
22 /**
23 * Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST 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. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action.
24 */
25 createIntentVersion(params: LexModelBuildingService.Types.CreateIntentVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request<LexModelBuildingService.Types.CreateIntentVersionResponse, AWSError>;
26 /**
27 * Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST 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. You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation. When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro. This operation requires permissions to perform the lex:CreateIntentVersion action.
28 */
29 createIntentVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateIntentVersionResponse) => void): Request<LexModelBuildingService.Types.CreateIntentVersionResponse, AWSError>;
30 /**
31 * Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST 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. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. 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 versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action.
32 */
33 createSlotTypeVersion(params: LexModelBuildingService.Types.CreateSlotTypeVersionRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request<LexModelBuildingService.Types.CreateSlotTypeVersionResponse, AWSError>;
34 /**
35 * Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST 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. You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation. 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 versioning-intro. This operation requires permissions for the lex:CreateSlotTypeVersion action.
36 */
37 createSlotTypeVersion(callback?: (err: AWSError, data: LexModelBuildingService.Types.CreateSlotTypeVersionResponse) => void): Request<LexModelBuildingService.Types.CreateSlotTypeVersionResponse, AWSError>;
38 /**
39 * Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. 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 DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException 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 DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action.
40 */
41 deleteBot(params: LexModelBuildingService.Types.DeleteBotRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
42 /**
43 * Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. 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 DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException 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 DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action.
44 */
45 deleteBot(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
46 /**
47 * Deletes an alias for the specified bot. 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 DeleteBot operation returns a ResourceInUseException 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 DeleteBotAlias operation is successful.
48 */
49 deleteBotAlias(params: LexModelBuildingService.Types.DeleteBotAliasRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
50 /**
51 * Deletes an alias for the specified bot. 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 DeleteBot operation returns a ResourceInUseException 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 DeleteBotAlias operation is successful.
52 */
53 deleteBotAlias(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
54 /**
55 * Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.
56 */
57 deleteBotChannelAssociation(params: LexModelBuildingService.Types.DeleteBotChannelAssociationRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58 /**
59 * Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.
60 */
61 deleteBotChannelAssociation(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62 /**
63 * Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action.
64 */
65 deleteBotVersion(params: LexModelBuildingService.Types.DeleteBotVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66 /**
67 * Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the lex:DeleteBotVersion action.
68 */
69 deleteBotVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70 /**
71 * Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. 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 how-it-works), you must remove those references first. If you get the ResourceInUseException 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 DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action.
72 */
73 deleteIntent(params: LexModelBuildingService.Types.DeleteIntentRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74 /**
75 * Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation. 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 how-it-works), you must remove those references first. If you get the ResourceInUseException 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 DeleteIntent is successful. This operation requires permission for the lex:DeleteIntent action.
76 */
77 deleteIntent(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78 /**
79 * Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action.
80 */
81 deleteIntentVersion(params: LexModelBuildingService.Types.DeleteIntentVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82 /**
83 * Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions for the lex:DeleteIntentVersion action.
84 */
85 deleteIntentVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86 /**
87 * Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. 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. If you get the ResourceInUseException 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 DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action.
88 */
89 deleteSlotType(params: LexModelBuildingService.Types.DeleteSlotTypeRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90 /**
91 * Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation. 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. If you get the ResourceInUseException 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 DeleteSlotType call is successful. This operation requires permission for the lex:DeleteSlotType action.
92 */
93 deleteSlotType(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94 /**
95 * Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action.
96 */
97 deleteSlotTypeVersion(params: LexModelBuildingService.Types.DeleteSlotTypeVersionRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
98 /**
99 * Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires permissions for the lex:DeleteSlotTypeVersion action.
100 */
101 deleteSlotTypeVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
102 /**
103 * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action.
104 */
105 deleteUtterances(params: LexModelBuildingService.Types.DeleteUtterancesRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
106 /**
107 * Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action.
108 */
109 deleteUtterances(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
110 /**
111 * Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action.
112 */
113 getBot(params: LexModelBuildingService.Types.GetBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request<LexModelBuildingService.Types.GetBotResponse, AWSError>;
114 /**
115 * Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions for the lex:GetBot action.
116 */
117 getBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotResponse) => void): Request<LexModelBuildingService.Types.GetBotResponse, AWSError>;
118 /**
119 * Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.
120 */
121 getBotAlias(params: LexModelBuildingService.Types.GetBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasResponse, AWSError>;
122 /**
123 * Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases. This operation requires permissions for the lex:GetBotAlias action.
124 */
125 getBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasResponse, AWSError>;
126 /**
127 * Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
128 */
129 getBotAliases(params: LexModelBuildingService.Types.GetBotAliasesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasesResponse, AWSError>;
130 /**
131 * Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
132 */
133 getBotAliases(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotAliasesResponse) => void): Request<LexModelBuildingService.Types.GetBotAliasesResponse, AWSError>;
134 /**
135 * Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
136 */
137 getBotChannelAssociation(params: LexModelBuildingService.Types.GetBotChannelAssociationRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationResponse, AWSError>;
138 /**
139 * Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
140 */
141 getBotChannelAssociation(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationResponse, AWSError>;
142 /**
143 * Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
144 */
145 getBotChannelAssociations(params: LexModelBuildingService.Types.GetBotChannelAssociationsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationsResponse, AWSError>;
146 /**
147 * Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
148 */
149 getBotChannelAssociations(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotChannelAssociationsResponse) => void): Request<LexModelBuildingService.Types.GetBotChannelAssociationsResponse, AWSError>;
150 /**
151 * Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action.
152 */
153 getBotVersions(params: LexModelBuildingService.Types.GetBotVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request<LexModelBuildingService.Types.GetBotVersionsResponse, AWSError>;
154 /**
155 * Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetBotVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetBotVersions action.
156 */
157 getBotVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotVersionsResponse) => void): Request<LexModelBuildingService.Types.GetBotVersionsResponse, AWSError>;
158 /**
159 * Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action.
160 */
161 getBots(params: LexModelBuildingService.Types.GetBotsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request<LexModelBuildingService.Types.GetBotsResponse, AWSError>;
162 /**
163 * Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string. If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots. This operation requires permission for the lex:GetBots action.
164 */
165 getBots(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBotsResponse) => void): Request<LexModelBuildingService.Types.GetBotsResponse, AWSError>;
166 /**
167 * Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
168 */
169 getBuiltinIntent(params: LexModelBuildingService.Types.GetBuiltinIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentResponse, AWSError>;
170 /**
171 * Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
172 */
173 getBuiltinIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentResponse, AWSError>;
174 /**
175 * Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
176 */
177 getBuiltinIntents(params: LexModelBuildingService.Types.GetBuiltinIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentsResponse, AWSError>;
178 /**
179 * Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
180 */
181 getBuiltinIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinIntentsResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinIntentsResponse, AWSError>;
182 /**
183 * Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action.
184 */
185 getBuiltinSlotTypes(params: LexModelBuildingService.Types.GetBuiltinSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinSlotTypesResponse, AWSError>;
186 /**
187 * Gets a list of built-in slot types that meet the specified criteria. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit. This operation requires permission for the lex:GetBuiltInSlotTypes action.
188 */
189 getBuiltinSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetBuiltinSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetBuiltinSlotTypesResponse, AWSError>;
190 /**
191 * Exports the contents of a Amazon Lex resource in a specified format.
192 */
193 getExport(params: LexModelBuildingService.Types.GetExportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request<LexModelBuildingService.Types.GetExportResponse, AWSError>;
194 /**
195 * Exports the contents of a Amazon Lex resource in a specified format.
196 */
197 getExport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetExportResponse) => void): Request<LexModelBuildingService.Types.GetExportResponse, AWSError>;
198 /**
199 * Gets information about an import job started with the StartImport operation.
200 */
201 getImport(params: LexModelBuildingService.Types.GetImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request<LexModelBuildingService.Types.GetImportResponse, AWSError>;
202 /**
203 * Gets information about an import job started with the StartImport operation.
204 */
205 getImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetImportResponse) => void): Request<LexModelBuildingService.Types.GetImportResponse, AWSError>;
206 /**
207 * Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action.
208 */
209 getIntent(params: LexModelBuildingService.Types.GetIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request<LexModelBuildingService.Types.GetIntentResponse, AWSError>;
210 /**
211 * Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to perform the lex:GetIntent action.
212 */
213 getIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentResponse) => void): Request<LexModelBuildingService.Types.GetIntentResponse, AWSError>;
214 /**
215 * Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action.
216 */
217 getIntentVersions(params: LexModelBuildingService.Types.GetIntentVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request<LexModelBuildingService.Types.GetIntentVersionsResponse, AWSError>;
218 /**
219 * Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetIntentVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetIntentVersions action.
220 */
221 getIntentVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentVersionsResponse) => void): Request<LexModelBuildingService.Types.GetIntentVersionsResponse, AWSError>;
222 /**
223 * Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action.
224 */
225 getIntents(params: LexModelBuildingService.Types.GetIntentsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request<LexModelBuildingService.Types.GetIntentsResponse, AWSError>;
226 /**
227 * Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all intents. The operation requires permission for the lex:GetIntents action.
228 */
229 getIntents(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetIntentsResponse) => void): Request<LexModelBuildingService.Types.GetIntentsResponse, AWSError>;
230 /**
231 * 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. This operation requires permissions for the lex:GetSlotType action.
232 */
233 getSlotType(params: LexModelBuildingService.Types.GetSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeResponse, AWSError>;
234 /**
235 * 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. This operation requires permissions for the lex:GetSlotType action.
236 */
237 getSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeResponse, AWSError>;
238 /**
239 * Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action.
240 */
241 getSlotTypeVersions(params: LexModelBuildingService.Types.GetSlotTypeVersionsRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeVersionsResponse, AWSError>;
242 /**
243 * Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version. The GetSlotTypeVersions operation always returns at least one version, the $LATEST version. This operation requires permissions for the lex:GetSlotTypeVersions action.
244 */
245 getSlotTypeVersions(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypeVersionsResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypeVersionsResponse, AWSError>;
246 /**
247 * Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action.
248 */
249 getSlotTypes(params: LexModelBuildingService.Types.GetSlotTypesRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypesResponse, AWSError>;
250 /**
251 * Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string. If you don't specify the nameContains field, returns information about the $LATEST version of all slot types. The operation requires permission for the lex:GetSlotTypes action.
252 */
253 getSlotTypes(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetSlotTypesResponse) => void): Request<LexModelBuildingService.Types.GetSlotTypesResponse, AWSError>;
254 /**
255 * Use the GetUtterancesView 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. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView 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 OrderFlowers intent so that your bot recognizes that utterance. 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. 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. If you set childDirected field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
256 */
257 getUtterancesView(params: LexModelBuildingService.Types.GetUtterancesViewRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request<LexModelBuildingService.Types.GetUtterancesViewResponse, AWSError>;
258 /**
259 * Use the GetUtterancesView 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. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView 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 OrderFlowers intent so that your bot recognizes that utterance. 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. 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. If you set childDirected field to true when you created your bot, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
260 */
261 getUtterancesView(callback?: (err: AWSError, data: LexModelBuildingService.Types.GetUtterancesViewResponse) => void): Request<LexModelBuildingService.Types.GetUtterancesViewResponse, AWSError>;
262 /**
263 * Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
264 */
265 listTagsForResource(params: LexModelBuildingService.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.ListTagsForResourceResponse) => void): Request<LexModelBuildingService.Types.ListTagsForResourceResponse, AWSError>;
266 /**
267 * Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
268 */
269 listTagsForResource(callback?: (err: AWSError, data: LexModelBuildingService.Types.ListTagsForResourceResponse) => void): Request<LexModelBuildingService.Types.ListTagsForResourceResponse, AWSError>;
270 /**
271 * 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 response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
272 */
273 putBot(params: LexModelBuildingService.Types.PutBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
274 /**
275 * 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 response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
276 */
277 putBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
278 /**
279 * 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 versioning-aliases. This operation requires permissions for the lex:PutBotAlias action.
280 */
281 putBotAlias(params: LexModelBuildingService.Types.PutBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
282 /**
283 * 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 versioning-aliases. This operation requires permissions for the lex:PutBotAlias action.
284 */
285 putBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
286 /**
287 * Creates an intent or replaces an existing intent. 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 OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." 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. 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. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST 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 $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action.
288 */
289 putIntent(params: LexModelBuildingService.Types.PutIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
290 /**
291 * Creates an intent or replaces an existing intent. 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 OrderPizza intent. To create an intent or replace an existing intent, you must provide the following: Intent name. For example, OrderPizza. Sample utterances. For example, "Can I order a pizza, please." and "I want to order a pizza." 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. 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. You can specify other optional information in the request, such as: A confirmation prompt to ask the user to confirm an intent. For example, "Shall I order your pizza?" A conclusion statement to send to the user after the intent has been fulfilled. For example, "I placed your pizza order." A follow-up prompt that asks the user for additional activity. For example, asking "Do you want to order a drink with your pizza?" If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST 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 $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT. For more information, see how-it-works. This operation requires permissions for the lex:PutIntent action.
292 */
293 putIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
294 /**
295 * Creates a custom slot type or replaces an existing custom slot type. 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 how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST 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 $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action.
296 */
297 putSlotType(params: LexModelBuildingService.Types.PutSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
298 /**
299 * Creates a custom slot type or replaces an existing custom slot type. 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 how-it-works. If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST 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 $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT. This operation requires permissions for the lex:PutSlotType action.
300 */
301 putSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
302 /**
303 * Starts a job to import a resource to Amazon Lex.
304 */
305 startImport(params: LexModelBuildingService.Types.StartImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
306 /**
307 * Starts a job to import a resource to Amazon Lex.
308 */
309 startImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
310 /**
311 * Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
312 */
313 tagResource(params: LexModelBuildingService.Types.TagResourceRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.TagResourceResponse) => void): Request<LexModelBuildingService.Types.TagResourceResponse, AWSError>;
314 /**
315 * Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
316 */
317 tagResource(callback?: (err: AWSError, data: LexModelBuildingService.Types.TagResourceResponse) => void): Request<LexModelBuildingService.Types.TagResourceResponse, AWSError>;
318 /**
319 * Removes tags from a bot, bot alias or bot channel.
320 */
321 untagResource(params: LexModelBuildingService.Types.UntagResourceRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.UntagResourceResponse) => void): Request<LexModelBuildingService.Types.UntagResourceResponse, AWSError>;
322 /**
323 * Removes tags from a bot, bot alias or bot channel.
324 */
325 untagResource(callback?: (err: AWSError, data: LexModelBuildingService.Types.UntagResourceResponse) => void): Request<LexModelBuildingService.Types.UntagResourceResponse, AWSError>;
326}
327declare namespace LexModelBuildingService {
328 export type AliasName = string;
329 export type AliasNameOrListAll = string;
330 export type AmazonResourceName = string;
331 export type _Blob = Buffer|Uint8Array|Blob|string;
332 export type Boolean = boolean;
333 export interface BotAliasMetadata {
334 /**
335 * The name of the bot alias.
336 */
337 name?: AliasName;
338 /**
339 * A description of the bot alias.
340 */
341 description?: Description;
342 /**
343 * The version of the Amazon Lex bot to which the alias points.
344 */
345 botVersion?: Version;
346 /**
347 * The name of the bot to which the alias points.
348 */
349 botName?: BotName;
350 /**
351 * The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
352 */
353 lastUpdatedDate?: Timestamp;
354 /**
355 * The date that the bot alias was created.
356 */
357 createdDate?: Timestamp;
358 /**
359 * Checksum of the bot alias.
360 */
361 checksum?: String;
362 /**
363 * Settings that determine how Amazon Lex uses conversation logs for the alias.
364 */
365 conversationLogs?: ConversationLogsResponse;
366 }
367 export type BotAliasMetadataList = BotAliasMetadata[];
368 export interface BotChannelAssociation {
369 /**
370 * The name of the association between the bot and the channel.
371 */
372 name?: BotChannelName;
373 /**
374 * A text description of the association you are creating.
375 */
376 description?: Description;
377 /**
378 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
379 */
380 botAlias?: AliasName;
381 /**
382 * The name of the Amazon Lex bot to which this association is being made. Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.
383 */
384 botName?: BotName;
385 /**
386 * The date that the association between the Amazon Lex bot and the channel was created.
387 */
388 createdDate?: Timestamp;
389 /**
390 * Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
391 */
392 type?: ChannelType;
393 /**
394 * Provides information necessary to communicate with the messaging platform.
395 */
396 botConfiguration?: ChannelConfigurationMap;
397 /**
398 * The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
399 */
400 status?: ChannelStatus;
401 /**
402 * If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
403 */
404 failureReason?: String;
405 }
406 export type BotChannelAssociationList = BotChannelAssociation[];
407 export type BotChannelName = string;
408 export interface BotMetadata {
409 /**
410 * The name of the bot.
411 */
412 name?: BotName;
413 /**
414 * A description of the bot.
415 */
416 description?: Description;
417 /**
418 * The status of the bot.
419 */
420 status?: Status;
421 /**
422 * The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
423 */
424 lastUpdatedDate?: Timestamp;
425 /**
426 * The date that the bot was created.
427 */
428 createdDate?: Timestamp;
429 /**
430 * The version of the bot. For a new bot, the version is always $LATEST.
431 */
432 version?: Version;
433 }
434 export type BotMetadataList = BotMetadata[];
435 export type BotName = string;
436 export type BotVersions = Version[];
437 export interface BuiltinIntentMetadata {
438 /**
439 * A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
440 */
441 signature?: BuiltinIntentSignature;
442 /**
443 * A list of identifiers for the locales that the intent supports.
444 */
445 supportedLocales?: LocaleList;
446 }
447 export type BuiltinIntentMetadataList = BuiltinIntentMetadata[];
448 export type BuiltinIntentSignature = string;
449 export interface BuiltinIntentSlot {
450 /**
451 * A list of the slots defined for the intent.
452 */
453 name?: String;
454 }
455 export type BuiltinIntentSlotList = BuiltinIntentSlot[];
456 export interface BuiltinSlotTypeMetadata {
457 /**
458 * A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.
459 */
460 signature?: BuiltinSlotTypeSignature;
461 /**
462 * A list of target locales for the slot.
463 */
464 supportedLocales?: LocaleList;
465 }
466 export type BuiltinSlotTypeMetadataList = BuiltinSlotTypeMetadata[];
467 export type BuiltinSlotTypeSignature = string;
468 export type ChannelConfigurationMap = {[key: string]: String};
469 export type ChannelStatus = "IN_PROGRESS"|"CREATED"|"FAILED"|string;
470 export type ChannelType = "Facebook"|"Slack"|"Twilio-Sms"|"Kik"|string;
471 export interface CodeHook {
472 /**
473 * The Amazon Resource Name (ARN) of the Lambda function.
474 */
475 uri: LambdaARN;
476 /**
477 * The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.
478 */
479 messageVersion: MessageVersion;
480 }
481 export type ContentString = string;
482 export type ContentType = "PlainText"|"SSML"|"CustomPayload"|string;
483 export interface ConversationLogsRequest {
484 /**
485 * The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
486 */
487 logSettings: LogSettingsRequestList;
488 /**
489 * 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 Creating an IAM Role and Policy for Conversation Logs.
490 */
491 iamRoleArn: IamRoleArn;
492 }
493 export interface ConversationLogsResponse {
494 /**
495 * The settings for your conversation logs. You can log text, audio, or both.
496 */
497 logSettings?: LogSettingsResponseList;
498 /**
499 * The Amazon Resource Name (ARN) of the IAM role used to write your logs to CloudWatch Logs or an S3 bucket.
500 */
501 iamRoleArn?: IamRoleArn;
502 }
503 export type Count = number;
504 export interface CreateBotVersionRequest {
505 /**
506 * The name of the bot that you want to create a new version of. The name is case sensitive.
507 */
508 name: BotName;
509 /**
510 * Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
511 */
512 checksum?: String;
513 }
514 export interface CreateBotVersionResponse {
515 /**
516 * The name of the bot.
517 */
518 name?: BotName;
519 /**
520 * A description of the bot.
521 */
522 description?: Description;
523 /**
524 * An array of Intent objects. For more information, see PutBot.
525 */
526 intents?: IntentList;
527 /**
528 * The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
529 */
530 clarificationPrompt?: Prompt;
531 /**
532 * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
533 */
534 abortStatement?: Statement;
535 /**
536 * When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.
537 */
538 status?: Status;
539 /**
540 * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
541 */
542 failureReason?: String;
543 /**
544 * The date when the $LATEST version of this bot was updated.
545 */
546 lastUpdatedDate?: Timestamp;
547 /**
548 * The date when the bot version was created.
549 */
550 createdDate?: Timestamp;
551 /**
552 * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
553 */
554 idleSessionTTLInSeconds?: SessionTTL;
555 /**
556 * The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
557 */
558 voiceId?: String;
559 /**
560 * Checksum identifying the version of the bot that was created.
561 */
562 checksum?: String;
563 /**
564 * The version of the bot.
565 */
566 version?: Version;
567 /**
568 * Specifies the target locale for the bot.
569 */
570 locale?: Locale;
571 /**
572 * 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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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. 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 Amazon Lex FAQ.
573 */
574 childDirected?: Boolean;
575 /**
576 * Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
577 */
578 detectSentiment?: Boolean;
579 }
580 export interface CreateIntentVersionRequest {
581 /**
582 * The name of the intent that you want to create a new version of. The name is case sensitive.
583 */
584 name: IntentName;
585 /**
586 * Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
587 */
588 checksum?: String;
589 }
590 export interface CreateIntentVersionResponse {
591 /**
592 * The name of the intent.
593 */
594 name?: IntentName;
595 /**
596 * A description of the intent.
597 */
598 description?: Description;
599 /**
600 * An array of slot types that defines the information required to fulfill the intent.
601 */
602 slots?: SlotList;
603 /**
604 * An array of sample utterances configured for the intent.
605 */
606 sampleUtterances?: IntentUtteranceList;
607 /**
608 * If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
609 */
610 confirmationPrompt?: Prompt;
611 /**
612 * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
613 */
614 rejectionStatement?: Statement;
615 /**
616 * If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
617 */
618 followUpPrompt?: FollowUpPrompt;
619 /**
620 * After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.
621 */
622 conclusionStatement?: Statement;
623 /**
624 * If defined, Amazon Lex invokes this Lambda function for each user input.
625 */
626 dialogCodeHook?: CodeHook;
627 /**
628 * Describes how the intent is fulfilled.
629 */
630 fulfillmentActivity?: FulfillmentActivity;
631 /**
632 * A unique identifier for a built-in intent.
633 */
634 parentIntentSignature?: BuiltinIntentSignature;
635 /**
636 * The date that the intent was updated.
637 */
638 lastUpdatedDate?: Timestamp;
639 /**
640 * The date that the intent was created.
641 */
642 createdDate?: Timestamp;
643 /**
644 * The version number assigned to the new version of the intent.
645 */
646 version?: Version;
647 /**
648 * Checksum of the intent version created.
649 */
650 checksum?: String;
651 }
652 export interface CreateSlotTypeVersionRequest {
653 /**
654 * The name of the slot type that you want to create a new version for. The name is case sensitive.
655 */
656 name: SlotTypeName;
657 /**
658 * Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.
659 */
660 checksum?: String;
661 }
662 export interface CreateSlotTypeVersionResponse {
663 /**
664 * The name of the slot type.
665 */
666 name?: SlotTypeName;
667 /**
668 * A description of the slot type.
669 */
670 description?: Description;
671 /**
672 * A list of EnumerationValue objects that defines the values that the slot type can take.
673 */
674 enumerationValues?: EnumerationValues;
675 /**
676 * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
677 */
678 lastUpdatedDate?: Timestamp;
679 /**
680 * The date that the slot type was created.
681 */
682 createdDate?: Timestamp;
683 /**
684 * The version assigned to the new slot type version.
685 */
686 version?: Version;
687 /**
688 * Checksum of the $LATEST version of the slot type.
689 */
690 checksum?: String;
691 /**
692 * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
693 */
694 valueSelectionStrategy?: SlotValueSelectionStrategy;
695 /**
696 * The built-in slot type used a the parent of the slot type.
697 */
698 parentSlotTypeSignature?: CustomOrBuiltinSlotTypeName;
699 /**
700 * Configuration information that extends the parent built-in slot type.
701 */
702 slotTypeConfigurations?: SlotTypeConfigurations;
703 }
704 export type CustomOrBuiltinSlotTypeName = string;
705 export interface DeleteBotAliasRequest {
706 /**
707 * The name of the alias to delete. The name is case sensitive.
708 */
709 name: AliasName;
710 /**
711 * The name of the bot that the alias points to.
712 */
713 botName: BotName;
714 }
715 export interface DeleteBotChannelAssociationRequest {
716 /**
717 * The name of the association. The name is case sensitive.
718 */
719 name: BotChannelName;
720 /**
721 * The name of the Amazon Lex bot.
722 */
723 botName: BotName;
724 /**
725 * An alias that points to the specific version of the Amazon Lex bot to which this association is being made.
726 */
727 botAlias: AliasName;
728 }
729 export interface DeleteBotRequest {
730 /**
731 * The name of the bot. The name is case sensitive.
732 */
733 name: BotName;
734 }
735 export interface DeleteBotVersionRequest {
736 /**
737 * The name of the bot.
738 */
739 name: BotName;
740 /**
741 * The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation.
742 */
743 version: NumericalVersion;
744 }
745 export interface DeleteIntentRequest {
746 /**
747 * The name of the intent. The name is case sensitive.
748 */
749 name: IntentName;
750 }
751 export interface DeleteIntentVersionRequest {
752 /**
753 * The name of the intent.
754 */
755 name: IntentName;
756 /**
757 * The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation.
758 */
759 version: NumericalVersion;
760 }
761 export interface DeleteSlotTypeRequest {
762 /**
763 * The name of the slot type. The name is case sensitive.
764 */
765 name: SlotTypeName;
766 }
767 export interface DeleteSlotTypeVersionRequest {
768 /**
769 * The name of the slot type.
770 */
771 name: SlotTypeName;
772 /**
773 * The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation.
774 */
775 version: NumericalVersion;
776 }
777 export interface DeleteUtterancesRequest {
778 /**
779 * The name of the bot that stored the utterances.
780 */
781 botName: BotName;
782 /**
783 * The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.
784 */
785 userId: UserId;
786 }
787 export type Description = string;
788 export type Destination = "CLOUDWATCH_LOGS"|"S3"|string;
789 export interface EnumerationValue {
790 /**
791 * The value of the slot type.
792 */
793 value: Value;
794 /**
795 * Additional values related to the slot type value.
796 */
797 synonyms?: SynonymList;
798 }
799 export type EnumerationValues = EnumerationValue[];
800 export type ExportStatus = "IN_PROGRESS"|"READY"|"FAILED"|string;
801 export type ExportType = "ALEXA_SKILLS_KIT"|"LEX"|string;
802 export interface FollowUpPrompt {
803 /**
804 * Prompts for information from the user.
805 */
806 prompt: Prompt;
807 /**
808 * If the user answers "no" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
809 */
810 rejectionStatement: Statement;
811 }
812 export interface FulfillmentActivity {
813 /**
814 * How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
815 */
816 type: FulfillmentActivityType;
817 /**
818 * A description of the Lambda function that is run to fulfill the intent.
819 */
820 codeHook?: CodeHook;
821 }
822 export type FulfillmentActivityType = "ReturnIntent"|"CodeHook"|string;
823 export interface GetBotAliasRequest {
824 /**
825 * The name of the bot alias. The name is case sensitive.
826 */
827 name: AliasName;
828 /**
829 * The name of the bot.
830 */
831 botName: BotName;
832 }
833 export interface GetBotAliasResponse {
834 /**
835 * The name of the bot alias.
836 */
837 name?: AliasName;
838 /**
839 * A description of the bot alias.
840 */
841 description?: Description;
842 /**
843 * The version of the bot that the alias points to.
844 */
845 botVersion?: Version;
846 /**
847 * The name of the bot that the alias points to.
848 */
849 botName?: BotName;
850 /**
851 * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
852 */
853 lastUpdatedDate?: Timestamp;
854 /**
855 * The date that the bot alias was created.
856 */
857 createdDate?: Timestamp;
858 /**
859 * Checksum of the bot alias.
860 */
861 checksum?: String;
862 /**
863 * The settings that determine how Amazon Lex uses conversation logs for the alias.
864 */
865 conversationLogs?: ConversationLogsResponse;
866 }
867 export interface GetBotAliasesRequest {
868 /**
869 * The name of the bot.
870 */
871 botName: BotName;
872 /**
873 * 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.
874 */
875 nextToken?: NextToken;
876 /**
877 * The maximum number of aliases to return in the response. The default is 50. .
878 */
879 maxResults?: MaxResults;
880 /**
881 * 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."
882 */
883 nameContains?: AliasName;
884 }
885 export interface GetBotAliasesResponse {
886 /**
887 * An array of BotAliasMetadata objects, each describing a bot alias.
888 */
889 BotAliases?: BotAliasMetadataList;
890 /**
891 * 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.
892 */
893 nextToken?: NextToken;
894 }
895 export interface GetBotChannelAssociationRequest {
896 /**
897 * The name of the association between the bot and the channel. The name is case sensitive.
898 */
899 name: BotChannelName;
900 /**
901 * The name of the Amazon Lex bot.
902 */
903 botName: BotName;
904 /**
905 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
906 */
907 botAlias: AliasName;
908 }
909 export interface GetBotChannelAssociationResponse {
910 /**
911 * The name of the association between the bot and the channel.
912 */
913 name?: BotChannelName;
914 /**
915 * A description of the association between the bot and the channel.
916 */
917 description?: Description;
918 /**
919 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
920 */
921 botAlias?: AliasName;
922 /**
923 * The name of the Amazon Lex bot.
924 */
925 botName?: BotName;
926 /**
927 * The date that the association between the bot and the channel was created.
928 */
929 createdDate?: Timestamp;
930 /**
931 * The type of the messaging platform.
932 */
933 type?: ChannelType;
934 /**
935 * Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
936 */
937 botConfiguration?: ChannelConfigurationMap;
938 /**
939 * The status of the bot channel. CREATED - The channel has been created and is ready for use. IN_PROGRESS - Channel creation is in progress. FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.
940 */
941 status?: ChannelStatus;
942 /**
943 * If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
944 */
945 failureReason?: String;
946 }
947 export interface GetBotChannelAssociationsRequest {
948 /**
949 * The name of the Amazon Lex bot in the association.
950 */
951 botName: BotName;
952 /**
953 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
954 */
955 botAlias: AliasNameOrListAll;
956 /**
957 * 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.
958 */
959 nextToken?: NextToken;
960 /**
961 * The maximum number of associations to return in the response. The default is 50.
962 */
963 maxResults?: MaxResults;
964 /**
965 * 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 nameContains parameter.
966 */
967 nameContains?: BotChannelName;
968 }
969 export interface GetBotChannelAssociationsResponse {
970 /**
971 * An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
972 */
973 botChannelAssociations?: BotChannelAssociationList;
974 /**
975 * 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.
976 */
977 nextToken?: NextToken;
978 }
979 export interface GetBotRequest {
980 /**
981 * The name of the bot. The name is case sensitive.
982 */
983 name: BotName;
984 /**
985 * The version or alias of the bot.
986 */
987 versionOrAlias: String;
988 }
989 export interface GetBotResponse {
990 /**
991 * The name of the bot.
992 */
993 name?: BotName;
994 /**
995 * A description of the bot.
996 */
997 description?: Description;
998 /**
999 * An array of intent objects. For more information, see PutBot.
1000 */
1001 intents?: IntentList;
1002 /**
1003 * The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
1004 */
1005 clarificationPrompt?: Prompt;
1006 /**
1007 * The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
1008 */
1009 abortStatement?: Statement;
1010 /**
1011 * The status of the bot. When the status is BUILDING Amazon Lex is building the bot for testing and use. If the status of the bot is READY_BASIC_TESTING, 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 READY. If there was a problem with building the bot, the status is FAILED and the failureReason field explains why the bot did not build. If the bot was saved but not built, the status is NOT_BUILT.
1012 */
1013 status?: Status;
1014 /**
1015 * If status is FAILED, Amazon Lex explains why it failed to build the bot.
1016 */
1017 failureReason?: String;
1018 /**
1019 * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
1020 */
1021 lastUpdatedDate?: Timestamp;
1022 /**
1023 * The date that the bot was created.
1024 */
1025 createdDate?: Timestamp;
1026 /**
1027 * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
1028 */
1029 idleSessionTTLInSeconds?: SessionTTL;
1030 /**
1031 * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
1032 */
1033 voiceId?: String;
1034 /**
1035 * Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
1036 */
1037 checksum?: String;
1038 /**
1039 * The version of the bot. For a new bot, the version is always $LATEST.
1040 */
1041 version?: Version;
1042 /**
1043 * The target locale for the bot.
1044 */
1045 locale?: Locale;
1046 /**
1047 * 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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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. 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 Amazon Lex FAQ.
1048 */
1049 childDirected?: Boolean;
1050 /**
1051 * Indicates whether user utterances should be sent to Amazon Comprehend for sentiment analysis.
1052 */
1053 detectSentiment?: Boolean;
1054 }
1055 export interface GetBotVersionsRequest {
1056 /**
1057 * The name of the bot for which versions should be returned.
1058 */
1059 name: BotName;
1060 /**
1061 * 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.
1062 */
1063 nextToken?: NextToken;
1064 /**
1065 * The maximum number of bot versions to return in the response. The default is 10.
1066 */
1067 maxResults?: MaxResults;
1068 }
1069 export interface GetBotVersionsResponse {
1070 /**
1071 * An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.
1072 */
1073 bots?: BotMetadataList;
1074 /**
1075 * 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.
1076 */
1077 nextToken?: NextToken;
1078 }
1079 export interface GetBotsRequest {
1080 /**
1081 * 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.
1082 */
1083 nextToken?: NextToken;
1084 /**
1085 * The maximum number of bots to return in the response that the request will return. The default is 10.
1086 */
1087 maxResults?: MaxResults;
1088 /**
1089 * 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."
1090 */
1091 nameContains?: BotName;
1092 }
1093 export interface GetBotsResponse {
1094 /**
1095 * An array of botMetadata objects, with one entry for each bot.
1096 */
1097 bots?: BotMetadataList;
1098 /**
1099 * 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.
1100 */
1101 nextToken?: NextToken;
1102 }
1103 export interface GetBuiltinIntentRequest {
1104 /**
1105 * The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
1106 */
1107 signature: BuiltinIntentSignature;
1108 }
1109 export interface GetBuiltinIntentResponse {
1110 /**
1111 * The unique identifier for a built-in intent.
1112 */
1113 signature?: BuiltinIntentSignature;
1114 /**
1115 * A list of locales that the intent supports.
1116 */
1117 supportedLocales?: LocaleList;
1118 /**
1119 * An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
1120 */
1121 slots?: BuiltinIntentSlotList;
1122 }
1123 export interface GetBuiltinIntentsRequest {
1124 /**
1125 * A list of locales that the intent supports.
1126 */
1127 locale?: Locale;
1128 /**
1129 * 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 Standard Built-in Intents in the Alexa Skills Kit.
1130 */
1131 signatureContains?: String;
1132 /**
1133 * 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.
1134 */
1135 nextToken?: NextToken;
1136 /**
1137 * The maximum number of intents to return in the response. The default is 10.
1138 */
1139 maxResults?: MaxResults;
1140 }
1141 export interface GetBuiltinIntentsResponse {
1142 /**
1143 * An array of builtinIntentMetadata objects, one for each intent in the response.
1144 */
1145 intents?: BuiltinIntentMetadataList;
1146 /**
1147 * 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.
1148 */
1149 nextToken?: NextToken;
1150 }
1151 export interface GetBuiltinSlotTypesRequest {
1152 /**
1153 * A list of locales that the slot type supports.
1154 */
1155 locale?: Locale;
1156 /**
1157 * 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."
1158 */
1159 signatureContains?: String;
1160 /**
1161 * 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.
1162 */
1163 nextToken?: NextToken;
1164 /**
1165 * The maximum number of slot types to return in the response. The default is 10.
1166 */
1167 maxResults?: MaxResults;
1168 }
1169 export interface GetBuiltinSlotTypesResponse {
1170 /**
1171 * An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
1172 */
1173 slotTypes?: BuiltinSlotTypeMetadataList;
1174 /**
1175 * 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.
1176 */
1177 nextToken?: NextToken;
1178 }
1179 export interface GetExportRequest {
1180 /**
1181 * The name of the bot to export.
1182 */
1183 name: Name;
1184 /**
1185 * The version of the bot to export.
1186 */
1187 version: NumericalVersion;
1188 /**
1189 * The type of resource to export.
1190 */
1191 resourceType: ResourceType;
1192 /**
1193 * The format of the exported data.
1194 */
1195 exportType: ExportType;
1196 }
1197 export interface GetExportResponse {
1198 /**
1199 * The name of the bot being exported.
1200 */
1201 name?: Name;
1202 /**
1203 * The version of the bot being exported.
1204 */
1205 version?: NumericalVersion;
1206 /**
1207 * The type of the exported resource.
1208 */
1209 resourceType?: ResourceType;
1210 /**
1211 * The format of the exported data.
1212 */
1213 exportType?: ExportType;
1214 /**
1215 * The status of the export. IN_PROGRESS - The export is in progress. READY - The export is complete. FAILED - The export could not be completed.
1216 */
1217 exportStatus?: ExportStatus;
1218 /**
1219 * If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.
1220 */
1221 failureReason?: String;
1222 /**
1223 * 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.
1224 */
1225 url?: String;
1226 }
1227 export interface GetImportRequest {
1228 /**
1229 * The identifier of the import job information to return.
1230 */
1231 importId: String;
1232 }
1233 export interface GetImportResponse {
1234 /**
1235 * The name given to the import job.
1236 */
1237 name?: Name;
1238 /**
1239 * The type of resource imported.
1240 */
1241 resourceType?: ResourceType;
1242 /**
1243 * The action taken when there was a conflict between an existing resource and a resource in the import file.
1244 */
1245 mergeStrategy?: MergeStrategy;
1246 /**
1247 * The identifier for the specific import job.
1248 */
1249 importId?: String;
1250 /**
1251 * The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field.
1252 */
1253 importStatus?: ImportStatus;
1254 /**
1255 * A string that describes why an import job failed to complete.
1256 */
1257 failureReason?: StringList;
1258 /**
1259 * A timestamp for the date and time that the import job was created.
1260 */
1261 createdDate?: Timestamp;
1262 }
1263 export interface GetIntentRequest {
1264 /**
1265 * The name of the intent. The name is case sensitive.
1266 */
1267 name: IntentName;
1268 /**
1269 * The version of the intent.
1270 */
1271 version: Version;
1272 }
1273 export interface GetIntentResponse {
1274 /**
1275 * The name of the intent.
1276 */
1277 name?: IntentName;
1278 /**
1279 * A description of the intent.
1280 */
1281 description?: Description;
1282 /**
1283 * An array of intent slots configured for the intent.
1284 */
1285 slots?: SlotList;
1286 /**
1287 * An array of sample utterances configured for the intent.
1288 */
1289 sampleUtterances?: IntentUtteranceList;
1290 /**
1291 * If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
1292 */
1293 confirmationPrompt?: Prompt;
1294 /**
1295 * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
1296 */
1297 rejectionStatement?: Statement;
1298 /**
1299 * If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.
1300 */
1301 followUpPrompt?: FollowUpPrompt;
1302 /**
1303 * After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.
1304 */
1305 conclusionStatement?: Statement;
1306 /**
1307 * If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
1308 */
1309 dialogCodeHook?: CodeHook;
1310 /**
1311 * Describes how the intent is fulfilled. For more information, see PutIntent.
1312 */
1313 fulfillmentActivity?: FulfillmentActivity;
1314 /**
1315 * A unique identifier for a built-in intent.
1316 */
1317 parentIntentSignature?: BuiltinIntentSignature;
1318 /**
1319 * The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
1320 */
1321 lastUpdatedDate?: Timestamp;
1322 /**
1323 * The date that the intent was created.
1324 */
1325 createdDate?: Timestamp;
1326 /**
1327 * The version of the intent.
1328 */
1329 version?: Version;
1330 /**
1331 * Checksum of the intent.
1332 */
1333 checksum?: String;
1334 }
1335 export interface GetIntentVersionsRequest {
1336 /**
1337 * The name of the intent for which versions should be returned.
1338 */
1339 name: IntentName;
1340 /**
1341 * 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.
1342 */
1343 nextToken?: NextToken;
1344 /**
1345 * The maximum number of intent versions to return in the response. The default is 10.
1346 */
1347 maxResults?: MaxResults;
1348 }
1349 export interface GetIntentVersionsResponse {
1350 /**
1351 * An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.
1352 */
1353 intents?: IntentMetadataList;
1354 /**
1355 * 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.
1356 */
1357 nextToken?: NextToken;
1358 }
1359 export interface GetIntentsRequest {
1360 /**
1361 * 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.
1362 */
1363 nextToken?: NextToken;
1364 /**
1365 * The maximum number of intents to return in the response. The default is 10.
1366 */
1367 maxResults?: MaxResults;
1368 /**
1369 * 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."
1370 */
1371 nameContains?: IntentName;
1372 }
1373 export interface GetIntentsResponse {
1374 /**
1375 * An array of Intent objects. For more information, see PutBot.
1376 */
1377 intents?: IntentMetadataList;
1378 /**
1379 * 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.
1380 */
1381 nextToken?: NextToken;
1382 }
1383 export interface GetSlotTypeRequest {
1384 /**
1385 * The name of the slot type. The name is case sensitive.
1386 */
1387 name: SlotTypeName;
1388 /**
1389 * The version of the slot type.
1390 */
1391 version: Version;
1392 }
1393 export interface GetSlotTypeResponse {
1394 /**
1395 * The name of the slot type.
1396 */
1397 name?: SlotTypeName;
1398 /**
1399 * A description of the slot type.
1400 */
1401 description?: Description;
1402 /**
1403 * A list of EnumerationValue objects that defines the values that the slot type can take.
1404 */
1405 enumerationValues?: EnumerationValues;
1406 /**
1407 * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
1408 */
1409 lastUpdatedDate?: Timestamp;
1410 /**
1411 * The date that the slot type was created.
1412 */
1413 createdDate?: Timestamp;
1414 /**
1415 * The version of the slot type.
1416 */
1417 version?: Version;
1418 /**
1419 * Checksum of the $LATEST version of the slot type.
1420 */
1421 checksum?: String;
1422 /**
1423 * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
1424 */
1425 valueSelectionStrategy?: SlotValueSelectionStrategy;
1426 /**
1427 * The built-in slot type used as a parent for the slot type.
1428 */
1429 parentSlotTypeSignature?: CustomOrBuiltinSlotTypeName;
1430 /**
1431 * Configuration information that extends the parent built-in slot type.
1432 */
1433 slotTypeConfigurations?: SlotTypeConfigurations;
1434 }
1435 export interface GetSlotTypeVersionsRequest {
1436 /**
1437 * The name of the slot type for which versions should be returned.
1438 */
1439 name: SlotTypeName;
1440 /**
1441 * 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.
1442 */
1443 nextToken?: NextToken;
1444 /**
1445 * The maximum number of slot type versions to return in the response. The default is 10.
1446 */
1447 maxResults?: MaxResults;
1448 }
1449 export interface GetSlotTypeVersionsResponse {
1450 /**
1451 * An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.
1452 */
1453 slotTypes?: SlotTypeMetadataList;
1454 /**
1455 * 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.
1456 */
1457 nextToken?: NextToken;
1458 }
1459 export interface GetSlotTypesRequest {
1460 /**
1461 * 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.
1462 */
1463 nextToken?: NextToken;
1464 /**
1465 * The maximum number of slot types to return in the response. The default is 10.
1466 */
1467 maxResults?: MaxResults;
1468 /**
1469 * 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."
1470 */
1471 nameContains?: SlotTypeName;
1472 }
1473 export interface GetSlotTypesResponse {
1474 /**
1475 * 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.
1476 */
1477 slotTypes?: SlotTypeMetadataList;
1478 /**
1479 * 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.
1480 */
1481 nextToken?: NextToken;
1482 }
1483 export interface GetUtterancesViewRequest {
1484 /**
1485 * The name of the bot for which utterance information should be returned.
1486 */
1487 botName: BotName;
1488 /**
1489 * An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
1490 */
1491 botVersions: BotVersions;
1492 /**
1493 * To return utterances that were recognized and handled, use Detected. To return utterances that were not recognized, use Missed.
1494 */
1495 statusType: StatusType;
1496 }
1497 export interface GetUtterancesViewResponse {
1498 /**
1499 * The name of the bot for which utterance information was returned.
1500 */
1501 botName?: BotName;
1502 /**
1503 * An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days.
1504 */
1505 utterances?: ListsOfUtterances;
1506 }
1507 export type GroupNumber = number;
1508 export type IamRoleArn = string;
1509 export type ImportStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
1510 export interface Intent {
1511 /**
1512 * The name of the intent.
1513 */
1514 intentName: IntentName;
1515 /**
1516 * The version of the intent.
1517 */
1518 intentVersion: Version;
1519 }
1520 export type IntentList = Intent[];
1521 export interface IntentMetadata {
1522 /**
1523 * The name of the intent.
1524 */
1525 name?: IntentName;
1526 /**
1527 * A description of the intent.
1528 */
1529 description?: Description;
1530 /**
1531 * The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
1532 */
1533 lastUpdatedDate?: Timestamp;
1534 /**
1535 * The date that the intent was created.
1536 */
1537 createdDate?: Timestamp;
1538 /**
1539 * The version of the intent.
1540 */
1541 version?: Version;
1542 }
1543 export type IntentMetadataList = IntentMetadata[];
1544 export type IntentName = string;
1545 export type IntentUtteranceList = Utterance[];
1546 export type KmsKeyArn = string;
1547 export type LambdaARN = string;
1548 export type ListOfUtterance = UtteranceData[];
1549 export interface ListTagsForResourceRequest {
1550 /**
1551 * The Amazon Resource Name (ARN) of the resource to get a list of tags for.
1552 */
1553 resourceArn: AmazonResourceName;
1554 }
1555 export interface ListTagsForResourceResponse {
1556 /**
1557 * The tags associated with a resource.
1558 */
1559 tags?: TagList;
1560 }
1561 export type ListsOfUtterances = UtteranceList[];
1562 export type Locale = "en-US"|"en-GB"|"de-DE"|string;
1563 export type LocaleList = Locale[];
1564 export interface LogSettingsRequest {
1565 /**
1566 * The type of logging to enable. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
1567 */
1568 logType: LogType;
1569 /**
1570 * Where the logs will be delivered. Text logs are delivered to a CloudWatch Logs log group. Audio logs are delivered to an S3 bucket.
1571 */
1572 destination: Destination;
1573 /**
1574 * 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.
1575 */
1576 kmsKeyArn?: KmsKeyArn;
1577 /**
1578 * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs should be delivered.
1579 */
1580 resourceArn: ResourceArn;
1581 }
1582 export type LogSettingsRequestList = LogSettingsRequest[];
1583 export interface LogSettingsResponse {
1584 /**
1585 * The type of logging that is enabled.
1586 */
1587 logType?: LogType;
1588 /**
1589 * The destination where logs are delivered.
1590 */
1591 destination?: Destination;
1592 /**
1593 * The Amazon Resource Name (ARN) of the key used to encrypt audio logs in an S3 bucket.
1594 */
1595 kmsKeyArn?: KmsKeyArn;
1596 /**
1597 * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or S3 bucket where the logs are delivered.
1598 */
1599 resourceArn?: ResourceArn;
1600 /**
1601 * 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.
1602 */
1603 resourcePrefix?: ResourcePrefix;
1604 }
1605 export type LogSettingsResponseList = LogSettingsResponse[];
1606 export type LogType = "AUDIO"|"TEXT"|string;
1607 export type MaxResults = number;
1608 export type MergeStrategy = "OVERWRITE_LATEST"|"FAIL_ON_CONFLICT"|string;
1609 export interface Message {
1610 /**
1611 * The content type of the message string.
1612 */
1613 contentType: ContentType;
1614 /**
1615 * The text of the message.
1616 */
1617 content: ContentString;
1618 /**
1619 * 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.
1620 */
1621 groupNumber?: GroupNumber;
1622 }
1623 export type MessageList = Message[];
1624 export type MessageVersion = string;
1625 export type Name = string;
1626 export type NextToken = string;
1627 export type NumericalVersion = string;
1628 export type ObfuscationSetting = "NONE"|"DEFAULT_OBFUSCATION"|string;
1629 export type Priority = number;
1630 export type ProcessBehavior = "SAVE"|"BUILD"|string;
1631 export interface Prompt {
1632 /**
1633 * 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).
1634 */
1635 messages: MessageList;
1636 /**
1637 * The number of times to prompt the user for information.
1638 */
1639 maxAttempts: PromptMaxAttempts;
1640 /**
1641 * A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.
1642 */
1643 responseCard?: ResponseCard;
1644 }
1645 export type PromptMaxAttempts = number;
1646 export interface PutBotAliasRequest {
1647 /**
1648 * The name of the alias. The name is not case sensitive.
1649 */
1650 name: AliasName;
1651 /**
1652 * A description of the alias.
1653 */
1654 description?: Description;
1655 /**
1656 * The version of the bot.
1657 */
1658 botVersion: Version;
1659 /**
1660 * The name of the bot.
1661 */
1662 botName: BotName;
1663 /**
1664 * Identifies a specific revision of the $LATEST version. When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
1665 */
1666 checksum?: String;
1667 /**
1668 * Settings for conversation logs for the alias.
1669 */
1670 conversationLogs?: ConversationLogsRequest;
1671 /**
1672 * 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 PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.
1673 */
1674 tags?: TagList;
1675 }
1676 export interface PutBotAliasResponse {
1677 /**
1678 * The name of the alias.
1679 */
1680 name?: AliasName;
1681 /**
1682 * A description of the alias.
1683 */
1684 description?: Description;
1685 /**
1686 * The version of the bot that the alias points to.
1687 */
1688 botVersion?: Version;
1689 /**
1690 * The name of the bot that the alias points to.
1691 */
1692 botName?: BotName;
1693 /**
1694 * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
1695 */
1696 lastUpdatedDate?: Timestamp;
1697 /**
1698 * The date that the bot alias was created.
1699 */
1700 createdDate?: Timestamp;
1701 /**
1702 * The checksum for the current version of the alias.
1703 */
1704 checksum?: String;
1705 /**
1706 * The settings that determine how Amazon Lex uses conversation logs for the alias.
1707 */
1708 conversationLogs?: ConversationLogsResponse;
1709 /**
1710 * A list of tags associated with a bot.
1711 */
1712 tags?: TagList;
1713 }
1714 export interface PutBotRequest {
1715 /**
1716 * The name of the bot. The name is not case sensitive.
1717 */
1718 name: BotName;
1719 /**
1720 * A description of the bot.
1721 */
1722 description?: Description;
1723 /**
1724 * An array of Intent 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 how-it-works.
1725 */
1726 intents?: IntentList;
1727 /**
1728 * 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 maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field. 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.'" If you have defined a fallback intent, it will be invoked if the clarification prompt is repeated the number of times defined in the maxAttempts field. For more information, see AMAZON.FallbackIntent. If you don't define a clarification prompt, at runtime Amazon Lex will return a 400 Bad Request exception in three cases: 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. Lambda function - When using a Lambda function, you return an ElicitIntent 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. PutSession operation - When using the PutSession operation, you send an ElicitIntent 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.
1729 */
1730 clarificationPrompt?: Prompt;
1731 /**
1732 * 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 abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type. 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. For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot. If you have defined a fallback intent the abort statement will not be sent to the user, the fallback intent is used instead. For more information, see AMAZON.FallbackIntent.
1733 */
1734 abortStatement?: Statement;
1735 /**
1736 * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. 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. 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. If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot. The default is 300 seconds (5 minutes).
1737 */
1738 idleSessionTTLInSeconds?: SessionTTL;
1739 /**
1740 * 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 Voices in Amazon Polly in the Amazon Polly Developer Guide.
1741 */
1742 voiceId?: String;
1743 /**
1744 * Identifies a specific revision of the $LATEST version. When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
1745 */
1746 checksum?: String;
1747 /**
1748 * If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it. If you don't specify this value, the default value is BUILD.
1749 */
1750 processBehavior?: ProcessBehavior;
1751 /**
1752 * Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot. The default is en-US.
1753 */
1754 locale: Locale;
1755 /**
1756 * 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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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. 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 Amazon Lex FAQ.
1757 */
1758 childDirected: Boolean;
1759 /**
1760 * When set to true user utterances are sent to Amazon Comprehend for sentiment analysis. If you don't specify detectSentiment, the default is false.
1761 */
1762 detectSentiment?: Boolean;
1763 /**
1764 * When set to true a new numbered version of the bot is created. This is the same as calling the CreateBotVersion operation. If you don't specify createVersion, the default is false.
1765 */
1766 createVersion?: Boolean;
1767 /**
1768 * A list of tags to add to the bot. You can only add tags when you create a bot, you can't use the PutBot operation to update the tags on a bot. To update tags, use the TagResource operation.
1769 */
1770 tags?: TagList;
1771 }
1772 export interface PutBotResponse {
1773 /**
1774 * The name of the bot.
1775 */
1776 name?: BotName;
1777 /**
1778 * A description of the bot.
1779 */
1780 description?: Description;
1781 /**
1782 * An array of Intent objects. For more information, see PutBot.
1783 */
1784 intents?: IntentList;
1785 /**
1786 * The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
1787 */
1788 clarificationPrompt?: Prompt;
1789 /**
1790 * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
1791 */
1792 abortStatement?: Statement;
1793 /**
1794 * When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING. In the READY_BASIC_TESTING 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. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element. When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT. When the bot is in the READY state you can test and publish the bot.
1795 */
1796 status?: Status;
1797 /**
1798 * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
1799 */
1800 failureReason?: String;
1801 /**
1802 * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
1803 */
1804 lastUpdatedDate?: Timestamp;
1805 /**
1806 * The date that the bot was created.
1807 */
1808 createdDate?: Timestamp;
1809 /**
1810 * The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
1811 */
1812 idleSessionTTLInSeconds?: SessionTTL;
1813 /**
1814 * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
1815 */
1816 voiceId?: String;
1817 /**
1818 * Checksum of the bot that you created.
1819 */
1820 checksum?: String;
1821 /**
1822 * The version of the bot. For a new bot, the version is always $LATEST.
1823 */
1824 version?: Version;
1825 /**
1826 * The target locale for the bot.
1827 */
1828 locale?: Locale;
1829 /**
1830 * 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 true or false in the childDirected field. By specifying true in the childDirected field, you confirm that 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. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not 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 childDirected 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. 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 Amazon Lex FAQ.
1831 */
1832 childDirected?: Boolean;
1833 /**
1834 * True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
1835 */
1836 createVersion?: Boolean;
1837 /**
1838 * true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.
1839 */
1840 detectSentiment?: Boolean;
1841 /**
1842 * A list of tags associated with the bot.
1843 */
1844 tags?: TagList;
1845 }
1846 export interface PutIntentRequest {
1847 /**
1848 * The name of the intent. The name is not case sensitive. 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 AMAZON.HelpIntent, you can't create a custom intent called HelpIntent. For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.
1849 */
1850 name: IntentName;
1851 /**
1852 * A description of the intent.
1853 */
1854 description?: Description;
1855 /**
1856 * 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 how-it-works.
1857 */
1858 slots?: SlotList;
1859 /**
1860 * An array of utterances (strings) that a user might say to signal the intent. For example, "I want {PizzaSize} pizza", "Order {Quantity} {PizzaSize} pizzas". In each utterance, a slot name is enclosed in curly braces.
1861 */
1862 sampleUtterances?: IntentUtteranceList;
1863 /**
1864 * Prompts the user to confirm the intent. This question should have a yes or no answer. Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information. You you must provide both the rejectionStatement and the confirmationPrompt, or neither.
1865 */
1866 confirmationPrompt?: Prompt;
1867 /**
1868 * When the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled. You must provide both the rejectionStatement and the confirmationPrompt, or neither.
1869 */
1870 rejectionStatement?: Statement;
1871 /**
1872 * Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink. The action that Amazon Lex takes depends on the user's response, as follows: If the user says "Yes" it responds with the clarification prompt that is configured for the bot. if the user says "Yes" and continues with an utterance that triggers an intent it starts a conversation for the intent. If the user says "No" it responds with the rejection statement configured for the the follow-up prompt. If it doesn't recognize the utterance it repeats the follow-up prompt again. The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.
1873 */
1874 followUpPrompt?: FollowUpPrompt;
1875 /**
1876 * The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element. The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.
1877 */
1878 conclusionStatement?: Statement;
1879 /**
1880 * Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction. 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, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.
1881 */
1882 dialogCodeHook?: CodeHook;
1883 /**
1884 * Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store. 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).
1885 */
1886 fulfillmentActivity?: FulfillmentActivity;
1887 /**
1888 * A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.
1889 */
1890 parentIntentSignature?: BuiltinIntentSignature;
1891 /**
1892 * Identifies a specific revision of the $LATEST version. When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
1893 */
1894 checksum?: String;
1895 /**
1896 * When set to true a new numbered version of the intent is created. This is the same as calling the CreateIntentVersion operation. If you do not specify createVersion, the default is false.
1897 */
1898 createVersion?: Boolean;
1899 }
1900 export interface PutIntentResponse {
1901 /**
1902 * The name of the intent.
1903 */
1904 name?: IntentName;
1905 /**
1906 * A description of the intent.
1907 */
1908 description?: Description;
1909 /**
1910 * An array of intent slots that are configured for the intent.
1911 */
1912 slots?: SlotList;
1913 /**
1914 * An array of sample utterances that are configured for the intent.
1915 */
1916 sampleUtterances?: IntentUtteranceList;
1917 /**
1918 * If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
1919 */
1920 confirmationPrompt?: Prompt;
1921 /**
1922 * If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.
1923 */
1924 rejectionStatement?: Statement;
1925 /**
1926 * If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
1927 */
1928 followUpPrompt?: FollowUpPrompt;
1929 /**
1930 * After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.
1931 */
1932 conclusionStatement?: Statement;
1933 /**
1934 * If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
1935 */
1936 dialogCodeHook?: CodeHook;
1937 /**
1938 * 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.
1939 */
1940 fulfillmentActivity?: FulfillmentActivity;
1941 /**
1942 * A unique identifier for the built-in intent that this intent is based on.
1943 */
1944 parentIntentSignature?: BuiltinIntentSignature;
1945 /**
1946 * The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.
1947 */
1948 lastUpdatedDate?: Timestamp;
1949 /**
1950 * The date that the intent was created.
1951 */
1952 createdDate?: Timestamp;
1953 /**
1954 * The version of the intent. For a new intent, the version is always $LATEST.
1955 */
1956 version?: Version;
1957 /**
1958 * Checksum of the $LATESTversion of the intent created or updated.
1959 */
1960 checksum?: String;
1961 /**
1962 * True if a new version of the intent was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
1963 */
1964 createVersion?: Boolean;
1965 }
1966 export interface PutSlotTypeRequest {
1967 /**
1968 * The name of the slot type. The name is not case sensitive. 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 AMAZON.DATE, you can't create a custom slot type called DATE. For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.
1969 */
1970 name: SlotTypeName;
1971 /**
1972 * A description of the slot type.
1973 */
1974 description?: Description;
1975 /**
1976 * A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot. 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 valueSelectionStrategy field indicates the option to use.
1977 */
1978 enumerationValues?: EnumerationValues;
1979 /**
1980 * Identifies a specific revision of the $LATEST version. When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception. When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.
1981 */
1982 checksum?: String;
1983 /**
1984 * 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: ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value. TOP_RESOLUTION - 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. If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.
1985 */
1986 valueSelectionStrategy?: SlotValueSelectionStrategy;
1987 /**
1988 * When set to true a new numbered version of the slot type is created. This is the same as calling the CreateSlotTypeVersion operation. If you do not specify createVersion, the default is false.
1989 */
1990 createVersion?: Boolean;
1991 /**
1992 * 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. Only AMAZON.AlphaNumeric is supported.
1993 */
1994 parentSlotTypeSignature?: CustomOrBuiltinSlotTypeName;
1995 /**
1996 * Configuration information that extends the parent built-in slot type. The configuration is added to the settings for the parent slot type.
1997 */
1998 slotTypeConfigurations?: SlotTypeConfigurations;
1999 }
2000 export interface PutSlotTypeResponse {
2001 /**
2002 * The name of the slot type.
2003 */
2004 name?: SlotTypeName;
2005 /**
2006 * A description of the slot type.
2007 */
2008 description?: Description;
2009 /**
2010 * A list of EnumerationValue objects that defines the values that the slot type can take.
2011 */
2012 enumerationValues?: EnumerationValues;
2013 /**
2014 * The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
2015 */
2016 lastUpdatedDate?: Timestamp;
2017 /**
2018 * The date that the slot type was created.
2019 */
2020 createdDate?: Timestamp;
2021 /**
2022 * The version of the slot type. For a new slot type, the version is always $LATEST.
2023 */
2024 version?: Version;
2025 /**
2026 * Checksum of the $LATEST version of the slot type.
2027 */
2028 checksum?: String;
2029 /**
2030 * The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
2031 */
2032 valueSelectionStrategy?: SlotValueSelectionStrategy;
2033 /**
2034 * True if a new version of the slot type was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.
2035 */
2036 createVersion?: Boolean;
2037 /**
2038 * The built-in slot type used as the parent of the slot type.
2039 */
2040 parentSlotTypeSignature?: CustomOrBuiltinSlotTypeName;
2041 /**
2042 * Configuration information that extends the parent built-in slot type.
2043 */
2044 slotTypeConfigurations?: SlotTypeConfigurations;
2045 }
2046 export type RegexPattern = string;
2047 export type ResourceArn = string;
2048 export type ResourcePrefix = string;
2049 export type ResourceType = "BOT"|"INTENT"|"SLOT_TYPE"|string;
2050 export type ResponseCard = string;
2051 export type SessionTTL = number;
2052 export interface Slot {
2053 /**
2054 * The name of the slot.
2055 */
2056 name: SlotName;
2057 /**
2058 * A description of the slot.
2059 */
2060 description?: Description;
2061 /**
2062 * Specifies whether the slot is required or optional.
2063 */
2064 slotConstraint: SlotConstraint;
2065 /**
2066 * The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
2067 */
2068 slotType?: CustomOrBuiltinSlotTypeName;
2069 /**
2070 * The version of the slot type.
2071 */
2072 slotTypeVersion?: Version;
2073 /**
2074 * The prompt that Amazon Lex uses to elicit the slot value from the user.
2075 */
2076 valueElicitationPrompt?: Prompt;
2077 /**
2078 * Directs 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 Lex first elicits a value for the slot with priority 1. If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.
2079 */
2080 priority?: Priority;
2081 /**
2082 * 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.
2083 */
2084 sampleUtterances?: SlotUtteranceList;
2085 /**
2086 * 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.
2087 */
2088 responseCard?: ResponseCard;
2089 /**
2090 * 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 Slot Obfuscation .
2091 */
2092 obfuscationSetting?: ObfuscationSetting;
2093 }
2094 export type SlotConstraint = "Required"|"Optional"|string;
2095 export type SlotList = Slot[];
2096 export type SlotName = string;
2097 export interface SlotTypeConfiguration {
2098 /**
2099 * A regular expression used to validate the value of a slot.
2100 */
2101 regexConfiguration?: SlotTypeRegexConfiguration;
2102 }
2103 export type SlotTypeConfigurations = SlotTypeConfiguration[];
2104 export interface SlotTypeMetadata {
2105 /**
2106 * The name of the slot type.
2107 */
2108 name?: SlotTypeName;
2109 /**
2110 * A description of the slot type.
2111 */
2112 description?: Description;
2113 /**
2114 * The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
2115 */
2116 lastUpdatedDate?: Timestamp;
2117 /**
2118 * The date that the slot type was created.
2119 */
2120 createdDate?: Timestamp;
2121 /**
2122 * The version of the slot type.
2123 */
2124 version?: Version;
2125 }
2126 export type SlotTypeMetadataList = SlotTypeMetadata[];
2127 export type SlotTypeName = string;
2128 export interface SlotTypeRegexConfiguration {
2129 /**
2130 * A regular expression used to validate the value of a slot. Use a standard regular expression. Amazon Lex supports the following characters in the regular expression: A-Z, a-z 0-9 Unicode characters ("\ u&lt;Unicode&gt;") Represent Unicode characters with four digits, for example "\u0041" or "\u005A". The following regular expression operators are not supported: Infinite repeaters: *, +, or {x,} with no upper bound. Wild card (.)
2131 */
2132 pattern: RegexPattern;
2133 }
2134 export type SlotUtteranceList = Utterance[];
2135 export type SlotValueSelectionStrategy = "ORIGINAL_VALUE"|"TOP_RESOLUTION"|string;
2136 export interface StartImportRequest {
2137 /**
2138 * 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 resourceType field.
2139 */
2140 payload: _Blob;
2141 /**
2142 * Specifies the type of resource to export. Each resource also exports any resources that it depends on. A bot exports dependent intents. An intent exports dependent slot types.
2143 */
2144 resourceType: ResourceType;
2145 /**
2146 * Specifies the action that the StartImport operation should take when there is an existing resource with the same name. 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 failureReason field of the response to the GetImport operation. 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.
2147 */
2148 mergeStrategy: MergeStrategy;
2149 /**
2150 * 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.
2151 */
2152 tags?: TagList;
2153 }
2154 export interface StartImportResponse {
2155 /**
2156 * The name given to the import job.
2157 */
2158 name?: Name;
2159 /**
2160 * The type of resource to import.
2161 */
2162 resourceType?: ResourceType;
2163 /**
2164 * The action to take when there is a merge conflict.
2165 */
2166 mergeStrategy?: MergeStrategy;
2167 /**
2168 * The identifier for the specific import job.
2169 */
2170 importId?: String;
2171 /**
2172 * The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.
2173 */
2174 importStatus?: ImportStatus;
2175 /**
2176 * A list of tags added to the imported bot.
2177 */
2178 tags?: TagList;
2179 /**
2180 * A timestamp for the date and time that the import job was requested.
2181 */
2182 createdDate?: Timestamp;
2183 }
2184 export interface Statement {
2185 /**
2186 * A collection of message objects.
2187 */
2188 messages: MessageList;
2189 /**
2190 * At runtime, if the client is using the PostText 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.
2191 */
2192 responseCard?: ResponseCard;
2193 }
2194 export type Status = "BUILDING"|"READY"|"READY_BASIC_TESTING"|"FAILED"|"NOT_BUILT"|string;
2195 export type StatusType = "Detected"|"Missed"|string;
2196 export type String = string;
2197 export type StringList = String[];
2198 export type SynonymList = Value[];
2199 export interface Tag {
2200 /**
2201 * The key for the tag. Keys are not case-sensitive and must be unique.
2202 */
2203 key: TagKey;
2204 /**
2205 * The value associated with a key. The value may be an empty string but it can't be null.
2206 */
2207 value: TagValue;
2208 }
2209 export type TagKey = string;
2210 export type TagKeyList = TagKey[];
2211 export type TagList = Tag[];
2212 export interface TagResourceRequest {
2213 /**
2214 * The Amazon Resource Name (ARN) of the bot, bot alias, or bot channel to tag.
2215 */
2216 resourceArn: AmazonResourceName;
2217 /**
2218 * 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.
2219 */
2220 tags: TagList;
2221 }
2222 export interface TagResourceResponse {
2223 }
2224 export type TagValue = string;
2225 export type Timestamp = Date;
2226 export interface UntagResourceRequest {
2227 /**
2228 * The Amazon Resource Name (ARN) of the resource to remove the tags from.
2229 */
2230 resourceArn: AmazonResourceName;
2231 /**
2232 * A list of tag keys to remove from the resource. If a tag key does not exist on the resource, it is ignored.
2233 */
2234 tagKeys: TagKeyList;
2235 }
2236 export interface UntagResourceResponse {
2237 }
2238 export type UserId = string;
2239 export type Utterance = string;
2240 export interface UtteranceData {
2241 /**
2242 * The text that was entered by the user or the text representation of an audio clip.
2243 */
2244 utteranceString?: UtteranceString;
2245 /**
2246 * The number of times that the utterance was processed.
2247 */
2248 count?: Count;
2249 /**
2250 * The total number of individuals that used the utterance.
2251 */
2252 distinctUsers?: Count;
2253 /**
2254 * The date that the utterance was first recorded.
2255 */
2256 firstUtteredDate?: Timestamp;
2257 /**
2258 * The date that the utterance was last recorded.
2259 */
2260 lastUtteredDate?: Timestamp;
2261 }
2262 export interface UtteranceList {
2263 /**
2264 * The version of the bot that processed the list.
2265 */
2266 botVersion?: Version;
2267 /**
2268 * One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.
2269 */
2270 utterances?: ListOfUtterance;
2271 }
2272 export type UtteranceString = string;
2273 export type Value = string;
2274 export type Version = string;
2275 /**
2276 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2277 */
2278 export type apiVersion = "2017-04-19"|"latest"|string;
2279 export interface ClientApiVersions {
2280 /**
2281 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2282 */
2283 apiVersion?: apiVersion;
2284 }
2285 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2286 /**
2287 * Contains interfaces for use with the LexModelBuildingService client.
2288 */
2289 export import Types = LexModelBuildingService;
2290}
2291export = LexModelBuildingService;