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