Add custom tags to resources - Amazon SageMaker
PrerequisitesOpt-in to custom tag propagationAdd custom tags

Add custom tags to resources

The following page demonstrates the steps needed to use custom tag propagation. Custom tag propagation requires the following steps:

  • Opt-in to custom tag propagation

  • Add custom tags to resources

When you activate custom tag propagation in an existing domain, tag propagation does not work for existing applications until the application is restarted. Similarly, tags are not updated on an existing resource when new custom tags are added. For example, assume a domain has two tags and a user creates a resource in that domain. The resource then has two tags. If a new tag is added to the domain, then that new tag is not added to the existing resource. However, any new resource created will have the new tag attached to the resource.

Prerequisites

  • Users must have the sagemaker:AddTags permission for any resource creation.

    • For new domains created with the SageMakerFullAccess managed policy or using the SageMaker Role Manager, the sagemaker:AddTags permission is pre-populated.

    • For existing domains using custom AWS Identity and Access Management policies, you must update the policies to include the sagemaker:AddTags permission to allow users to create resources.

Opt-in to custom tag propagation

The process to opt-in to custom tag propagation differs based on if you are opting-in from the console or from the AWS CLI. From the console, you can only opt-in to custom tag propagation by updating an existing domain. From the AWS CLI, you can opt-in to custom tag propagation when creating a domain or updating an existing domain.

Opt-in from the console

The following steps outline how to opt-in to custom tag propagation from the console. You can only opt-in to custom tag propagation from the console by updating an existing domain.

  1. Open the Amazon SageMaker console at https://console.aws.amazon.com/sagemaker/.

  2. On the left navigation, select Admin configurations. Under Admin configurations, select Domains.

  3. On the Domains page, select the domain that you want to activate custom tag propagation for.

  4. From the Domain details page, select the Domain settings tab.

  5. On the Domain settings tab, navigate to Custom Tag Propagation.

  6. Select Edit.

  7. From the Edit custom tag propagation page, select Automatically propagate custom tags

  8. Select Submit.

Opt-in using the AWS CLI

To opt-in to custom tag propagation using the AWS CLI, use the TagPropagation attribute in the CreateDomain and UpdateDomain APIs. By default, the value of this field is DISABLED. An empty value also defaults to DISABLED. The following example shows how to activate custom tag propagation. 

aws sagemaker update-domain \
--domain-id domain-id \
--region region \
--tag-propagation DISABLED

Add custom tags

The process to add custom tags propagation differs based on if you are adding them from the console or from the AWS CLI.

Add from the console

The following steps outline how to add custom tags to a domain from the console.

  1. Open the Amazon SageMaker console at https://console.aws.amazon.com/sagemaker/.

  2. On the left navigation, select Admin configurations. Under Admin configurations, select Domains.

  3. On the Domains page, select the domain that you want to add custom tags to.

  4. From the Domain details page, select the Domain settings tab.

  5. On the Domain settings tab, navigate to Tags.

  6. Select Edit.

  7. From the Tags page, select Add tag. Add a key and value pair for the custom tag.

  8. Select Save. This custom tag is now propagated to the SageMaker resources created in the domain.

The following steps outline how to add custom tags to a user profile from the console.

  1. Open the Amazon SageMaker console at https://console.aws.amazon.com/sagemaker/.

  2. On the left navigation, select Admin configurations. Under Admin configurations, select Domains.

  3. On the Domains page, select the domain containing the user profile that you want to add custom tags to.

  4. From the Domain details page, select the User profiles tab.

  5. On the User profiles tab, select the user profile you want to add custom tags to.

  6. On the User Details tab, navigate to the Details section.

  7. Select Edit.

  8. From the Tags section, select Add tag. Add a key and value pair for the custom tag.

  9. Select Submit. This custom tag is now propagated to the SageMaker resources created in the domain.

Add using the AWS CLI

After you have activated custom tag propagation, you can add custom tags using the AWS CLI at the domain, user profile, or space level during creation or update. The method to add custom tags differs depending on you are creating a new resource or adding tags to an existing resource.

The following example shows how to add custom tags at the domain level during creation. 

aws sagemaker create-domain \
    --domain-name domain-id \
    --auth-mode IAM \
    --default-user-settings '{"ExecutionRole": "execution-role"}' \
    --subnet-ids subnet-id \
    --vpc-id vpc-id \
    --tags Key=key,Value=value \
    --tag-propagation ENABLED

You must use the AddTags API to add custom tags for existing domain, user profile, and spaces as follows. 

aws sagemaker add-tags \
--resource-arn resource-arn-to-attach-tags \
--tags Key=key, Value=value