Tagging Your Amazon Lex Resources - Amazon Lex V1

If you are using Amazon Lex V2, refer to the Amazon Lex V2 guide instead.


If you are using Amazon Lex V1, we recommend upgrading your bots to Amazon Lex V2. We are no longer adding new features to V1 and strongly recommend using V2 for all new bots.

Tagging Your Amazon Lex Resources

To help you manage your Amazon Lex bots, bot aliases, and bot channels, you can assign metadata to each resource as tags. A tag is a label that you assign to an AWS resource. Each tag consists of a key and a value.

Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or application. Tags help you to:

  • Identify and organize your AWS resources. Many AWS resources support tagging, so you can assign the same tag to resources in different services to indicate that the resources are related. For example, you can tag a bot and the Lambda functions that it uses with the same tag.

  • Allocate costs. You activate tags on the AWS Billing and Cost Management dashboard. AWS uses the tags to categorize your costs and deliver a monthly cost allocation report to you. For Amazon Lex, you can allocate costs for each alias using tags specific to the alias, except for the $LATEST alias. You allocate costs for the $LATEST alias using tags for your Amazon Lex bot. For more information, see Use Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

  • Control access to your resources. You can use tags to Amazon Lex to create policies to control access to Amazon Lex resources. These policies can be attached to an IAM role or user to enable tag-based access control. For more information, see ABAC with Amazon Lex. To view an example identity-based policy for limiting access to a resource based on the tags on that resource, see Use a Tag to Access a Resource.

You can work with tags using the AWS Management Console, the AWS Command Line Interface, or the Amazon Lex API.

Tagging Your Resources

If you are using the Amazon Lex console, you can tag resources when you create them, or you can add the tags later. You can also use the console to update or remove existing tags.

If you are using the AWS CLI or the Amazon Lex API, you use the following operations to manage tags for your resources:

The following resources in Amazon Lex support tagging:

  • Bots - use an Amazon Resource Name (ARN) like the following:

    • arn:${partition}:lex:${region}:${account}:bot:${bot-name}

  • Bot aliases - use an ARN like the following:

    • arn:${partition}:lex:${region}:${account}:bot:${bot-name}:${bot-alias}

  • Bot channels - use an ARN like the following:

    • arn:${partition}:lex:${region}:${account}:bot-channel:${bot-name}:${bot-alias}:${channel-name}

Tag Restrictions

The following basic restrictions apply to tags on Amazon Lex resources:

  • Maximum number of tags - 50

  • Maximum key length – 128 characters

  • Maximum value length – 256 characters

  • Valid characters for key and value – a–z, A–Z, 0–9, space, and the following characters: _ . : / = + - and @

  • Keys and values are case sensitive.

  • Don't use aws: as a prefix for keys; it's reserved for AWS use.