Actions, resources, and condition keys for Amazon Lex - Service Authorization Reference

# Actions, resources, and condition keys for Amazon Lex

Amazon Lex (service prefix: `lex` ) provides the following service-specific resources, actions, and condition context 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.

###### Topics

- Actions defined by Amazon Lex
- Resource types defined by Amazon Lex
- Condition keys for Amazon Lex

## Actions defined by Amazon Lex

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.

The Resource types column of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies in the `Resource` element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the `Resource` element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's `Condition` element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

###### Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table .

Actions | Description | Access level | Resource types (*required) | Condition keys | Dependent actions
--- | --- | --- | --- | --- | ---
CreateBotVersion | Creates a new version based on the $LATEST version of the specified bot | Write | bot version* |  |
CreateIntentVersion | Creates a new version based on the $LATEST version of the specified intent | Write | intent version* |  |
CreateSlotTypeVersion | Creates a new version based on the $LATEST version of the specified slot type | Write | slottype version* |  |
DeleteBot | Deletes all versions of a bot | Write | bot version* |  |
DeleteBotAlias | Deletes an alias for a specific bot | Write | bot alias* |  |
DeleteBotChannelAssociation | Deletes the association between a Amazon Lex bot alias and a messaging platform | Write | channel* |  |
DeleteBotVersion | Deletes a specific version of a bot | Write | bot version* |  |
DeleteIntent | Deletes all versions of an intent | Write | intent version* |  |
DeleteIntentVersion | Deletes a specific version of an intent | Write | intent version* |  |
DeleteSession | Removes session information for a specified bot, alias, and user ID | Write | bot alias |  |
bot version |  |
DeleteSlotType | Deletes all versions of a slot type | Write | slottype version* |  |
DeleteSlotTypeVersion | Deletes a specific version of a slot type | Write | slottype version* |  |
DeleteUtterances | Deletes the information Amazon Lex maintains for utterances on a specific bot and userId | Write | bot version* |  |
GetBot | Returns information for a specific bot. In addition to the bot name, the bot version or alias is required | Read | bot alias |  |
bot version |  |
GetBotAlias | Returns information about a Amazon Lex bot alias | Read | bot alias* |  |
GetBotAliases | Returns a list of aliases for a given Amazon Lex bot | List |  |  |
GetBotChannelAssociation | Returns information about the association between a Amazon Lex bot and a messaging platform | Read | channel* |  |
GetBotChannelAssociations | Returns a list of all of the channels associated with a single bot | List | channel* |  |
GetBotVersions | Returns information for all versions of a specific bot | List | bot version* |  |
GetBots | Returns information for the $LATEST version of all bots, subject to filters provided by the client | List |  |  |
GetBuiltinIntent | Returns information about a built-in intent | Read |  |  |
GetBuiltinIntents | Gets a list of built-in intents that meet the specified criteria | Read |  |  |
GetBuiltinSlotTypes | Gets a list of built-in slot types that meet the specified criteria | Read |  |  |
GetExport | Exports Amazon Lex Resource in a requested format | Read | bot version* |  |
GetImport | Gets information about an import job started with StartImport | Read |  |  |
GetIntent | Returns information for a specific intent. In addition to the intent name, you must also specify the intent version | Read | intent version* |  |
GetIntentVersions | Returns information for all versions of a specific intent | List | intent version* |  |
GetIntents | Returns information for the $LATEST version of all intents, subject to filters provided by the client | List |  |  |
GetMigration | Grants permission to view an ongoing or completed migration | Read |  |  |
GetMigrations | Grants permission to view list of migrations from Amazon Lex v1 to Amazon Lex v2 | List |  |  |
GetSession | Returns session information for a specified bot, alias, and user ID | Read | bot alias |  |
bot version |  |
GetSlotType | Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must also specify the slot type version | Read | slottype version* |  |
GetSlotTypeVersions | Returns information for all versions of a specific slot type | List | slottype version* |  |
GetSlotTypes | Returns information for the $LATEST version of all slot types, subject to filters provided by the client | List |  |  |
GetUtterancesView | Returns a view of aggregate utterance data for versions of a bot for a recent time period | List | bot version* |  |
ListTagsForResource | Lists tags for a Lex resource | Read | bot |  |
bot alias |  |
channel |  |
PostContent | Sends user input (text or speech) to Amazon Lex | Write | bot alias |  |
bot version |  |
PostText | Sends user input (text-only) to Amazon Lex | Write | bot alias |  |
bot version |  |
PutBot | Creates or updates the $LATEST version of a Amazon Lex conversational bot | Write | bot version* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
PutBotAlias | Creates or updates an alias for the specific bot | Write | bot alias* |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
PutIntent | Creates or updates the $LATEST version of an intent | Write | intent version* |  |
PutSession | Creates a new session or modifies an existing session with an Amazon Lex bot | Write | bot alias |  |
bot version |  |
PutSlotType | Creates or updates the $LATEST version of a slot type | Write | slottype version* |  |
StartImport | Starts a job to import a resource to Amazon Lex | Write |  |  |
StartMigration | Grants permission to migrate a bot from Amazon Lex v1 to Amazon Lex v2 | Write | bot version* |  |
TagResource | Adds or overwrites tags to a Lex resource | Tagging | bot |  |
bot alias |  |
channel |  |
| aws:TagKeys aws:RequestTag/${TagKey} |
UntagResource | Removes tags from a Lex resource | Tagging | bot |  |
bot alias |  |
channel |  |
| aws:TagKeys aws:RequestTag/${TagKey} |

## Resource types defined by Amazon Lex

The following resource types are defined by this service and can be used in the `Resource` element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the Resource types table. For details about the columns in the following table, see Resource types table .

Resource types | ARN | Condition keys
--- | --- | ---
bot | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:bot:$ { BotName}` | aws:ResourceTag/${TagKey}
bot version | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:bot:$ { BotName}:$ { BotVersion}` | aws:ResourceTag/${TagKey}
bot alias | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:bot:$ { BotName}:$ { BotAlias}` | aws:ResourceTag/${TagKey}
channel | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:bot-channel:$ { BotName}:$ { BotAlias}:$ { ChannelName}` | aws:ResourceTag/${TagKey}
intent version | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:intent:$ { IntentName}:$ { IntentVersion}` |
slottype version | `arn:$ { Partition}:lex:$ { Region}:$ { Account}:slottype:$ { SlotName}:$ { SlotVersion}` |

## Condition keys for Amazon Lex

Amazon Lex defines the following condition keys that can be used in the `Condition` element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see Condition keys table .

To view the global condition keys that are available to all services, see Available global condition keys .

Condition keys | Description | Type
--- | --- | ---
aws:RequestTag/${TagKey} | Filters access based on the tags in the request | String
aws:ResourceTag/${TagKey} | Filters access by the tags attached to a Lex resource | String
aws:TagKeys | Filters access based on the set of tag keys in the request | ArrayOfString
lex:associatedIntents | Enables you to control access based on the intents included in the request | ArrayOfString
lex:associatedSlotTypes | Enables you to control access based on the slot types included in the request | ArrayOfString
lex:channelType | Enables you to control access based on the channel type included in the request | String

Did this page help you? - Yes

Thanks for letting us know we're doing a good job!

If you've got a moment, please tell us what we did right so we can do more of it.

Did this page help you? - No

Thanks for letting us know this page needs work. We're sorry we let you down.

If you've got a moment, please tell us how we can make the documentation better.