

# Data retrieval APIs for Amazon Lex V2
<a name="amazonlexv2"></a>

Amazon Lex V2 provides the following APIs for data retrieval.


****  

| Actions | Description | Access level | 
| --- | --- | --- | 
| <a name="lex-DescribeBot"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBot.html) | Retrieve an existing bot | Read | 
| <a name="lex-DescribeBotAlias"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAlias.html) | Retrieve an existing bot alias | Read | 
| <a name="lex-DescribeBotAnalyzerRecommendation"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAnalyzerRecommendation.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotAnalyzerRecommendation.html) | Describe a bot analyzer recommendation | Read | 
| <a name="lex-DescribeBotChannel"></a>[https://docs.aws.amazon.com/lexv2/latest/dg/deploying-messaging-platform.html](https://docs.aws.amazon.com/lexv2/latest/dg/deploying-messaging-platform.html) | Retrieve an existing bot channel | Read | 
| <a name="lex-DescribeBotLocale"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotLocale.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotLocale.html) | Retrieve an existing bot locale | Read | 
| <a name="lex-DescribeBotRecommendation"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotRecommendation.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotRecommendation.html) | Retrieve metadata information about a bot recommendation | Read | 
| <a name="lex-DescribeBotReplica"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotReplica.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotReplica.html) | Retrieve an existing bot replica | Read | 
| <a name="lex-DescribeBotResourceGeneration"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotResourceGeneration.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotResourceGeneration.html) | Retrieve metadata information for a bot resource generation | Read | 
| <a name="lex-DescribeBotVersion"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotVersion.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeBotVersion.html) | Retrieve an existing bot version | Read | 
| <a name="lex-DescribeCustomVocabulary"></a>[https://docs.aws.amazon.com/lexv2/latest/dg/vocab.html](https://docs.aws.amazon.com/lexv2/latest/dg/vocab.html) | Retrieve an existing custom vocabulary | Read | 
| <a name="lex-DescribeCustomVocabularyMetadata"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeCustomVocabularyMetadata.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeCustomVocabularyMetadata.html) | Retrieve metadata of an existing custom vocabulary | Read | 
| <a name="lex-DescribeExport"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeExport.html) | Retrieve an existing export | Read | 
| <a name="lex-DescribeImport"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeImport.html) | Retrieve an existing import | Read | 
| <a name="lex-DescribeIntent"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeIntent.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeIntent.html) | Retrieve an existing intent | Read | 
| <a name="lex-DescribeResourcePolicy"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeResourcePolicy.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeResourcePolicy.html) | Retrieve an existing resource policy for a Lex resource | Read | 
| <a name="lex-DescribeSlot"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeSlot.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeSlot.html) | Retrieve an existing slot | Read | 
| <a name="lex-DescribeSlotType"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeSlotType.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeSlotType.html) | Retrieve an existing slot type | Read | 
| <a name="lex-DescribeTestExecution"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestExecution.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestExecution.html) | Retrieve test execution metadata | Read | 
| <a name="lex-DescribeTestSet"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSet.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSet.html) | Retrieve an existing test set | Read | 
| <a name="lex-DescribeTestSetDiscrepancyReport"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSetDiscrepancyReport.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSetDiscrepancyReport.html) | Retrieve test set discrepancy report metadata | Read | 
| <a name="lex-DescribeTestSetGeneration"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSetGeneration.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_DescribeTestSetGeneration.html) | Retrieve test set generation metadata | Read | 
| <a name="lex-GenerateBotElement"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_GenerateBotElement.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_GenerateBotElement.html) | Generate supported fields or elements for a bot | Read | 
| <a name="lex-GetSession"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_GetSession.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_runtime_GetSession.html) | Retrieve session information for a bot alias and user ID | Read | 
| <a name="lex-GetTestExecutionArtifactsUrl"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_GetTestExecutionArtifactsUrl.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_GetTestExecutionArtifactsUrl.html) | Retrieve artifacts URL for a test execution | Read | 
| <a name="lex-ListAggregatedUtterances"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListAggregatedUtterances.html) | List utterances and statistics for a bot | List | 
| <a name="lex-ListBotAliasReplicas"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliasReplicas.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliasReplicas.html) | List alias replicas in a bot replica | List | 
| <a name="lex-ListBotAliases"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAliases.html) | List bot aliases in an bot | List | 
| <a name="lex-ListBotAnalyzerRecommendations"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAnalyzerRecommendations.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotAnalyzerRecommendations.html) | List bot analyzer recommendations | List | 
| <a name="lex-ListBotChannels"></a>[https://docs.aws.amazon.com/lexv2/latest/dg/deploying-messaging-platform.html](https://docs.aws.amazon.com/lexv2/latest/dg/deploying-messaging-platform.html) | List bot channels | List | 
| <a name="lex-ListBotLocales"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotLocales.html) | List bot locales in a bot | List | 
| <a name="lex-ListBotRecommendations"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotRecommendations.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotRecommendations.html) | Get a list of bot recommendations that meet the specified criteria | List | 
| <a name="lex-ListBotReplicas"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotReplicas.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotReplicas.html) | List replicas of a bot | List | 
| <a name="lex-ListBotResourceGenerations"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotResourceGenerations.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotResourceGenerations.html) | List the resource generations for a bot | List | 
| <a name="lex-ListBotVersionReplicas"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersionReplicas.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersionReplicas.html) | List version replicas in a bot replica | List | 
| <a name="lex-ListBotVersions"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBotVersions.html) | List existing bot versions | List | 
| <a name="lex-ListBots"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBots.html) | List existing bots | List | 
| <a name="lex-ListBuiltInIntents"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInIntents.html) | List built-in intents | List | 
| <a name="lex-ListBuiltInSlotTypes"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListBuiltInSlotTypes.html) | List built-in slot types | List | 
| <a name="lex-ListCustomVocabularyItems"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListCustomVocabularyItems.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListCustomVocabularyItems.html) | List items of an existing custom vocabulary | List | 
| <a name="lex-ListExports"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListExports.html) | List existing exports | List | 
| <a name="lex-ListImports"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListImports.html) | List existing imports | List | 
| <a name="lex-ListIntentMetrics"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentMetrics.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentMetrics.html) | List intent analytics metrics for a bot | List | 
| <a name="lex-ListIntentPaths"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentPaths.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentPaths.html) | List intent path analytics for a bot | List | 
| <a name="lex-ListIntentStageMetrics"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentStageMetrics.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntentStageMetrics.html) | List intentStage analytics metrics for a bot | List | 
| <a name="lex-ListIntents"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntents.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListIntents.html) | List intents in a bot | List | 
| <a name="lex-ListRecommendedIntents"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListRecommendedIntents.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListRecommendedIntents.html) | Get a list of recommended intents provided by the bot recommendation | List | 
| <a name="lex-ListSessionAnalyticsData"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionAnalyticsData.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionAnalyticsData.html) | List session analytics data for a bot | List | 
| <a name="lex-ListSessionMetrics"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionMetrics.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSessionMetrics.html) | List session analytics metrics for a bot | List | 
| <a name="lex-ListSlotTypes"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSlotTypes.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSlotTypes.html) | List slot types in a bot | List | 
| <a name="lex-ListSlots"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSlots.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListSlots.html) | List slots in an intent | List | 
| <a name="lex-ListTagsForResource"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTagsForResource.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTagsForResource.html) | Lists tags for a Lex resource | Read | 
| <a name="lex-ListTestExecutionResultItems"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestExecutionResultItems.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestExecutionResultItems.html) | Retrieve test results data for a test execution | Read | 
| <a name="lex-ListTestExecutions"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestExecutions.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestExecutions.html) | List test executions | List | 
| <a name="lex-ListTestSetRecords"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestSetRecords.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestSetRecords.html) | Retrieve records inside an existing test set | Read | 
| <a name="lex-ListTestSets"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestSets.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_ListTestSets.html) | List test sets | List | 
| <a name="lex-SearchAssociatedTranscripts"></a>[https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SearchAssociatedTranscripts.html](https://docs.aws.amazon.com/lexv2/latest/APIReference/API_SearchAssociatedTranscripts.html) | Search for associated transcripts that meet the specified criteria | List | 