Tagging Amazon Polly resources
A tag is a custom attribute label that you or AWS assigns to an AWS resource.
Tags help you do the following:
-
Identify and organize your AWS resources. Many AWS 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 AWS Lambda function that uses it.
-
Control access to your resources. You can use tags in the
Conditionelement of an IAM policy to allow or deny access to a lexicon based on its tags. For more information, see ABAC with Amazon Polly.
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, orProject). Tag keys are case sensitive. -
An optional field known as a tag value (for example,
12345orProduction). 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.
-
Custom voices – You can tag custom voices when you create them by using the CreateVoice API. You can add tags to existing custom voices by using the TagResource API.
Lexicon ARNs have the following format:
arn:aws:polly:region:account-id:lexicon/LexiconName
Custom voice ARNs have the following format. To get the ARN of a voice, use
GetVoice.
arn:aws:polly:region:account-id:voice/voice-id
For information about adding and managing tags, see Managing tags.
Permissions for tagging resources on creation
When you include tags in a request that creates a resource, Amazon Polly checks that you
have permission for both the create action and polly:TagResource on the
resource. The following table lists the permissions for each operation.
| Operation | Permissions without tags | Permissions with tags |
|---|---|---|
PutLexicon |
polly:PutLexicon |
polly:PutLexicon and polly:TagResource |
CreateVoice |
polly:CreateVoice |
polly:CreateVoice and 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 the resource.
The AmazonPollyFullAccess managed policy includes all of these
permissions. For more information about managed policies, see AWS managed (predefined) policies for Amazon Polly.
To add, change, or remove the tags of an existing lexicon or custom voice, use
TagResource and UntagResource.
PutLexicon can also overwrite an existing lexicon, so the following
rules apply to lexicons only:
-
You can include tags in a
PutLexiconrequest only when the request creates a lexicon. If a lexicon with the same name already exists, a request that includes tags fails with aValidationException, and Amazon Polly doesn't change the lexicon or its tags. -
A
PutLexiconrequest without tags that overwrites an existing lexicon replaces the lexicon content and keeps the tags that the lexicon already has.
Managing tags
Tags consist of the Key and Value properties on a resource.
You can use the Amazon Polly console, the AWS CLI, or the Amazon Polly API to add, edit, or delete the
values for these properties.
For more information about tagging lexicons, see the following:
-
TagResource, UntagResource, and ListTagsForResource in the Amazon Polly API Reference
-
Working with Tag Editor in the Resource Groups User Guide. You can use Tag Editor to find Amazon Polly lexicons by tag and to add, change, or remove their tags together with the tags of resources from other services.
Tag limits and conventions
Each Amazon Polly resource can have a maximum of 50 tags. The aws: prefix is
reserved for AWS 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 AWS resources, see Best practices and strategies in the Tagging AWS 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.