Amazon Lex Model Building V2
This document provides detailed information about the Amazon Lex V2 API actions and their parameters. For information about the IAM access control permissions…
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
This document provides detailed information about the Amazon Lex V2 API actions and their parameters.
For information about the IAM access control permissions you need to use this API, see
Identity-based policies for Amazon Lex V2 .
Amazon Lex V2 Model Building V2 operations let you build and manage bots.
If you use a custom HTTP client to call Amazon Lex Model Building
V2 operations, you must set the "Content-Type" HTTP header to
"application/x-amz-json-1.1". Otherwise, you receive an HTTP 404 -
UnknownOperationException in the response.
Amazon Lex Model Building V2 operations return the responses with
the "application/x-amz-json-1.1" content type.
You can use Amazon Web Services SDKs to access Amazon Lex V2 APIs using your favorite programming language.
The SDKs automatically perform useful tasks for you, such as:
Cryptographically sign your service requests
Retry requests
Handle error responses
The following resources provide additional information about the Amazon Lex V2 Model Building API.
Amazon Web Services General Reference
Amazon Lex V2 Endpoints for each region .
Command Line Interface
Amazon Lex Model Building V2 CLI commands .
Endpoints 107
- PUTBatch create custom vocabulary item
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/batchcreateCreate a batch of custom vocabulary items for a given bot locale's custom vocabulary. - POSTBatch delete custom vocabulary item
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/batchdeleteDelete a batch of custom vocabulary items for a given bot locale's custom vocabulary. - PUTBatch update custom vocabulary item
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/batchupdateUpdate a batch of custom vocabulary items for a given bot locale's custom vocabulary. - GETDescribe bot locale
/bots/:botId/botversions/:botVersion/botlocales/:localeIdDescribes the settings that a bot has for a specific locale. - PUTUpdate bot locale
/bots/:botId/botversions/:botVersion/botlocales/:localeIdUpdates the settings that a bot has for a specific locale. - POSTBuild bot locale
/bots/:botId/botversions/:botVersion/botlocales/:localeIdBuilds a bot, its intents, and its slot types into a specific locale. A bot can be built into multiple locales. At runtime the locale is used to choose a… - DELETEDelete bot locale
/bots/:botId/botversions/:botVersion/botlocales/:localeIdRemoves a locale from a bot. When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted. - PUTCreate bot
/botsCreates an Amazon Lex conversational bot. - POSTList bots
/botsGets a list of available bots. - PUTCreate bot alias
/bots/:botId/botaliasesCreates an alias for the specified version of a bot. Use an alias to enable you to change the version of a bot without updating applications that use the bot.… - POSTList bot aliases
/bots/:botId/botaliasesGets a list of aliases for the specified bot. - PUTCreate bot locale
/bots/:botId/botversions/:botVersion/botlocalesCreates a locale in the bot. The locale contains the intents and slot types that the bot uses in conversations with users in the specified language and… - POSTList bot locales
/bots/:botId/botversions/:botVersion/botlocalesGets a list of locales for the specified bot. - PUTCreate bot replica
/bots/:botId/replicasAction to create a replication of the source bot in the secondary region. - POSTList bot replicas
/bots/:botId/replicasThe action to list the replicated bots. - PUTCreate bot version
/bots/:botId/botversionsCreates an immutable version of the bot. When you create the first version of a bot, Amazon Lex sets the version number to 1. Subsequent bot versions increase… - POSTList bot versions
/bots/:botId/botversionsGets information about all of the versions of a bot. The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three… - PUTCreate export
/exportsCreates a zip archive containing the contents of a bot or a bot locale. The archive contains a directory structure that contains JSON files that define the… - POSTList exports
/exportsLists the exports for a bot, bot locale, or custom vocabulary. Exports are kept in the list for 7 days. - PUTCreate intent
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intentsCreates an intent. To define the interaction between the user and your bot, you define one or more intents. For example, for a pizza ordering bot you would… - POSTList intents
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intentsGet a list of intents that meet the specified criteria. - GETDescribe resource policy
/policy/:resourceArnGets the resource policy and policy revision for a bot or bot alias. - PUTUpdate resource policy
/policy/:resourceArn?expectedRevisionId=stringReplaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception. - POSTCreate resource policy
/policy/:resourceArnCreates a new resource policy with the specified policy statements. - DELETEDelete resource policy
/policy/:resourceArn?expectedRevisionId=stringRemoves an existing policy from a bot or bot alias. If the resource doesn't have a policy attached, Amazon Lex returns an exception. - POSTCreate resource policy statement
/policy/:resourceArn/statements?expectedRevisionId=stringAdds a new resource policy statement to a bot or bot alias. If a resource policy exists, the statement is added to the current resource policy. If a policy… - PUTCreate slot
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentId/slotsCreates a slot in an intent. A slot is a variable needed to fulfill an intent. For example, an OrderPizza intent might need slots for size, crust, and number… - POSTList slots
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentId/slotsGets a list of slots that match the specified criteria. - PUTCreate slot type
/bots/:botId/botversions/:botVersion/botlocales/:localeId/slottypesCreates a custom slot type To create a custom slot type, specify a name for the slot type and a set of enumeration values, the values that a slot of this type… - POSTList slot types
/bots/:botId/botversions/:botVersion/botlocales/:localeId/slottypesGets a list of slot types that match the specified criteria. - POSTCreate test set discrepancy report
/testsets/:testSetId/testsetdiscrepancyCreate a report that describes the differences between the bot and the test set. - POSTCreate upload url
/createuploadurlGets a pre-signed S3 write URL that you use to upload the zip archive when importing a bot or a bot locale. - GETDescribe bot
/bots/:botIdProvides metadata information about a bot. - PUTUpdate bot
/bots/:botIdUpdates the configuration of an existing bot. - DELETEDelete bot
/bots/:botId?skipResourceInUseCheck=trueDeletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation. When you delete a bot, all of… - GETDescribe bot alias
/bots/:botId/botaliases/:botAliasIdGet information about a specific bot alias. - PUTUpdate bot alias
/bots/:botId/botaliases/:botAliasIdUpdates the configuration of an existing bot alias. - DELETEDelete bot alias
/bots/:botId/botaliases/:botAliasId?skipResourceInUseCheck=trueDeletes the specified bot alias. - DELETEDelete bot analyzer recommendation
/bots/:botId/botanalyzer/:botAnalyzerRequestIdPermanently deletes the recommendations and analysis results for a specific bot analysis request. This operation is provided for GDPR compliance and cannot be… - GETDescribe bot replica
/bots/:botId/replicas/:replicaRegionMonitors the bot replication status through the UI console. - DELETEDelete bot replica
/bots/:botId/replicas/:replicaRegionThe action to delete the replicated bot in the secondary region. - GETDescribe bot version
/bots/:botId/botversions/:botVersionProvides metadata about a version of a bot. - DELETEDelete bot version
/bots/:botId/botversions/:botVersion?skipResourceInUseCheck=trueDeletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation. - DELETEDelete custom vocabulary
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabularyRemoves a custom vocabulary from the specified locale in the specified bot. - GETDescribe export
/exports/:exportIdGets information about a specific export. - PUTUpdate export
/exports/:exportIdUpdates the password used to protect an export zip archive. The password is not required. If you don't supply a password, Amazon Lex generates a zip file that… - DELETEDelete export
/exports/:exportIdRemoves a previous export and the associated files stored in an S3 bucket. - GETDescribe import
/imports/:importIdGets information about a specific import. - DELETEDelete import
/imports/:importIdRemoves a previous import and the associated file stored in an S3 bucket. - GETDescribe intent
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentIdReturns metadata about an intent. - PUTUpdate intent
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentIdUpdates the settings for an intent. - DELETEDelete intent
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentIdRemoves the specified intent. Deleting an intent also deletes the slots associated with the intent. - DELETEDelete resource policy statement
/policy/:resourceArn/statements/:statementId?expectedRevisionId=stringDeletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that… - GETDescribe slot
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentId/slots/:slotIdGets metadata information about a slot. - PUTUpdate slot
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentId/slots/:slotIdUpdates the settings for a slot. - DELETEDelete slot
/bots/:botId/botversions/:botVersion/botlocales/:localeId/intents/:intentId/slots/:slotIdDeletes the specified slot from an intent. - GETDescribe slot type
/bots/:botId/botversions/:botVersion/botlocales/:localeId/slottypes/:slotTypeIdGets metadata information about a slot type. - PUTUpdate slot type
/bots/:botId/botversions/:botVersion/botlocales/:localeId/slottypes/:slotTypeIdUpdates the configuration of an existing slot type. - DELETEDelete slot type
/bots/:botId/botversions/:botVersion/botlocales/:localeId/slottypes/:slotTypeId?skipResourceInUseCheck=trueDeletes a slot type from a bot locale. If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the… - GETDescribe test set
/testsets/:testSetIdGets metadata information about the test set. - PUTUpdate test set
/testsets/:testSetIdThe action to update the test set. - DELETEDelete test set
/testsets/:testSetIdThe action to delete the selected test set. - DELETEDelete utterances
/bots/:botId/utterances?localeId=string&sessionId=stringDeletes stored utterances. Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the… - POSTDescribe bot analyzer recommendation
/bots/:botId/botanalyzer/describe/:botAnalyzerRequestIdRetrieves the analysis results and recommendations for bot optimization. The analysis must be in Available status before recommendations can be retrieved.… - GETDescribe bot recommendation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendations/:botRecommendationIdProvides metadata information about a bot recommendation. This information will enable you to get a description on the request inputs, to download associated… - PUTUpdate bot recommendation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendations/:botRecommendationIdUpdates an existing bot recommendation request. - GETDescribe bot resource generation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/generations/:generationIdReturns information about a request to generate a bot through natural language description, made through the StartBotResource API. Use the… - GETDescribe custom vocabulary metadata
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/metadataProvides metadata information about a custom vocabulary. - GETDescribe test execution
/testexecutions/:testExecutionIdGets metadata information about the test execution. - GETDescribe test set discrepancy report
/testsetdiscrepancy/:testSetDiscrepancyReportIdGets metadata information about the test set discrepancy report. - GETDescribe test set generation
/testsetgenerations/:testSetGenerationIdGets metadata information about the test set generation. - POSTGenerate bot element
/bots/:botId/botversions/:botVersion/botlocales/:localeId/generateGenerates sample utterances for an intent. - GETGet test execution artifacts url
/testexecutions/:testExecutionId/artifacturlThe pre-signed Amazon S3 URL to download the test execution result artifacts. - POSTList aggregated utterances
/bots/:botId/aggregatedutterancesProvides a list of utterances that users have sent to the bot. Utterances are aggregated by the text of the utterance. For example, all instances where… - POSTList bot alias replicas
/bots/:botId/replicas/:replicaRegion/botaliasesThe action to list the replicated bots created from the source bot alias. - POSTList bot analyzer history
/bots/:botId/botanalyzer/historyRetrieves a list of historical bot analysis executions for a specific bot. You can filter the results by locale and bot version. The history includes all… - PUTStart bot recommendation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendationsUse this to provide your transcript data, and to start the bot recommendation process. - POSTList bot recommendations
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendationsGet a list of bot recommendations that meet the specified criteria. - POSTList bot resource generations
/bots/:botId/botversions/:botVersion/botlocales/:localeId/generationsLists the generation requests made for a bot locale. - POSTList bot version replicas
/bots/:botId/replicas/:replicaRegion/botversionsContains information about all the versions replication statuses applicable for Global Resiliency. - POSTList built in intents
/builtins/locales/:localeId/intentsGets a list of built-in intents provided by Amazon Lex that you can use in your bot. To use a built-in intent as a the base for your own intent, include the… - POSTList built in slot types
/builtins/locales/:localeId/slottypesGets a list of built-in slot types that meet the specified criteria. - POSTList custom vocabulary items
/bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/listPaginated list of custom vocabulary items for a given bot locale's custom vocabulary. - PUTStart import
/importsStarts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket. - POSTList imports
/importsLists the imports for a bot, bot locale, or custom vocabulary. Imports are kept in the list for 7 days. - POSTList intent metrics
/bots/:botId/analytics/intentmetricsRetrieves summary metrics for the intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentMetric objects. In each object,… - POSTList intent paths
/bots/:botId/analytics/intentpathsRetrieves summary statistics for a path of intents that users take over sessions with your bot. The following fields are required: startDateTime and… - POSTList intent stage metrics
/bots/:botId/analytics/intentstagemetricsRetrieves summary metrics for the stages within intents in your bot. The following fields are required: metrics – A list of AnalyticsIntentStageMetric… - POSTList recommended intents
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendations/:botRecommendationId/intentsGets a list of recommended intents provided by the bot recommendation that you can use in your bot. Intents in the response are ordered by relevance. - POSTList session analytics data
/bots/:botId/analytics/sessionsRetrieves a list of metadata for individual user sessions with your bot. The startDateTime and endDateTime fields are required. These fields define a time… - POSTList session metrics
/bots/:botId/analytics/sessionmetricsRetrieves summary metrics for the user sessions with your bot. The following fields are required: metrics – A list of AnalyticsSessionMetric objects. In each… - GETList tags for resource
/tags/:resourceARNGets a list of tags associated with a resource. Only bots, bot aliases, and bot channels can have tags associated with them. - POSTTag resource
/tags/:resourceARNAdds 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=Removes tags from a bot, bot alias, or bot channel. - POSTList test execution result items
/testexecutions/:testExecutionId/resultsGets a list of test execution result items. - POSTList test executions
/testexecutionsThe list of test set executions. - POSTList test set records
/testsets/:testSetId/recordsThe list of test set records. - POSTList test sets
/testsetsThe list of the test sets - POSTList utterance analytics data
/bots/:botId/analytics/utterancesTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related… - POSTList utterance metrics
/bots/:botId/analytics/utterancemetricsTo use this API operation, your IAM role must have permissions to perform the ListAggregatedUtterances operation, which provides access to utterance-related… - POSTSearch associated transcripts
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendations/:botRecommendationId/associatedtranscriptsSearch for associated transcripts that meet the specified criteria. - POSTStart bot analyzer
/bots/:botId/botanalyzerInitiates an asynchronous analysis of your bot configuration using AI-powered analysis to identify potential issues and recommend improvements based on AWS… - PUTStart bot resource generation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/startgenerationStarts a request for the descriptive bot builder to generate a bot locale configuration based on the prompt you provide it. After you make this call, use the… - POSTStart test execution
/testsets/:testSetId/testexecutionsThe action to start test set execution. - PUTStart test set generation
/testsetgenerationsThe action to start the generation of test set. - PUTStop bot analyzer
/bots/:botId/botanalyzer/:botAnalyzerRequestId/stopCancels an ongoing bot analysis execution. Once stopped, the analysis cannot be resumed and no recommendations will be generated. - PUTStop bot recommendation
/bots/:botId/botversions/:botVersion/botlocales/:localeId/botrecommendations/:botRecommendationId/stopbotrecommendationStop an already running Bot Recommendation request.
API details
- Base URL
https://models-v2-lex.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 107 operations on 70 pathsPOST 43PUT 27GET 20DELETE 17
- Description format
- AWS Smithy model, API version
2020-08-07 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Lex Model Building V2 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Lex Model Building V2 collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Batch create custom vocabulary item” (PUT /bots/:botId/botversions/:botVersion/botlocales/:localeId/customvocabulary/DEFAULT/batchcreate), 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 V2?
This document provides detailed information about the Amazon Lex V2 API actions and their parameters. For information about the IAM access control permissions… It is listed under AI & machine learning and has 107 endpoints.
Who publishes the Amazon Lex Model Building V2?
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 V2?
Requests go to https://models-v2-lex.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Lex Model Building V2?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Lex Model Building V2 have?
107 operations on 70 paths (43 POST, 27 PUT, 20 GET, 17 DELETE).
Is forking the Amazon Lex Model Building V2 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.