Amazon Web Services, Inc.

Amazon Lex Model Building Service

Amazon Lex Build-Time Actions Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and…

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Lex Build-Time Actions
Amazon Lex is an AWS service for building conversational voice and text
interfaces. Use these actions to create, update, and delete conversational
bots for new and existing client applications.

Endpoints 42

  • GETGet bot versions/bots/:name/versions?nextToken=string&maxResults=0Deprecated. Gets information about all of the versions of a bot. The GetBotVersions operation returns a BotMetadata object for each version of a bot. For…
  • POSTCreate bot version/bots/:name/versionsDeprecated. 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…
  • GETGet intent versions/intents/:name/versions?nextToken=string&maxResults=0Deprecated. Gets information about all of the versions of an intent. The GetIntentVersions operation returns an IntentMetadata object for each version of an…
  • POSTCreate intent version/intents/:name/versionsDeprecated. 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…
  • GETGet slot type versions/slottypes/:name/versions?nextToken=string&maxResults=0Deprecated. Gets information about all versions of a slot type. The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot…
  • POSTCreate slot type version/slottypes/:name/versionsDeprecated. 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…
  • DELETEDelete bot/bots/:nameDeprecated. Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation. The…
  • GETGet bot alias/bots/:botName/aliases/:nameDeprecated. Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases . This operation requires…
  • PUTPut bot alias/bots/:botName/aliases/:nameDeprecated. 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…
  • DELETEDelete bot alias/bots/:botName/aliases/:nameDeprecated. 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…
  • GETGet bot channel association/bots/:botName/aliases/:botAlias/channels/:nameDeprecated. Returns information about the association between an Amazon Lex bot and a messaging platform. This operation requires permissions for the…
  • DELETEDelete bot channel association/bots/:botName/aliases/:botAlias/channels/:nameDeprecated. Deletes the association between an Amazon Lex bot and a messaging platform. This operation requires permission for the…
  • DELETEDelete bot version/bots/:name/versions/:versionDeprecated. Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. This operation requires permissions for the…
  • DELETEDelete intent/intents/:nameDeprecated. Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion…
  • GETGet intent/intents/:name/versions/:versionDeprecated. Returns information about an intent. In addition to the intent name, you must specify the intent version. This operation requires permissions to…
  • DELETEDelete intent version/intents/:name/versions/:versionDeprecated. Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation. This operation requires permissions…
  • DELETEDelete slot type/slottypes/:nameDeprecated. Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion…
  • DELETEDelete slot type version/slottypes/:name/version/:versionDeprecated. Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation. This operation requires…
  • DELETEDelete utterances/bots/:botName/utterances/:userIdDeprecated. Deletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the…
  • GETGet bot/bots/:name/versions/:versionOrAliasDeprecated. Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias. This operation requires permissions…
  • GETGet bot aliases/bots/:botName/aliases?nextToken=string&maxResults=0&nameContains=stringDeprecated. Returns a list of aliases for a specified Amazon Lex bot. This operation requires permissions for the lex:GetBotAliases action.
  • GETGet bot channel associations/bots/:botName/aliases/:botAlias/channels?nextToken=string&maxResults=0&nameContains=stringDeprecated. Returns a list of all of the channels associated with the specified bot. The GetBotChannelAssociations operation requires permissions for the…
  • GETGet bots/bots?nextToken=string&maxResults=0&nameContains=stringDeprecated. Returns bot information as follows: If you provide the nameContains field, the response includes information for the $LATEST version of all bots…
  • GETGet builtin intent/builtins/intents/:signatureDeprecated. Returns information about a built-in intent. This operation requires permission for the lex:GetBuiltinIntent action.
  • GETGet builtin intents/builtins/intents?locale=string&signatureContains=string&nextToken=string&maxResults=0Deprecated. Gets a list of built-in intents that meet the specified criteria. This operation requires permission for the lex:GetBuiltinIntents action.
  • GETGet builtin slot types/builtins/slottypes?locale=string&signatureContains=string&nextToken=string&maxResults=0Deprecated. 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…
  • GETGet export/exports?name=string&version=string&resourceType=string&exportType=stringDeprecated. Exports the contents of a Amazon Lex resource in a specified format.
  • GETGet import/imports/:importIdDeprecated. Gets information about an import job started with the StartImport operation.
  • GETGet intents/intents?nextToken=string&maxResults=0&nameContains=stringDeprecated. Returns intent information as follows: If you specify the nameContains field, returns the $LATEST version of all intents that contain the…
  • GETGet migration/migrations/:migrationIdDeprecated. 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…
  • GETGet migrations/migrations?sortByAttribute=string&sortByOrder=string&v1BotNameContains=string&migrationStatusEquals=string&maxResults=0&nextToken=stringDeprecated. Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.
  • POSTStart migration/migrationsDeprecated. 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.…
  • GETGet slot type/slottypes/:name/versions/:versionDeprecated. 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.…
  • GETGet slot types/slottypes?nextToken=string&maxResults=0&nameContains=stringDeprecated. Returns slot type information as follows: If you specify the nameContains field, returns the $LATEST version of all slot types that contain the…
  • GETGet utterances view/bots/:botName/utterances?view=aggregation&bot_versions=&status_type=stringDeprecated. 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…
  • GETList tags for resource/tags/:resourceArnDeprecated. Gets a list of tags associated with the specified resource. Only bots, bot aliases, and bot channels can have tags associated with them.
  • POSTTag resource/tags/:resourceArnDeprecated. Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Deprecated. Removes tags from a bot, bot alias or bot channel.
  • PUTPut bot/bots/:name/versions/$LATESTDeprecated. 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…
  • PUTPut intent/intents/:name/versions/$LATESTDeprecated. 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…
  • PUTPut slot type/slottypes/:name/versions/$LATESTDeprecated. 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…
  • POSTStart import/importsDeprecated. Starts a job to import a resource to Amazon Lex.

API details

Base URL
https://models.lex.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
42 operations on 32 pathsGET 22DELETE 10POST 6PUT 4
42 marked deprecated
Description format
AWS Smithy model, API version 2017-04-19

How to test the Amazon Lex Model Building Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lex Model Building Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get bot versions” (GET /bots/:name/versions?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Lex Model Building Service?

Amazon Lex Build-Time Actions Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and… It is listed under AI & machine learning and has 42 endpoints.

Who publishes the Amazon Lex Model Building Service?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Lex Model Building Service?

Requests go to https://models.lex.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Lex Model Building Service?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Lex Model Building Service have?

42 operations on 32 paths (22 GET, 10 DELETE, 6 POST, 4 PUT).

Is forking the Amazon Lex Model Building Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.