View a markdown version of this page

Tagging Amazon Polly resources - Amazon Polly
Supported resources in Amazon PollyPermissions for tagging lexicons on creationManaging tagsTag limits and conventions
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Tagging Amazon Polly resources

A tag is a custom attribute label that you or Amazon assigns to an Amazon resource.

Tags help you do the following:

  • Identify and organize your Amazon resources. Many Amazon services support tagging. You can assign the same tag to resources from different services to indicate that the resources are related. For example, you can assign the same tag to a Amazon Polly lexicon that you assign to the Amazon Lambda function that uses it.

  • Control access to your resources. You can use tags in the Condition element of an IAM policy to allow or deny access to a lexicon based on its tags. For more information, see ABAC with Amazon Polly.

Note

Amazon Polly charges for speech synthesis by the number of characters synthesized, not per lexicon. If you activate a tag on a lexicon as a cost allocation tag, the charges for synthesis requests that use that lexicon aren't attributed to the tag.

Tags have two parts:

  • A tag key (for example, CostCenter, Environment, or Project). Tag keys are case sensitive.

  • An optional field known as a tag value (for example, 12345 or Production). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case sensitive.

The following sections provide more information about tags for Amazon Polly.

Supported resources in Amazon Polly

The following resources in Amazon Polly support tagging:

  • Lexicons – You can tag lexicons when you create them by using the PutLexicon API, or when you upload them in the Amazon Polly console. You can add tags to existing lexicons by using the TagResource API. You can also view and manage the tags of a lexicon on its details page in the Amazon Polly console.

Lexicon ARNs have the following format:

arn:aws:polly:region:account-id:lexicon/LexiconName

For information about adding and managing tags, see Managing tags.

Permissions for tagging lexicons on creation

When you include tags in a PutLexicon request, Amazon Polly checks that you have permission for both of the following actions on the lexicon:

  • polly:PutLexicon

  • polly:TagResource

If you don't have permission for polly:TagResource, the request fails with an access denied error and Amazon Polly doesn't create or update the lexicon. A PutLexicon request without tags only requires polly:PutLexicon.

The AmazonPollyFullAccess managed policy includes both permissions. For more information about managed policies, see Amazon managed (predefined) policies for Amazon Polly.

You can include tags in a PutLexicon request only when the request creates a lexicon. If a lexicon with the same name already exists, a PutLexicon request that includes tags fails with a ValidationException, and Amazon Polly doesn't change the lexicon or its tags. To add, change, or remove the tags of an existing lexicon, use TagResource and UntagResource.

A PutLexicon request without tags that overwrites an existing lexicon replaces the lexicon content and keeps the tags that the lexicon already has. It doesn't remove them.

Managing tags

Tags consist of the Key and Value properties on a resource. You can use the Amazon Polly console, the Amazon CLI, or the Amazon Polly API to add, edit, or delete the values for these properties.

Console

You can add tags when you upload a lexicon. You need a PLS lexicon file (.pls or .xml) and permission for polly:PutLexicon and polly:TagResource.

To add tags when you upload a lexicon

  1. Sign in to the Amazon Web Services Management Console and open the Amazon Polly console at https://console.amazonaws.cn/polly/.

  2. Choose the Lexicons tab, and then choose Upload lexicon.

  3. Provide a name for the lexicon and choose the lexicon file.

  4. Under Tags, choose Add new tag, and then enter a key and an optional value. Repeat for each tag that you want to add.

  5. Choose Upload lexicon.

You can view, add, edit, and remove the tags of an existing lexicon on its details page.

To view and manage the tags of an existing lexicon

  1. Sign in to the Amazon Web Services Management Console and open the Amazon Polly console at https://console.amazonaws.cn/polly/.

  2. Choose the Lexicons tab, and then choose the name of the lexicon.

  3. In the Tags section, choose Manage tags.

  4. Add, edit, or remove tags.

  5. Choose Save changes.

    The updated tags appear in the Tags section.

Amazon CLI

The following Amazon CLI command adds tags when you create a lexicon by using the --tags option of the put-lexicon command:

aws polly put-lexicon \
--name w3c \
--content file://example.pls \
--tags Project=Alpha,Environment=Production

To add or update tags on an existing lexicon, use the tag-resource command. If a tag that has the same key already exists, its value is replaced. In the following examples, replace 111122223333 with your Amazon account ID.

aws polly tag-resource \
--resource-arn arn:aws:polly:us-east-2:111122223333:lexicon/w3c \
--tags CostCenter=12345

To list the tags of a lexicon, use the list-tags-for-resource command.

aws polly list-tags-for-resource \
--resource-arn arn:aws:polly:us-east-2:111122223333:lexicon/w3c

The command returns the tags as a map of keys to values.

{
    "Tags": {
        "CostCenter": "12345",
        "Environment": "Production",
        "Project": "Alpha"
    }
}

To remove tags from a lexicon, use the untag-resource command with one or more tag keys to remove.

aws polly untag-resource \
--resource-arn arn:aws:polly:us-east-2:111122223333:lexicon/w3c \
--tag-keys CostCenter Environment

For more information about tagging lexicons, see the following:

Tag limits and conventions

Each Amazon Polly resource can have a maximum of 50 tags. The aws: prefix is reserved for Amazon use, so you can't use it in tag keys or values that you create. For tag naming limits, character requirements, and recommended naming strategies that apply to all Amazon resources, see Best practices and strategies in the Tagging Amazon Resources and Tag Editor User Guide.

Don't store sensitive information, such as personal or confidential data, in tags. For more information, see Data Protection in Amazon Polly.