Actions, resources, and condition keys for Amazon Lex V2
Amazon Lex V2 (service prefix: lex) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Lex V2
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | SDK client | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|---|
|
BatchCreateCustomVocabularyItem |
lexv2-models |
Write |
|||
|
BatchDeleteCustomVocabularyItem |
lexv2-models |
Write |
|||
|
BatchUpdateCustomVocabularyItem |
lexv2-models |
Write |
|||
|
BuildBotLocale |
lexv2-models |
Write |
|||
|
CreateBot |
lexv2-models |
Write |
|||
Read |
|||||
Read |
|||||
Tagging, Write |
|||||
iam:PassedToService |
lexv2.amazonaws.com |
Write |
|||
|
CreateBotAlias |
lexv2-models |
Write |
|||
Tagging, Write |
|||||
|
CreateBotLocale |
lexv2-models |
Write |
|||
|
CreateBotReplica |
lexv2-models |
Write |
|||
|
CreateBotVersion |
lexv2-models |
Write |
|||
|
CreateExport |
lexv2-models |
Write |
|||
|
CreateIntent |
lexv2-models |
Write |
|||
|
CreateResourcePolicy |
lexv2-models |
Write |
|||
|
CreateResourcePolicyStatement |
lexv2-models |
Write |
|||
Write |
|||||
|
CreateSlot |
lexv2-models |
Write |
|||
|
CreateSlotType |
lexv2-models |
Write |
|||
|
CreateTestSetDiscrepancyReport |
lexv2-models |
Write |
|||
|
CreateUploadUrl |
lexv2-models |
Write |
|||
|
DeleteBot |
lexv2-models |
Write |
|||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
|
DeleteBotAlias |
lexv2-models |
Write |
|||
Write |
|||||
|
DeleteBotAnalyzerRecommendation |
lexv2-models |
Write |
|||
|
DeleteBotLocale |
lexv2-models |
Write |
|||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
|
DeleteBotReplica |
lexv2-models |
Write |
|||
|
DeleteBotVersion |
lexv2-models |
Write |
|||
|
DeleteCustomVocabulary |
lexv2-models |
Write |
|||
|
DeleteExport |
lexv2-models |
Write |
|||
|
DeleteImport |
lexv2-models |
Write |
|||
|
DeleteIntent |
lexv2-models |
Write |
|||
|
DeleteResourcePolicy |
lexv2-models |
Write |
|||
|
DeleteResourcePolicyStatement |
lexv2-models |
Write |
|||
Write |
|||||
|
DeleteSlot |
lexv2-models |
Write |
|||
|
DeleteSlotType |
lexv2-models |
Write |
|||
|
DeleteTestSet |
lexv2-models |
Write |
|||
|
DeleteUtterances |
lexv2-models |
Write |
|||
|
DescribeBot |
lexv2-models |
Read |
|||
Read |
|||||
Read |
|||||
|
DescribeBotAlias |
lexv2-models |
Read |
|||
|
DescribeBotAnalyzerRecommendation |
lexv2-models |
Read |
|||
|
DescribeBotLocale |
lexv2-models |
Read |
|||
|
DescribeBotRecommendation |
lexv2-models |
Read |
|||
|
DescribeBotReplica |
lexv2-models |
Read |
|||
|
DescribeBotResourceGeneration |
lexv2-models |
Read |
|||
|
DescribeBotVersion |
lexv2-models |
Read |
|||
Read |
|||||
|
DescribeCustomVocabularyMetadata |
lexv2-models |
Read |
|||
|
DescribeExport |
lexv2-models |
Read |
|||
Read |
|||||
Read |
|||||
Read |
|||||
Read |
|||||
Read |
|||||
Read |
|||||
Read |
|||||
List |
|||||
List |
|||||
List |
|||||
List |
|||||
|
DescribeImport |
lexv2-models |
Read |
|||
|
DescribeIntent |
lexv2-models |
Read |
|||
|
DescribeResourcePolicy |
lexv2-models |
Read |
|||
|
DescribeSlot |
lexv2-models |
Read |
|||
|
DescribeSlotType |
lexv2-models |
Read |
|||
|
DescribeTestExecution |
lexv2-models |
Read |
|||
|
DescribeTestSet |
lexv2-models |
Read |
|||
|
DescribeTestSetDiscrepancyReport |
lexv2-models |
Read |
|||
|
DescribeTestSetGeneration |
lexv2-models |
Read |
|||
|
GenerateBotElement |
lexv2-models |
Read |
|||
|
GetTestExecutionArtifactsUrl |
lexv2-models |
Read |
|||
|
ListAggregatedUtterances |
lexv2-models |
List |
|||
|
ListBotAliasReplicas |
lexv2-models |
List |
|||
|
ListBotAliases |
lexv2-models |
List |
|||
|
ListBotLocales |
lexv2-models |
List |
|||
|
ListBotRecommendations |
lexv2-models |
List |
|||
|
ListBotReplicas |
lexv2-models |
List |
|||
|
ListBotResourceGenerations |
lexv2-models |
List |
|||
|
ListBotVersionReplicas |
lexv2-models |
List |
|||
|
ListBotVersions |
lexv2-models |
List |
|||
|
ListBots |
lexv2-models |
List |
|||
|
ListBuiltInIntents |
lexv2-models |
List |
|||
|
ListBuiltInSlotTypes |
lexv2-models |
List |
|||
|
ListCustomVocabularyItems |
lexv2-models |
List |
|||
|
ListExports |
lexv2-models |
List |
|||
|
ListImports |
lexv2-models |
List |
|||
|
ListIntentMetrics |
lexv2-models |
List |
|||
|
ListIntentPaths |
lexv2-models |
List |
|||
|
ListIntentStageMetrics |
lexv2-models |
List |
|||
|
ListIntents |
lexv2-models |
List |
|||
|
ListRecommendedIntents |
lexv2-models |
List |
|||
|
ListSessionAnalyticsData |
lexv2-models |
List |
|||
|
ListSessionMetrics |
lexv2-models |
List |
|||
|
ListSlotTypes |
lexv2-models |
List |
|||
|
ListSlots |
lexv2-models |
List |
|||
|
ListTagsForResource |
lexv2-models |
Read |
|||
|
ListTestExecutionResultItems |
lexv2-models |
Read |
|||
Read |
|||||
|
ListTestExecutions |
lexv2-models |
List |
|||
|
ListTestSetRecords |
lexv2-models |
Read |
|||
|
ListTestSets |
lexv2-models |
List |
|||
|
ListUtteranceAnalyticsData |
lexv2-models |
List |
|||
|
ListUtteranceMetrics |
lexv2-models |
List |
|||
|
SearchAssociatedTranscripts |
lexv2-models |
List |
|||
|
StartBotAnalyzer |
lexv2-models |
Write |
|||
|
StartBotRecommendation |
lexv2-models |
Write |
|||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
|
StartBotResourceGeneration |
lexv2-models |
Write |
|||
|
StartImport |
lexv2-models |
Write |
|||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Tagging, Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
Write |
|||||
iam:PassedToService |
lexv2.amazonaws.com |
Write |
|||
|
StartTestExecution |
lexv2-models |
Write |
|||
|
StartTestSetGeneration |
lexv2-models |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
lexv2.amazonaws.com |
Write |
|||
|
StopBotAnalyzer |
lexv2-models |
Write |
|||
|
StopBotRecommendation |
lexv2-models |
Write |
|||
|
TagResource |
lexv2-models |
Tagging, Write |
|||
|
UntagResource |
lexv2-models |
Tagging, Write |
|||
|
UpdateBot |
lexv2-models |
Read |
|||
Read |
|||||
Write |
|||||
iam:PassedToService |
lexv2.amazonaws.com |
Write |
|||
|
UpdateBotAlias |
lexv2-models |
Write |
|||
|
UpdateBotLocale |
lexv2-models |
Write |
|||
|
UpdateBotRecommendation |
lexv2-models |
Write |
|||
|
UpdateExport |
lexv2-models |
Write |
|||
|
UpdateIntent |
lexv2-models |
Write |
|||
|
UpdateResourcePolicy |
lexv2-models |
Write |
|||
|
UpdateSlot |
lexv2-models |
Write |
|||
|
UpdateSlotType |
lexv2-models |
Write |
|||
|
UpdateTestSet |
lexv2-models |
Write |
|||
|
DeleteSession |
lexv2-runtime |
Write |
|||
|
GetSession |
lexv2-runtime |
Read |
|||
|
PutSession |
lexv2-runtime |
Write |
|||
|
RecognizeText |
lexv2-runtime |
Write |
|||
|
RecognizeUtterance |
lexv2-runtime |
Write |
|||
|
StartConversation |
lexv2-runtime |
Write |
Actions defined by Amazon Lex V2
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in AWS. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create new items in an existing custom vocabulary |
Write |
|||
Grants permission to delete existing items in an existing custom vocabulary |
Write |
|||
Grants permission to update existing items in an existing custom vocabulary |
Write |
|||
Grants permission to build an existing bot locale in a bot |
Write |
|||
Grants permission to create a new bot and a test bot alias pointing to the DRAFT bot version |
Write |
|||
Grants permission to create a new bot alias in a bot |
Write |
|||
Grants permission to create a new bot locale in an existing bot |
Write |
|||
Grants permission to create bot replica for a bot |
Write |
|||
Grants permission to create a new version of an existing bot |
Write |
|||
Grants permission to create an export for an existing resource |
Write |
|||
Grants permission to create a new intent in an existing bot locale |
Write |
|||
Grants permission to create a new resource policy for a Lex resource |
Write |
|||
Grants permission to create a new resource policy statement for a Lex resource |
Write |
|||
Grants permission to create a new slot in an intent |
Write |
|||
Grants permission to create a new slot type in an existing bot locale |
Write |
|||
Grants permission to create a test set discrepancy report |
Write |
|||
Grants permission to create an upload url for import file |
Write |
|||
Grants permission to delete an existing bot |
Write |
|||
Grants permission to delete an existing bot alias in a bot |
Write |
|||
Grants permission to delete a bot analyzer recommendation |
Write |
|||
Grants permission to delete an existing bot locale in a bot |
Write |
|||
Grants permission to delete an existing bot replica |
Write |
|||
Grants permission to delete an existing bot version |
Write |
|||
Grants permission to delete an existing custom vocabulary in a bot locale |
Write |
|||
Grants permission to delete an existing export |
Write |
|||
Grants permission to delete an existing import |
Write |
|||
Grants permission to delete an existing intent in a bot locale |
Write |
|||
Grants permission to delete an existing resource policy for a Lex resource |
Write |
|||
Grants permission to delete an existing resource policy statement for a Lex resource |
Write |
|||
Grants permission to delete session information for a bot alias and user ID |
Write |
|||
Grants permission to delete an existing slot in an intent |
Write |
|||
Grants permission to delete an existing slot type in a bot locale |
Write |
|||
Grants permission to delete an existing test set |
Write |
|||
Grants permission to delete utterance data for a bot |
Write |
|||
Grants permission to retrieve an existing bot |
Read |
|||
Grants permission to retrieve an existing bot alias |
Read |
|||
Grants permission to describe a bot analyzer recommendation |
Read |
|||
Grants permission to retrieve an existing bot locale |
Read |
|||
Grants permission to retrieve metadata information about a bot recommendation |
Read |
|||
Grants permission to retrieve an existing bot replica |
Read |
|||
Grants permission to retrieve metadata information for a bot resource generation |
Read |
|||
Grants permission to retrieve an existing bot version |
Read |
|||
Grants permission to retrieve metadata of an existing custom vocabulary |
Read |
|||
Grants permission to retrieve an existing export |
Read |
|||
Grants permission to retrieve an existing import |
Read |
|||
Grants permission to retrieve an existing intent |
Read |
|||
Grants permission to retrieve an existing resource policy for a Lex resource |
Read |
|||
Grants permission to retrieve an existing slot |
Read |
|||
Grants permission to retrieve an existing slot type |
Read |
|||
Grants permission to retrieve test execution metadata |
Read |
|||
Grants permission to retrieve an existing test set |
Read |
|||
Grants permission to retrieve test set discrepancy report metadata |
Read |
|||
Grants permission to retrieve test set generation metadata |
Read |
|||
Grants permission to generate supported fields or elements for a bot |
Read |
|||
Grants permission to retrieve session information for a bot alias and user ID |
Read |
|||
Grants permission to retrieve artifacts URL for a test execution |
Read |
|||
Grants permission to list utterances and statistics for a bot |
List |
|||
Grants permission to list alias replicas in a bot replica |
List |
|||
Grants permission to list bot aliases in an bot |
List |
|||
Grants permission to list bot analyzer recommendations |
List |
|||
Grants permission to list bot locales in a bot |
List |
|||
Grants permission to get a list of bot recommendations that meet the specified criteria |
List |
|||
Grants permission to list replicas of a bot |
List |
|||
Grants permission to list the resource generations for a bot |
List |
|||
Grants permission to list version replicas in a bot replica |
List |
|||
Grants permission to list existing bot versions |
List |
|||
Grants permission to list existing bots |
List |
|||
Grants permission to list built-in intents |
List |
|||
Grants permission to list built-in slot types |
List |
|||
Grants permission to list items of an existing custom vocabulary |
List |
|||
Grants permission to list existing exports |
List |
|||
Grants permission to list existing imports |
List |
|||
Grants permission to list intent analytics metrics for a bot |
List |
|||
Grants permission to list intent path analytics for a bot |
List |
|||
Grants permission to list intentStage analytics metrics for a bot |
List |
|||
Grants permission to list intents in a bot |
List |
|||
Grants permission to get a list of recommended intents provided by the bot recommendation |
List |
|||
Grants permission to list session analytics data for a bot |
List |
|||
Grants permission to list session analytics metrics for a bot |
List |
|||
Grants permission to list slot types in a bot |
List |
|||
Grants permission to list slots in an intent |
List |
|||
Grants permission to lists tags for a Lex resource |
Read |
|||
Grants permission to retrieve test results data for a test execution |
Read |
|||
Grants permission to list test executions |
List |
|||
Grants permission to retrieve records inside an existing test set |
Read |
|||
Grants permission to list test sets |
List |
|||
Grants permission to create a new session or modify an existing session for a bot alias and user ID |
Write |
|||
Grants permission to send user input (text-only) to an bot alias |
Write |
|||
Grants permission to send user input (text or speech) to an bot alias |
Write |
|||
Grants permission to search for associated transcripts that meet the specified criteria |
List |
|||
Grants permission to start a bot analyzer for an existing bot locale |
Write |
|||
Grants permission to start a bot recommendation for an existing bot locale |
Write |
|||
Grants permission to start a resource generation for an existing bot locale |
Write |
|||
Grants permission to stream user input (speech/text/DTMF) to a bot alias |
Write |
|||
Grants permission to start a new import with the uploaded import file |
Write |
|||
Grants permission to start a test execution using a test set |
Write |
|||
Grants permission to generate a test set |
Write |
|||
Grants permission to stop a bot analyzer for an existing bot locale |
Write |
|||
Grants permission to stop a bot recommendation for an existing bot locale |
Write |
|||
Grants permission to add or overwrite tags of a Lex resource |
Tagging, Write |
|||
Grants permission to remove tags from a Lex resource |
Tagging, Write |
|||
Grants permission to update an existing bot |
Write |
|||
Grants permission to update an existing bot alias |
Write |
|||
Grants permission to update an existing bot locale |
Write |
|||
Grants permission to update an existing bot recommendation request |
Write |
|||
Grants permission to update an existing export |
Write |
|||
Grants permission to update an existing intent |
Write |
|||
Grants permission to update an existing resource policy for a Lex resource |
Write |
|||
Grants permission to update an existing slot |
Write |
|||
Grants permission to update an existing slot type |
Write |
|||
Grants permission to update an existing test set |
Write |
Permission-only actions for Amazon Lex V2
The following actions are defined by Amazon Lex V2 but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create a bot channel in an existing bot |
Write |
|||
Grants permission to create a new custom vocabulary in an existing bot locale |
Write |
|||
Grants permission to import a new test-set |
Write |
|||
Grants permission to delete an existing bot channel |
Write |
|||
Grants permission to retrieve an existing bot channel |
Read |
|||
Grants permission to retrieve an existing custom vocabulary |
Read |
|||
Grants permission to list bot channels |
List |
|||
Grants permission to update an existing custom vocabulary |
Write |
Resource types defined by Amazon Lex V2
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:lex:${Region}:${Account}:bot/${BotId}, arn:${Partition}:lex:${Region}:${Account}:bot:${BotName} |
||
arn:${Partition}:lex:${Region}:${Account}:bot-alias/${BotId}/${BotAliasId}, arn:${Partition}:lex:${Region}:${Account}:bot:${BotName}:${BotAlias} |
||
arn:${Partition}:lex:${Region}:${Account}:test-set/${TestSetId} |
Condition keys for Amazon Lex V2
Amazon Lex V2 defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags in the request |
String |
|
Filters access by the tags attached to a Lex resource |
String |
|
Filters access by the set of tag keys in the request |
ArrayOfString |