amazon-lex-model-building-service

name	amazon-lex-model-building-service
description	Amazon Lex Model Building Service API skill. Use when working with Amazon Lex Model Building Service for bots, intents, slottypes. Covers 42 endpoints.
version	1.0.0
generator	lapsh

Amazon Lex Model Building Service

API version: 2017-04-19

Auth

AWS SigV4

Base URL

Not specified.

Setup

1. Configure auth: AWS SigV4
2. GET /bots/ -- verify access
3. POST /bots/{name}/versions -- create first versions

Endpoints

42 endpoints across 8 groups. See references/api-spec.lap for full details.

bots

Method	Path	Description
POST	/bots/{name}/versions	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.
DELETE	/bots/{name}	Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The DeleteBot operation doesn't immediately remove the bot schema. Instead, it is marked for deletion and removed later. Amazon Lex stores utterances indefinitely for improving the ability of your bot to respond to user inputs. These utterances are not removed when the bot is deleted. To remove the utterances, use the DeleteUtterances operation. If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful. This operation requires permissions for the lex:DeleteBot action.
DELETE	/bots/{botName}/aliases/{name}	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.
DELETE	/bots/{botName}/aliases/{aliasName}/channels/{name}	Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the lex:DeleteBotChannelAssociation action.
DELETE	/bots/{name}/versions/{version}	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.
DELETE	/bots/{botName}/utterances/{userId}	Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input. Use the DeleteUtterances operation to manually delete stored utterances for a specific user. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the GetUtterancesView operation are deleted after 15 days. This operation requires permissions for the lex:DeleteUtterances action.
GET	/bots/{name}/versions/{versionoralias}	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.
GET	/bots/{botName}/aliases/{name}	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.
GET	/bots/{botName}/aliases/	Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
GET	/bots/{botName}/aliases/{aliasName}/channels/{name}	Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the lex:GetBotChannelAssociation action.
GET	/bots/{botName}/aliases/{aliasName}/channels/	Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.
GET	/bots/{name}/versions/	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.
GET	/bots/	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.
GET	/bots/{botname}/utterances?view=aggregation	Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to. For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance "I want flowers" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance. After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions of your bot in each request. Amazon Lex returns the most frequent utterances received by the bot in the last 15 days. The response contains information about a maximum of 100 utterances for each version. If you set childDirected field to true when you created your bot, if you are using slot obfuscation with one or more slots, or if you opted out of participating in improving Amazon Lex, utterances are not available. This operation requires permissions for the lex:GetUtterancesView action.
PUT	/bots/{name}/versions/$LATEST	Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works. If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception. This operation requires permissions for the lex:PutBot action. For more information, see security-iam.
PUT	/bots/{botName}/aliases/{name}	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.

intents

Method	Path	Description
POST	/intents/{name}/versions	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.
DELETE	/intents/{name}	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.
DELETE	/intents/{name}/versions/{version}	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.
GET	/intents/{name}/versions/{version}	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.
GET	/intents/{name}/versions/	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.
GET	/intents/	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.

slottypes

Method	Path	Description
POST	/slottypes/{name}/versions	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.
DELETE	/slottypes/{name}	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.
DELETE	/slottypes/{name}/version/{version}	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.
GET	/slottypes/{name}/versions/{version}	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.
GET	/slottypes/{name}/versions/	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.
GET	/slottypes/	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.

builtins

Method	Path	Description
GET	/builtins/intents/{signature}	Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
GET	/builtins/intents/	Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
GET	/builtins/slottypes/	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.

exports

Method	Path	Description
GET	/exports/	Exports the contents of a Amazon Lex resource in a specified format.

imports

Method	Path	Description
GET	/imports/{importId}	Gets information about an import job started with the StartImport operation.
POST	/imports/	Starts a job to import a resource to Amazon Lex.

migrations

Method	Path	Description
GET	/migrations/{migrationId}	Provides details about an ongoing or complete migration from an Amazon Lex V1 bot to an Amazon Lex V2 bot. Use this operation to view the migration alerts and warnings related to the migration.
GET	/migrations	Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
POST	/migrations	Starts migrating a bot from Amazon Lex V1 to Amazon Lex V2. Migrate your bot when you want to take advantage of the new features of Amazon Lex V2. For more information, see Migrating a bot in the Amazon Lex developer guide.

tags

Method	Path	Description
GET	/tags/{resourceArn}	Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
POST	/tags/{resourceArn}	Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
DELETE	/tags/{resourceArn}	Removes tags from a bot, bot alias or bot channel.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a version?" -> POST /bots/{name}/versions
• "Create a version?" -> POST /intents/{name}/versions
• "Create a version?" -> POST /slottypes/{name}/versions
• "Delete a bot?" -> DELETE /bots/{name}
• "Delete a aliase?" -> DELETE /bots/{botName}/aliases/{name}
• "Delete a channel?" -> DELETE /bots/{botName}/aliases/{aliasName}/channels/{name}
• "Delete a version?" -> DELETE /bots/{name}/versions/{version}
• "Delete a intent?" -> DELETE /intents/{name}
• "Delete a version?" -> DELETE /intents/{name}/versions/{version}
• "Delete a slottype?" -> DELETE /slottypes/{name}
• "Delete a version?" -> DELETE /slottypes/{name}/version/{version}
• "Delete a utterance?" -> DELETE /bots/{botName}/utterances/{userId}
• "Get version details?" -> GET /bots/{name}/versions/{versionoralias}
• "Get aliase details?" -> GET /bots/{botName}/aliases/{name}
• "List all aliases?" -> GET /bots/{botName}/aliases/
• "Get channel details?" -> GET /bots/{botName}/aliases/{aliasName}/channels/{name}
• "List all channels?" -> GET /bots/{botName}/aliases/{aliasName}/channels/
• "List all versions?" -> GET /bots/{name}/versions/
• "List all bots?" -> GET /bots/
• "Get intent details?" -> GET /builtins/intents/{signature}
• "List all intents?" -> GET /builtins/intents/
• "List all slottypes?" -> GET /builtins/slottypes/
• "List all exports?" -> GET /exports/
• "Get import details?" -> GET /imports/{importId}
• "Get version details?" -> GET /intents/{name}/versions/{version}
• "List all versions?" -> GET /intents/{name}/versions/
• "List all intents?" -> GET /intents/
• "Get migration details?" -> GET /migrations/{migrationId}
• "List all migrations?" -> GET /migrations
• "Get version details?" -> GET /slottypes/{name}/versions/{version}
• "List all versions?" -> GET /slottypes/{name}/versions/
• "List all slottypes?" -> GET /slottypes/
• "List all utterances?view=aggregation?" -> GET /bots/{botname}/utterances?view=aggregation
• "Get tag details?" -> GET /tags/{resourceArn}
• "Update a aliase?" -> PUT /bots/{botName}/aliases/{name}
• "Create a import?" -> POST /imports/
• "Create a migration?" -> POST /migrations
• "Delete a tag?" -> DELETE /tags/{resourceArn}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP