UNPKG

122 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. 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. 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 DeleteStoredUtterances operation to manually delete stored utterances for a specific user. 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 DeleteStoredUtterances operation to manually delete stored utterances for a specific user. 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 in each request. The response contains information about a maximum of 100 utterances for each version. 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 in each request. The response contains information about a maximum of 100 utterances for each version. 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 * 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 auth-and-access-control.
264 */
265 putBot(params: LexModelBuildingService.Types.PutBotRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
266 /**
267 * 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 auth-and-access-control.
268 */
269 putBot(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotResponse) => void): Request<LexModelBuildingService.Types.PutBotResponse, AWSError>;
270 /**
271 * 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.
272 */
273 putBotAlias(params: LexModelBuildingService.Types.PutBotAliasRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
274 /**
275 * 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.
276 */
277 putBotAlias(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutBotAliasResponse) => void): Request<LexModelBuildingService.Types.PutBotAliasResponse, AWSError>;
278 /**
279 * 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.
280 */
281 putIntent(params: LexModelBuildingService.Types.PutIntentRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
282 /**
283 * 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.
284 */
285 putIntent(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutIntentResponse) => void): Request<LexModelBuildingService.Types.PutIntentResponse, AWSError>;
286 /**
287 * 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.
288 */
289 putSlotType(params: LexModelBuildingService.Types.PutSlotTypeRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
290 /**
291 * 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.
292 */
293 putSlotType(callback?: (err: AWSError, data: LexModelBuildingService.Types.PutSlotTypeResponse) => void): Request<LexModelBuildingService.Types.PutSlotTypeResponse, AWSError>;
294 /**
295 * Starts a job to import a resource to Amazon Lex.
296 */
297 startImport(params: LexModelBuildingService.Types.StartImportRequest, callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
298 /**
299 * Starts a job to import a resource to Amazon Lex.
300 */
301 startImport(callback?: (err: AWSError, data: LexModelBuildingService.Types.StartImportResponse) => void): Request<LexModelBuildingService.Types.StartImportResponse, AWSError>;
302}
303declare namespace LexModelBuildingService {
304 export type AliasName = string;
305 export type AliasNameOrListAll = string;
306 export type _Blob = Buffer|Uint8Array|Blob|string;
307 export type Boolean = boolean;
308 export interface BotAliasMetadata {
309 /**
310 * The name of the bot alias.
311 */
312 name?: AliasName;
313 /**
314 * A description of the bot alias.
315 */
316 description?: Description;
317 /**
318 * The version of the Amazon Lex bot to which the alias points.
319 */
320 botVersion?: Version;
321 /**
322 * The name of the bot to which the alias points.
323 */
324 botName?: BotName;
325 /**
326 * The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.
327 */
328 lastUpdatedDate?: Timestamp;
329 /**
330 * The date that the bot alias was created.
331 */
332 createdDate?: Timestamp;
333 /**
334 * Checksum of the bot alias.
335 */
336 checksum?: String;
337 }
338 export type BotAliasMetadataList = BotAliasMetadata[];
339 export interface BotChannelAssociation {
340 /**
341 * The name of the association between the bot and the channel.
342 */
343 name?: BotChannelName;
344 /**
345 * A text description of the association you are creating.
346 */
347 description?: Description;
348 /**
349 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
350 */
351 botAlias?: AliasName;
352 /**
353 * 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.
354 */
355 botName?: BotName;
356 /**
357 * The date that the association between the Amazon Lex bot and the channel was created.
358 */
359 createdDate?: Timestamp;
360 /**
361 * Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.
362 */
363 type?: ChannelType;
364 /**
365 * Provides information necessary to communicate with the messaging platform.
366 */
367 botConfiguration?: ChannelConfigurationMap;
368 /**
369 * 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.
370 */
371 status?: ChannelStatus;
372 /**
373 * If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
374 */
375 failureReason?: String;
376 }
377 export type BotChannelAssociationList = BotChannelAssociation[];
378 export type BotChannelName = string;
379 export interface BotMetadata {
380 /**
381 * The name of the bot.
382 */
383 name?: BotName;
384 /**
385 * A description of the bot.
386 */
387 description?: Description;
388 /**
389 * The status of the bot.
390 */
391 status?: Status;
392 /**
393 * The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.
394 */
395 lastUpdatedDate?: Timestamp;
396 /**
397 * The date that the bot was created.
398 */
399 createdDate?: Timestamp;
400 /**
401 * The version of the bot. For a new bot, the version is always $LATEST.
402 */
403 version?: Version;
404 }
405 export type BotMetadataList = BotMetadata[];
406 export type BotName = string;
407 export type BotVersions = Version[];
408 export interface BuiltinIntentMetadata {
409 /**
410 * 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.
411 */
412 signature?: BuiltinIntentSignature;
413 /**
414 * A list of identifiers for the locales that the intent supports.
415 */
416 supportedLocales?: LocaleList;
417 }
418 export type BuiltinIntentMetadataList = BuiltinIntentMetadata[];
419 export type BuiltinIntentSignature = string;
420 export interface BuiltinIntentSlot {
421 /**
422 * A list of the slots defined for the intent.
423 */
424 name?: String;
425 }
426 export type BuiltinIntentSlotList = BuiltinIntentSlot[];
427 export interface BuiltinSlotTypeMetadata {
428 /**
429 * 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.
430 */
431 signature?: BuiltinSlotTypeSignature;
432 /**
433 * A list of target locales for the slot.
434 */
435 supportedLocales?: LocaleList;
436 }
437 export type BuiltinSlotTypeMetadataList = BuiltinSlotTypeMetadata[];
438 export type BuiltinSlotTypeSignature = string;
439 export type ChannelConfigurationMap = {[key: string]: String};
440 export type ChannelStatus = "IN_PROGRESS"|"CREATED"|"FAILED"|string;
441 export type ChannelType = "Facebook"|"Slack"|"Twilio-Sms"|"Kik"|string;
442 export interface CodeHook {
443 /**
444 * The Amazon Resource Name (ARN) of the Lambda function.
445 */
446 uri: LambdaARN;
447 /**
448 * The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.
449 */
450 messageVersion: MessageVersion;
451 }
452 export type ContentString = string;
453 export type ContentType = "PlainText"|"SSML"|"CustomPayload"|string;
454 export type Count = number;
455 export interface CreateBotVersionRequest {
456 /**
457 * The name of the bot that you want to create a new version of. The name is case sensitive.
458 */
459 name: BotName;
460 /**
461 * 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.
462 */
463 checksum?: String;
464 }
465 export interface CreateBotVersionResponse {
466 /**
467 * The name of the bot.
468 */
469 name?: BotName;
470 /**
471 * A description of the bot.
472 */
473 description?: Description;
474 /**
475 * An array of Intent objects. For more information, see PutBot.
476 */
477 intents?: IntentList;
478 /**
479 * The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
480 */
481 clarificationPrompt?: Prompt;
482 /**
483 * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
484 */
485 abortStatement?: Statement;
486 /**
487 * 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.
488 */
489 status?: Status;
490 /**
491 * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
492 */
493 failureReason?: String;
494 /**
495 * The date when the $LATEST version of this bot was updated.
496 */
497 lastUpdatedDate?: Timestamp;
498 /**
499 * The date when the bot version was created.
500 */
501 createdDate?: Timestamp;
502 /**
503 * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
504 */
505 idleSessionTTLInSeconds?: SessionTTL;
506 /**
507 * The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
508 */
509 voiceId?: String;
510 /**
511 * Checksum identifying the version of the bot that was created.
512 */
513 checksum?: String;
514 /**
515 * The version of the bot.
516 */
517 version?: Version;
518 /**
519 * Specifies the target locale for the bot.
520 */
521 locale?: Locale;
522 /**
523 * 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.
524 */
525 childDirected?: Boolean;
526 }
527 export interface CreateIntentVersionRequest {
528 /**
529 * The name of the intent that you want to create a new version of. The name is case sensitive.
530 */
531 name: IntentName;
532 /**
533 * 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.
534 */
535 checksum?: String;
536 }
537 export interface CreateIntentVersionResponse {
538 /**
539 * The name of the intent.
540 */
541 name?: IntentName;
542 /**
543 * A description of the intent.
544 */
545 description?: Description;
546 /**
547 * An array of slot types that defines the information required to fulfill the intent.
548 */
549 slots?: SlotList;
550 /**
551 * An array of sample utterances configured for the intent.
552 */
553 sampleUtterances?: IntentUtteranceList;
554 /**
555 * If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.
556 */
557 confirmationPrompt?: Prompt;
558 /**
559 * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
560 */
561 rejectionStatement?: Statement;
562 /**
563 * If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
564 */
565 followUpPrompt?: FollowUpPrompt;
566 /**
567 * After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.
568 */
569 conclusionStatement?: Statement;
570 /**
571 * If defined, Amazon Lex invokes this Lambda function for each user input.
572 */
573 dialogCodeHook?: CodeHook;
574 /**
575 * Describes how the intent is fulfilled.
576 */
577 fulfillmentActivity?: FulfillmentActivity;
578 /**
579 * A unique identifier for a built-in intent.
580 */
581 parentIntentSignature?: BuiltinIntentSignature;
582 /**
583 * The date that the intent was updated.
584 */
585 lastUpdatedDate?: Timestamp;
586 /**
587 * The date that the intent was created.
588 */
589 createdDate?: Timestamp;
590 /**
591 * The version number assigned to the new version of the intent.
592 */
593 version?: Version;
594 /**
595 * Checksum of the intent version created.
596 */
597 checksum?: String;
598 }
599 export interface CreateSlotTypeVersionRequest {
600 /**
601 * The name of the slot type that you want to create a new version for. The name is case sensitive.
602 */
603 name: SlotTypeName;
604 /**
605 * 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.
606 */
607 checksum?: String;
608 }
609 export interface CreateSlotTypeVersionResponse {
610 /**
611 * The name of the slot type.
612 */
613 name?: SlotTypeName;
614 /**
615 * A description of the slot type.
616 */
617 description?: Description;
618 /**
619 * A list of EnumerationValue objects that defines the values that the slot type can take.
620 */
621 enumerationValues?: EnumerationValues;
622 /**
623 * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
624 */
625 lastUpdatedDate?: Timestamp;
626 /**
627 * The date that the slot type was created.
628 */
629 createdDate?: Timestamp;
630 /**
631 * The version assigned to the new slot type version.
632 */
633 version?: Version;
634 /**
635 * Checksum of the $LATEST version of the slot type.
636 */
637 checksum?: String;
638 /**
639 * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
640 */
641 valueSelectionStrategy?: SlotValueSelectionStrategy;
642 }
643 export type CustomOrBuiltinSlotTypeName = string;
644 export interface DeleteBotAliasRequest {
645 /**
646 * The name of the alias to delete. The name is case sensitive.
647 */
648 name: AliasName;
649 /**
650 * The name of the bot that the alias points to.
651 */
652 botName: BotName;
653 }
654 export interface DeleteBotChannelAssociationRequest {
655 /**
656 * The name of the association. The name is case sensitive.
657 */
658 name: BotChannelName;
659 /**
660 * The name of the Amazon Lex bot.
661 */
662 botName: BotName;
663 /**
664 * An alias that points to the specific version of the Amazon Lex bot to which this association is being made.
665 */
666 botAlias: AliasName;
667 }
668 export interface DeleteBotRequest {
669 /**
670 * The name of the bot. The name is case sensitive.
671 */
672 name: BotName;
673 }
674 export interface DeleteBotVersionRequest {
675 /**
676 * The name of the bot.
677 */
678 name: BotName;
679 /**
680 * 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.
681 */
682 version: NumericalVersion;
683 }
684 export interface DeleteIntentRequest {
685 /**
686 * The name of the intent. The name is case sensitive.
687 */
688 name: IntentName;
689 }
690 export interface DeleteIntentVersionRequest {
691 /**
692 * The name of the intent.
693 */
694 name: IntentName;
695 /**
696 * 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.
697 */
698 version: NumericalVersion;
699 }
700 export interface DeleteSlotTypeRequest {
701 /**
702 * The name of the slot type. The name is case sensitive.
703 */
704 name: SlotTypeName;
705 }
706 export interface DeleteSlotTypeVersionRequest {
707 /**
708 * The name of the slot type.
709 */
710 name: SlotTypeName;
711 /**
712 * 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.
713 */
714 version: NumericalVersion;
715 }
716 export interface DeleteUtterancesRequest {
717 /**
718 * The name of the bot that stored the utterances.
719 */
720 botName: BotName;
721 /**
722 * 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.
723 */
724 userId: UserId;
725 }
726 export type Description = string;
727 export interface EnumerationValue {
728 /**
729 * The value of the slot type.
730 */
731 value: Value;
732 /**
733 * Additional values related to the slot type value.
734 */
735 synonyms?: SynonymList;
736 }
737 export type EnumerationValues = EnumerationValue[];
738 export type ExportStatus = "IN_PROGRESS"|"READY"|"FAILED"|string;
739 export type ExportType = "ALEXA_SKILLS_KIT"|"LEX"|string;
740 export interface FollowUpPrompt {
741 /**
742 * Prompts for information from the user.
743 */
744 prompt: Prompt;
745 /**
746 * 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.
747 */
748 rejectionStatement: Statement;
749 }
750 export interface FulfillmentActivity {
751 /**
752 * How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.
753 */
754 type: FulfillmentActivityType;
755 /**
756 * A description of the Lambda function that is run to fulfill the intent.
757 */
758 codeHook?: CodeHook;
759 }
760 export type FulfillmentActivityType = "ReturnIntent"|"CodeHook"|string;
761 export interface GetBotAliasRequest {
762 /**
763 * The name of the bot alias. The name is case sensitive.
764 */
765 name: AliasName;
766 /**
767 * The name of the bot.
768 */
769 botName: BotName;
770 }
771 export interface GetBotAliasResponse {
772 /**
773 * The name of the bot alias.
774 */
775 name?: AliasName;
776 /**
777 * A description of the bot alias.
778 */
779 description?: Description;
780 /**
781 * The version of the bot that the alias points to.
782 */
783 botVersion?: Version;
784 /**
785 * The name of the bot that the alias points to.
786 */
787 botName?: BotName;
788 /**
789 * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
790 */
791 lastUpdatedDate?: Timestamp;
792 /**
793 * The date that the bot alias was created.
794 */
795 createdDate?: Timestamp;
796 /**
797 * Checksum of the bot alias.
798 */
799 checksum?: String;
800 }
801 export interface GetBotAliasesRequest {
802 /**
803 * The name of the bot.
804 */
805 botName: BotName;
806 /**
807 * 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.
808 */
809 nextToken?: NextToken;
810 /**
811 * The maximum number of aliases to return in the response. The default is 50. .
812 */
813 maxResults?: MaxResults;
814 /**
815 * 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."
816 */
817 nameContains?: AliasName;
818 }
819 export interface GetBotAliasesResponse {
820 /**
821 * An array of BotAliasMetadata objects, each describing a bot alias.
822 */
823 BotAliases?: BotAliasMetadataList;
824 /**
825 * 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.
826 */
827 nextToken?: NextToken;
828 }
829 export interface GetBotChannelAssociationRequest {
830 /**
831 * The name of the association between the bot and the channel. The name is case sensitive.
832 */
833 name: BotChannelName;
834 /**
835 * The name of the Amazon Lex bot.
836 */
837 botName: BotName;
838 /**
839 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
840 */
841 botAlias: AliasName;
842 }
843 export interface GetBotChannelAssociationResponse {
844 /**
845 * The name of the association between the bot and the channel.
846 */
847 name?: BotChannelName;
848 /**
849 * A description of the association between the bot and the channel.
850 */
851 description?: Description;
852 /**
853 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
854 */
855 botAlias?: AliasName;
856 /**
857 * The name of the Amazon Lex bot.
858 */
859 botName?: BotName;
860 /**
861 * The date that the association between the bot and the channel was created.
862 */
863 createdDate?: Timestamp;
864 /**
865 * The type of the messaging platform.
866 */
867 type?: ChannelType;
868 /**
869 * Provides information that the messaging platform needs to communicate with the Amazon Lex bot.
870 */
871 botConfiguration?: ChannelConfigurationMap;
872 /**
873 * 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.
874 */
875 status?: ChannelStatus;
876 /**
877 * If status is FAILED, Amazon Lex provides the reason that it failed to create the association.
878 */
879 failureReason?: String;
880 }
881 export interface GetBotChannelAssociationsRequest {
882 /**
883 * The name of the Amazon Lex bot in the association.
884 */
885 botName: BotName;
886 /**
887 * An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.
888 */
889 botAlias: AliasNameOrListAll;
890 /**
891 * 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.
892 */
893 nextToken?: NextToken;
894 /**
895 * The maximum number of associations to return in the response. The default is 50.
896 */
897 maxResults?: MaxResults;
898 /**
899 * 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.
900 */
901 nameContains?: BotChannelName;
902 }
903 export interface GetBotChannelAssociationsResponse {
904 /**
905 * An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.
906 */
907 botChannelAssociations?: BotChannelAssociationList;
908 /**
909 * 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.
910 */
911 nextToken?: NextToken;
912 }
913 export interface GetBotRequest {
914 /**
915 * The name of the bot. The name is case sensitive.
916 */
917 name: BotName;
918 /**
919 * The version or alias of the bot.
920 */
921 versionOrAlias: String;
922 }
923 export interface GetBotResponse {
924 /**
925 * The name of the bot.
926 */
927 name?: BotName;
928 /**
929 * A description of the bot.
930 */
931 description?: Description;
932 /**
933 * An array of intent objects. For more information, see PutBot.
934 */
935 intents?: IntentList;
936 /**
937 * The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
938 */
939 clarificationPrompt?: Prompt;
940 /**
941 * The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.
942 */
943 abortStatement?: Statement;
944 /**
945 * The status of the bot. If the bot is ready to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT.
946 */
947 status?: Status;
948 /**
949 * If status is FAILED, Amazon Lex explains why it failed to build the bot.
950 */
951 failureReason?: String;
952 /**
953 * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
954 */
955 lastUpdatedDate?: Timestamp;
956 /**
957 * The date that the bot was created.
958 */
959 createdDate?: Timestamp;
960 /**
961 * The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
962 */
963 idleSessionTTLInSeconds?: SessionTTL;
964 /**
965 * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
966 */
967 voiceId?: String;
968 /**
969 * Checksum of the bot used to identify a specific revision of the bot's $LATEST version.
970 */
971 checksum?: String;
972 /**
973 * The version of the bot. For a new bot, the version is always $LATEST.
974 */
975 version?: Version;
976 /**
977 * The target locale for the bot.
978 */
979 locale?: Locale;
980 /**
981 * 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.
982 */
983 childDirected?: Boolean;
984 }
985 export interface GetBotVersionsRequest {
986 /**
987 * The name of the bot for which versions should be returned.
988 */
989 name: BotName;
990 /**
991 * 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.
992 */
993 nextToken?: NextToken;
994 /**
995 * The maximum number of bot versions to return in the response. The default is 10.
996 */
997 maxResults?: MaxResults;
998 }
999 export interface GetBotVersionsResponse {
1000 /**
1001 * An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.
1002 */
1003 bots?: BotMetadataList;
1004 /**
1005 * 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.
1006 */
1007 nextToken?: NextToken;
1008 }
1009 export interface GetBotsRequest {
1010 /**
1011 * 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.
1012 */
1013 nextToken?: NextToken;
1014 /**
1015 * The maximum number of bots to return in the response that the request will return. The default is 10.
1016 */
1017 maxResults?: MaxResults;
1018 /**
1019 * 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."
1020 */
1021 nameContains?: BotName;
1022 }
1023 export interface GetBotsResponse {
1024 /**
1025 * An array of botMetadata objects, with one entry for each bot.
1026 */
1027 bots?: BotMetadataList;
1028 /**
1029 * 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.
1030 */
1031 nextToken?: NextToken;
1032 }
1033 export interface GetBuiltinIntentRequest {
1034 /**
1035 * 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.
1036 */
1037 signature: BuiltinIntentSignature;
1038 }
1039 export interface GetBuiltinIntentResponse {
1040 /**
1041 * The unique identifier for a built-in intent.
1042 */
1043 signature?: BuiltinIntentSignature;
1044 /**
1045 * A list of locales that the intent supports.
1046 */
1047 supportedLocales?: LocaleList;
1048 /**
1049 * An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.
1050 */
1051 slots?: BuiltinIntentSlotList;
1052 }
1053 export interface GetBuiltinIntentsRequest {
1054 /**
1055 * A list of locales that the intent supports.
1056 */
1057 locale?: Locale;
1058 /**
1059 * 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.
1060 */
1061 signatureContains?: String;
1062 /**
1063 * 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.
1064 */
1065 nextToken?: NextToken;
1066 /**
1067 * The maximum number of intents to return in the response. The default is 10.
1068 */
1069 maxResults?: MaxResults;
1070 }
1071 export interface GetBuiltinIntentsResponse {
1072 /**
1073 * An array of builtinIntentMetadata objects, one for each intent in the response.
1074 */
1075 intents?: BuiltinIntentMetadataList;
1076 /**
1077 * 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.
1078 */
1079 nextToken?: NextToken;
1080 }
1081 export interface GetBuiltinSlotTypesRequest {
1082 /**
1083 * A list of locales that the slot type supports.
1084 */
1085 locale?: Locale;
1086 /**
1087 * 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."
1088 */
1089 signatureContains?: String;
1090 /**
1091 * 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.
1092 */
1093 nextToken?: NextToken;
1094 /**
1095 * The maximum number of slot types to return in the response. The default is 10.
1096 */
1097 maxResults?: MaxResults;
1098 }
1099 export interface GetBuiltinSlotTypesResponse {
1100 /**
1101 * An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.
1102 */
1103 slotTypes?: BuiltinSlotTypeMetadataList;
1104 /**
1105 * 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.
1106 */
1107 nextToken?: NextToken;
1108 }
1109 export interface GetExportRequest {
1110 /**
1111 * The name of the bot to export.
1112 */
1113 name: Name;
1114 /**
1115 * The version of the bot to export.
1116 */
1117 version: NumericalVersion;
1118 /**
1119 * The type of resource to export.
1120 */
1121 resourceType: ResourceType;
1122 /**
1123 * The format of the exported data.
1124 */
1125 exportType: ExportType;
1126 }
1127 export interface GetExportResponse {
1128 /**
1129 * The name of the bot being exported.
1130 */
1131 name?: Name;
1132 /**
1133 * The version of the bot being exported.
1134 */
1135 version?: NumericalVersion;
1136 /**
1137 * The type of the exported resource.
1138 */
1139 resourceType?: ResourceType;
1140 /**
1141 * The format of the exported data.
1142 */
1143 exportType?: ExportType;
1144 /**
1145 * The status of the export. IN_PROGRESS - The export is in progress. READY - The export is complete. FAILED - The export could not be completed.
1146 */
1147 exportStatus?: ExportStatus;
1148 /**
1149 * If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.
1150 */
1151 failureReason?: String;
1152 /**
1153 * 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.
1154 */
1155 url?: String;
1156 }
1157 export interface GetImportRequest {
1158 /**
1159 * The identifier of the import job information to return.
1160 */
1161 importId: String;
1162 }
1163 export interface GetImportResponse {
1164 /**
1165 * The name given to the import job.
1166 */
1167 name?: Name;
1168 /**
1169 * The type of resource imported.
1170 */
1171 resourceType?: ResourceType;
1172 /**
1173 * The action taken when there was a conflict between an existing resource and a resource in the import file.
1174 */
1175 mergeStrategy?: MergeStrategy;
1176 /**
1177 * The identifier for the specific import job.
1178 */
1179 importId?: String;
1180 /**
1181 * The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field.
1182 */
1183 importStatus?: ImportStatus;
1184 /**
1185 * A string that describes why an import job failed to complete.
1186 */
1187 failureReason?: StringList;
1188 /**
1189 * A timestamp for the date and time that the import job was created.
1190 */
1191 createdDate?: Timestamp;
1192 }
1193 export interface GetIntentRequest {
1194 /**
1195 * The name of the intent. The name is case sensitive.
1196 */
1197 name: IntentName;
1198 /**
1199 * The version of the intent.
1200 */
1201 version: Version;
1202 }
1203 export interface GetIntentResponse {
1204 /**
1205 * The name of the intent.
1206 */
1207 name?: IntentName;
1208 /**
1209 * A description of the intent.
1210 */
1211 description?: Description;
1212 /**
1213 * An array of intent slots configured for the intent.
1214 */
1215 slots?: SlotList;
1216 /**
1217 * An array of sample utterances configured for the intent.
1218 */
1219 sampleUtterances?: IntentUtteranceList;
1220 /**
1221 * If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.
1222 */
1223 confirmationPrompt?: Prompt;
1224 /**
1225 * If the user answers "no" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.
1226 */
1227 rejectionStatement?: Statement;
1228 /**
1229 * 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.
1230 */
1231 followUpPrompt?: FollowUpPrompt;
1232 /**
1233 * After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.
1234 */
1235 conclusionStatement?: Statement;
1236 /**
1237 * If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.
1238 */
1239 dialogCodeHook?: CodeHook;
1240 /**
1241 * Describes how the intent is fulfilled. For more information, see PutIntent.
1242 */
1243 fulfillmentActivity?: FulfillmentActivity;
1244 /**
1245 * A unique identifier for a built-in intent.
1246 */
1247 parentIntentSignature?: BuiltinIntentSignature;
1248 /**
1249 * The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.
1250 */
1251 lastUpdatedDate?: Timestamp;
1252 /**
1253 * The date that the intent was created.
1254 */
1255 createdDate?: Timestamp;
1256 /**
1257 * The version of the intent.
1258 */
1259 version?: Version;
1260 /**
1261 * Checksum of the intent.
1262 */
1263 checksum?: String;
1264 }
1265 export interface GetIntentVersionsRequest {
1266 /**
1267 * The name of the intent for which versions should be returned.
1268 */
1269 name: IntentName;
1270 /**
1271 * 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.
1272 */
1273 nextToken?: NextToken;
1274 /**
1275 * The maximum number of intent versions to return in the response. The default is 10.
1276 */
1277 maxResults?: MaxResults;
1278 }
1279 export interface GetIntentVersionsResponse {
1280 /**
1281 * An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.
1282 */
1283 intents?: IntentMetadataList;
1284 /**
1285 * 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.
1286 */
1287 nextToken?: NextToken;
1288 }
1289 export interface GetIntentsRequest {
1290 /**
1291 * 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.
1292 */
1293 nextToken?: NextToken;
1294 /**
1295 * The maximum number of intents to return in the response. The default is 10.
1296 */
1297 maxResults?: MaxResults;
1298 /**
1299 * 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."
1300 */
1301 nameContains?: IntentName;
1302 }
1303 export interface GetIntentsResponse {
1304 /**
1305 * An array of Intent objects. For more information, see PutBot.
1306 */
1307 intents?: IntentMetadataList;
1308 /**
1309 * 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.
1310 */
1311 nextToken?: NextToken;
1312 }
1313 export interface GetSlotTypeRequest {
1314 /**
1315 * The name of the slot type. The name is case sensitive.
1316 */
1317 name: SlotTypeName;
1318 /**
1319 * The version of the slot type.
1320 */
1321 version: Version;
1322 }
1323 export interface GetSlotTypeResponse {
1324 /**
1325 * The name of the slot type.
1326 */
1327 name?: SlotTypeName;
1328 /**
1329 * A description of the slot type.
1330 */
1331 description?: Description;
1332 /**
1333 * A list of EnumerationValue objects that defines the values that the slot type can take.
1334 */
1335 enumerationValues?: EnumerationValues;
1336 /**
1337 * The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.
1338 */
1339 lastUpdatedDate?: Timestamp;
1340 /**
1341 * The date that the slot type was created.
1342 */
1343 createdDate?: Timestamp;
1344 /**
1345 * The version of the slot type.
1346 */
1347 version?: Version;
1348 /**
1349 * Checksum of the $LATEST version of the slot type.
1350 */
1351 checksum?: String;
1352 /**
1353 * The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
1354 */
1355 valueSelectionStrategy?: SlotValueSelectionStrategy;
1356 }
1357 export interface GetSlotTypeVersionsRequest {
1358 /**
1359 * The name of the slot type for which versions should be returned.
1360 */
1361 name: SlotTypeName;
1362 /**
1363 * 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.
1364 */
1365 nextToken?: NextToken;
1366 /**
1367 * The maximum number of slot type versions to return in the response. The default is 10.
1368 */
1369 maxResults?: MaxResults;
1370 }
1371 export interface GetSlotTypeVersionsResponse {
1372 /**
1373 * An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.
1374 */
1375 slotTypes?: SlotTypeMetadataList;
1376 /**
1377 * 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.
1378 */
1379 nextToken?: NextToken;
1380 }
1381 export interface GetSlotTypesRequest {
1382 /**
1383 * 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.
1384 */
1385 nextToken?: NextToken;
1386 /**
1387 * The maximum number of slot types to return in the response. The default is 10.
1388 */
1389 maxResults?: MaxResults;
1390 /**
1391 * 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."
1392 */
1393 nameContains?: SlotTypeName;
1394 }
1395 export interface GetSlotTypesResponse {
1396 /**
1397 * 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.
1398 */
1399 slotTypes?: SlotTypeMetadataList;
1400 /**
1401 * 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.
1402 */
1403 nextToken?: NextToken;
1404 }
1405 export interface GetUtterancesViewRequest {
1406 /**
1407 * The name of the bot for which utterance information should be returned.
1408 */
1409 botName: BotName;
1410 /**
1411 * An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.
1412 */
1413 botVersions: BotVersions;
1414 /**
1415 * To return utterances that were recognized and handled, useDetected. To return utterances that were not recognized, use Missed.
1416 */
1417 statusType: StatusType;
1418 }
1419 export interface GetUtterancesViewResponse {
1420 /**
1421 * The name of the bot for which utterance information was returned.
1422 */
1423 botName?: BotName;
1424 /**
1425 * 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.
1426 */
1427 utterances?: ListsOfUtterances;
1428 }
1429 export type GroupNumber = number;
1430 export type ImportStatus = "IN_PROGRESS"|"COMPLETE"|"FAILED"|string;
1431 export interface Intent {
1432 /**
1433 * The name of the intent.
1434 */
1435 intentName: IntentName;
1436 /**
1437 * The version of the intent.
1438 */
1439 intentVersion: Version;
1440 }
1441 export type IntentList = Intent[];
1442 export interface IntentMetadata {
1443 /**
1444 * The name of the intent.
1445 */
1446 name?: IntentName;
1447 /**
1448 * A description of the intent.
1449 */
1450 description?: Description;
1451 /**
1452 * The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.
1453 */
1454 lastUpdatedDate?: Timestamp;
1455 /**
1456 * The date that the intent was created.
1457 */
1458 createdDate?: Timestamp;
1459 /**
1460 * The version of the intent.
1461 */
1462 version?: Version;
1463 }
1464 export type IntentMetadataList = IntentMetadata[];
1465 export type IntentName = string;
1466 export type IntentUtteranceList = Utterance[];
1467 export type LambdaARN = string;
1468 export type ListOfUtterance = UtteranceData[];
1469 export type ListsOfUtterances = UtteranceList[];
1470 export type Locale = "en-US"|"en-GB"|"de-DE"|string;
1471 export type LocaleList = Locale[];
1472 export type MaxResults = number;
1473 export type MergeStrategy = "OVERWRITE_LATEST"|"FAIL_ON_CONFLICT"|string;
1474 export interface Message {
1475 /**
1476 * The content type of the message string.
1477 */
1478 contentType: ContentType;
1479 /**
1480 * The text of the message.
1481 */
1482 content: ContentString;
1483 /**
1484 * 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.
1485 */
1486 groupNumber?: GroupNumber;
1487 }
1488 export type MessageList = Message[];
1489 export type MessageVersion = string;
1490 export type Name = string;
1491 export type NextToken = string;
1492 export type NumericalVersion = string;
1493 export type Priority = number;
1494 export type ProcessBehavior = "SAVE"|"BUILD"|string;
1495 export interface Prompt {
1496 /**
1497 * 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).
1498 */
1499 messages: MessageList;
1500 /**
1501 * The number of times to prompt the user for information.
1502 */
1503 maxAttempts: PromptMaxAttempts;
1504 /**
1505 * 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.
1506 */
1507 responseCard?: ResponseCard;
1508 }
1509 export type PromptMaxAttempts = number;
1510 export interface PutBotAliasRequest {
1511 /**
1512 * The name of the alias. The name is not case sensitive.
1513 */
1514 name: AliasName;
1515 /**
1516 * A description of the alias.
1517 */
1518 description?: Description;
1519 /**
1520 * The version of the bot.
1521 */
1522 botVersion: Version;
1523 /**
1524 * The name of the bot.
1525 */
1526 botName: BotName;
1527 /**
1528 * 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.
1529 */
1530 checksum?: String;
1531 }
1532 export interface PutBotAliasResponse {
1533 /**
1534 * The name of the alias.
1535 */
1536 name?: AliasName;
1537 /**
1538 * A description of the alias.
1539 */
1540 description?: Description;
1541 /**
1542 * The version of the bot that the alias points to.
1543 */
1544 botVersion?: Version;
1545 /**
1546 * The name of the bot that the alias points to.
1547 */
1548 botName?: BotName;
1549 /**
1550 * The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.
1551 */
1552 lastUpdatedDate?: Timestamp;
1553 /**
1554 * The date that the bot alias was created.
1555 */
1556 createdDate?: Timestamp;
1557 /**
1558 * The checksum for the current version of the alias.
1559 */
1560 checksum?: String;
1561 }
1562 export interface PutBotRequest {
1563 /**
1564 * The name of the bot. The name is not case sensitive.
1565 */
1566 name: BotName;
1567 /**
1568 * A description of the bot.
1569 */
1570 description?: Description;
1571 /**
1572 * 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.
1573 */
1574 intents?: IntentList;
1575 /**
1576 * 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 repeate 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.'"
1577 */
1578 clarificationPrompt?: Prompt;
1579 /**
1580 * 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.
1581 */
1582 abortStatement?: Statement;
1583 /**
1584 * 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).
1585 */
1586 idleSessionTTLInSeconds?: SessionTTL;
1587 /**
1588 * 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 Available Voices in the Amazon Polly Developer Guide.
1589 */
1590 voiceId?: String;
1591 /**
1592 * 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.
1593 */
1594 checksum?: String;
1595 /**
1596 * 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.
1597 */
1598 processBehavior?: ProcessBehavior;
1599 /**
1600 * 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.
1601 */
1602 locale: Locale;
1603 /**
1604 * 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.
1605 */
1606 childDirected: Boolean;
1607 createVersion?: Boolean;
1608 }
1609 export interface PutBotResponse {
1610 /**
1611 * The name of the bot.
1612 */
1613 name?: BotName;
1614 /**
1615 * A description of the bot.
1616 */
1617 description?: Description;
1618 /**
1619 * An array of Intent objects. For more information, see PutBot.
1620 */
1621 intents?: IntentList;
1622 /**
1623 * The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.
1624 */
1625 clarificationPrompt?: Prompt;
1626 /**
1627 * The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.
1628 */
1629 abortStatement?: Statement;
1630 /**
1631 * When you send a request to create a bot with processBehavior set to BUILD, 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, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element. When you set processBehaviorto SAVE, Amazon Lex sets the status code to NOT BUILT.
1632 */
1633 status?: Status;
1634 /**
1635 * If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
1636 */
1637 failureReason?: String;
1638 /**
1639 * The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.
1640 */
1641 lastUpdatedDate?: Timestamp;
1642 /**
1643 * The date that the bot was created.
1644 */
1645 createdDate?: Timestamp;
1646 /**
1647 * The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
1648 */
1649 idleSessionTTLInSeconds?: SessionTTL;
1650 /**
1651 * The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.
1652 */
1653 voiceId?: String;
1654 /**
1655 * Checksum of the bot that you created.
1656 */
1657 checksum?: String;
1658 /**
1659 * The version of the bot. For a new bot, the version is always $LATEST.
1660 */
1661 version?: Version;
1662 /**
1663 * The target locale for the bot.
1664 */
1665 locale?: Locale;
1666 /**
1667 * 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.
1668 */
1669 childDirected?: Boolean;
1670 createVersion?: Boolean;
1671 }
1672 export interface PutIntentRequest {
1673 /**
1674 * 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.
1675 */
1676 name: IntentName;
1677 /**
1678 * A description of the intent.
1679 */
1680 description?: Description;
1681 /**
1682 * 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.
1683 */
1684 slots?: SlotList;
1685 /**
1686 * 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.
1687 */
1688 sampleUtterances?: IntentUtteranceList;
1689 /**
1690 * 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.
1691 */
1692 confirmationPrompt?: Prompt;
1693 /**
1694 * 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.
1695 */
1696 rejectionStatement?: Statement;
1697 /**
1698 * 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.
1699 */
1700 followUpPrompt?: FollowUpPrompt;
1701 /**
1702 * 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.
1703 */
1704 conclusionStatement?: Statement;
1705 /**
1706 * 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.
1707 */
1708 dialogCodeHook?: CodeHook;
1709 /**
1710 * 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).
1711 */
1712 fulfillmentActivity?: FulfillmentActivity;
1713 /**
1714 * 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.
1715 */
1716 parentIntentSignature?: BuiltinIntentSignature;
1717 /**
1718 * 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.
1719 */
1720 checksum?: String;
1721 createVersion?: Boolean;
1722 }
1723 export interface PutIntentResponse {
1724 /**
1725 * The name of the intent.
1726 */
1727 name?: IntentName;
1728 /**
1729 * A description of the intent.
1730 */
1731 description?: Description;
1732 /**
1733 * An array of intent slots that are configured for the intent.
1734 */
1735 slots?: SlotList;
1736 /**
1737 * An array of sample utterances that are configured for the intent.
1738 */
1739 sampleUtterances?: IntentUtteranceList;
1740 /**
1741 * If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.
1742 */
1743 confirmationPrompt?: Prompt;
1744 /**
1745 * If the user answers "no" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.
1746 */
1747 rejectionStatement?: Statement;
1748 /**
1749 * If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.
1750 */
1751 followUpPrompt?: FollowUpPrompt;
1752 /**
1753 * After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.
1754 */
1755 conclusionStatement?: Statement;
1756 /**
1757 * If defined in the intent, Amazon Lex invokes this Lambda function for each user input.
1758 */
1759 dialogCodeHook?: CodeHook;
1760 /**
1761 * 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.
1762 */
1763 fulfillmentActivity?: FulfillmentActivity;
1764 /**
1765 * A unique identifier for the built-in intent that this intent is based on.
1766 */
1767 parentIntentSignature?: BuiltinIntentSignature;
1768 /**
1769 * The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.
1770 */
1771 lastUpdatedDate?: Timestamp;
1772 /**
1773 * The date that the intent was created.
1774 */
1775 createdDate?: Timestamp;
1776 /**
1777 * The version of the intent. For a new intent, the version is always $LATEST.
1778 */
1779 version?: Version;
1780 /**
1781 * Checksum of the $LATESTversion of the intent created or updated.
1782 */
1783 checksum?: String;
1784 createVersion?: Boolean;
1785 }
1786 export interface PutSlotTypeRequest {
1787 /**
1788 * 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.
1789 */
1790 name: SlotTypeName;
1791 /**
1792 * A description of the slot type.
1793 */
1794 description?: Description;
1795 /**
1796 * 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.
1797 */
1798 enumerationValues?: EnumerationValues;
1799 /**
1800 * 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.
1801 */
1802 checksum?: String;
1803 /**
1804 * 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.
1805 */
1806 valueSelectionStrategy?: SlotValueSelectionStrategy;
1807 createVersion?: Boolean;
1808 }
1809 export interface PutSlotTypeResponse {
1810 /**
1811 * The name of the slot type.
1812 */
1813 name?: SlotTypeName;
1814 /**
1815 * A description of the slot type.
1816 */
1817 description?: Description;
1818 /**
1819 * A list of EnumerationValue objects that defines the values that the slot type can take.
1820 */
1821 enumerationValues?: EnumerationValues;
1822 /**
1823 * The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.
1824 */
1825 lastUpdatedDate?: Timestamp;
1826 /**
1827 * The date that the slot type was created.
1828 */
1829 createdDate?: Timestamp;
1830 /**
1831 * The version of the slot type. For a new slot type, the version is always $LATEST.
1832 */
1833 version?: Version;
1834 /**
1835 * Checksum of the $LATEST version of the slot type.
1836 */
1837 checksum?: String;
1838 /**
1839 * The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.
1840 */
1841 valueSelectionStrategy?: SlotValueSelectionStrategy;
1842 createVersion?: Boolean;
1843 }
1844 export type ResourceType = "BOT"|"INTENT"|"SLOT_TYPE"|string;
1845 export type ResponseCard = string;
1846 export type SessionTTL = number;
1847 export interface Slot {
1848 /**
1849 * The name of the slot.
1850 */
1851 name: SlotName;
1852 /**
1853 * A description of the slot.
1854 */
1855 description?: Description;
1856 /**
1857 * Specifies whether the slot is required or optional.
1858 */
1859 slotConstraint: SlotConstraint;
1860 /**
1861 * The type of the slot, either a custom slot type that you defined or one of the built-in slot types.
1862 */
1863 slotType?: CustomOrBuiltinSlotTypeName;
1864 /**
1865 * The version of the slot type.
1866 */
1867 slotTypeVersion?: Version;
1868 /**
1869 * The prompt that Amazon Lex uses to elicit the slot value from the user.
1870 */
1871 valueElicitationPrompt?: Prompt;
1872 /**
1873 * 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.
1874 */
1875 priority?: Priority;
1876 /**
1877 * 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.
1878 */
1879 sampleUtterances?: SlotUtteranceList;
1880 /**
1881 * 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.
1882 */
1883 responseCard?: ResponseCard;
1884 }
1885 export type SlotConstraint = "Required"|"Optional"|string;
1886 export type SlotList = Slot[];
1887 export type SlotName = string;
1888 export interface SlotTypeMetadata {
1889 /**
1890 * The name of the slot type.
1891 */
1892 name?: SlotTypeName;
1893 /**
1894 * A description of the slot type.
1895 */
1896 description?: Description;
1897 /**
1898 * The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.
1899 */
1900 lastUpdatedDate?: Timestamp;
1901 /**
1902 * The date that the slot type was created.
1903 */
1904 createdDate?: Timestamp;
1905 /**
1906 * The version of the slot type.
1907 */
1908 version?: Version;
1909 }
1910 export type SlotTypeMetadataList = SlotTypeMetadata[];
1911 export type SlotTypeName = string;
1912 export type SlotUtteranceList = Utterance[];
1913 export type SlotValueSelectionStrategy = "ORIGINAL_VALUE"|"TOP_RESOLUTION"|string;
1914 export interface StartImportRequest {
1915 /**
1916 * 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.
1917 */
1918 payload: _Blob;
1919 /**
1920 * 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.
1921 */
1922 resourceType: ResourceType;
1923 /**
1924 * 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.
1925 */
1926 mergeStrategy: MergeStrategy;
1927 }
1928 export interface StartImportResponse {
1929 /**
1930 * The name given to the import job.
1931 */
1932 name?: Name;
1933 /**
1934 * The type of resource to import.
1935 */
1936 resourceType?: ResourceType;
1937 /**
1938 * The action to take when there is a merge conflict.
1939 */
1940 mergeStrategy?: MergeStrategy;
1941 /**
1942 * The identifier for the specific import job.
1943 */
1944 importId?: String;
1945 /**
1946 * The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.
1947 */
1948 importStatus?: ImportStatus;
1949 /**
1950 * A timestamp for the date and time that the import job was requested.
1951 */
1952 createdDate?: Timestamp;
1953 }
1954 export interface Statement {
1955 /**
1956 * A collection of message objects.
1957 */
1958 messages: MessageList;
1959 /**
1960 * 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.
1961 */
1962 responseCard?: ResponseCard;
1963 }
1964 export type Status = "BUILDING"|"READY"|"READY_BASIC_TESTING"|"FAILED"|"NOT_BUILT"|string;
1965 export type StatusType = "Detected"|"Missed"|string;
1966 export type String = string;
1967 export type StringList = String[];
1968 export type SynonymList = Value[];
1969 export type Timestamp = Date;
1970 export type UserId = string;
1971 export type Utterance = string;
1972 export interface UtteranceData {
1973 /**
1974 * The text that was entered by the user or the text representation of an audio clip.
1975 */
1976 utteranceString?: UtteranceString;
1977 /**
1978 * The number of times that the utterance was processed.
1979 */
1980 count?: Count;
1981 /**
1982 * The total number of individuals that used the utterance.
1983 */
1984 distinctUsers?: Count;
1985 /**
1986 * The date that the utterance was first recorded.
1987 */
1988 firstUtteredDate?: Timestamp;
1989 /**
1990 * The date that the utterance was last recorded.
1991 */
1992 lastUtteredDate?: Timestamp;
1993 }
1994 export interface UtteranceList {
1995 /**
1996 * The version of the bot that processed the list.
1997 */
1998 botVersion?: Version;
1999 /**
2000 * 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.
2001 */
2002 utterances?: ListOfUtterance;
2003 }
2004 export type UtteranceString = string;
2005 export type Value = string;
2006 export type Version = string;
2007 /**
2008 * 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.
2009 */
2010 export type apiVersion = "2017-04-19"|"latest"|string;
2011 export interface ClientApiVersions {
2012 /**
2013 * 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.
2014 */
2015 apiVersion?: apiVersion;
2016 }
2017 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2018 /**
2019 * Contains interfaces for use with the LexModelBuildingService client.
2020 */
2021 export import Types = LexModelBuildingService;
2022}
2023export = LexModelBuildingService;