Using metadata tags with AWS Elemental MediaConvert jobs - MediaConvert
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.

Using metadata tags with AWS Elemental MediaConvert jobs

Unless you have existing integrations or workflows that rely on metadata (userMetadata) tags, we recommend that you use standard Amazon tags for both automatic integration with Amazon services and for custom integrations and workflows. For more information, see Tagging AWS Elemental MediaConvert resources.

A tag is a label that you assign or that Amazon assigns to an Amazon resource. Each tag consists of a key and a value. For tags that you assign, you define the key and value. For example, you might define the key as "stage" and the value as "test." Tags help you to identify and organize your Amazon resources. Metadata tags that you assign to AWS Elemental MediaConvert jobs appear in Amazon CloudWatch Events notifications.

You add metadata tags to jobs in one of the following ways:

  • Through the MediaConvert console on the Job settings page, in the Metadata pane.

  • Through the MediaConvert API in your job settings JSON payload. Include tags as shown in the following JSON snippet, in userMetadata. For more information, see the Jobs endpoint section of the MediaConvert API Reference.

    { "name": "Job Template Test with Resource Tags", "description": "Job Template Test", "userMetadata":{ "Company": "Banana", "Stage": "Production" }, "settings":{

AWS Elemental MediaConvert job tag restrictions

The following basic restrictions apply to tags on jobs:

  • Maximum number of tags per job – 10.

  • Maximum Key length – 128 Unicode characters.

  • Maximum Value length – 256 Unicode characters.

  • Valid values for Key and Value – Uppercase and lowercase Unicode letters in any language, numbers, space, and the following characters: _ . : / = + - and @.

  • Tag keys and values are case sensitive.

  • Don't use the aws: prefix for either keys or values. It's reserved for Amazon use.