リソースにカスタムタグを追加する。 - Amazon SageMaker AI
前提条件カスタムタグ伝搬にオプトインするカスタムタグを追加する

リソースにカスタムタグを追加する。

次のページでは、カスタムタグ伝搬を使用するために必要なステップについて説明します。カスタムタグ伝搬には、次のステップが必要となります。

  • カスタムタグ伝搬にオプトインする。

  • リソースにカスタムタグを追加する。

既存のドメインでカスタムタグ伝搬を有効にしても、既存のアプリケーションではアプリケーションを再起動するまで、タグ伝搬は機能しません。同様に、新しいカスタムタグが追加されても、既存のリソースのタグは更新されません。例えば、ドメインに 2 つのタグがあり、ユーザーがこのドメインでリソースを作成するとします。作成されたリソースには 2 つのタグが追加されます。ドメインに新しいタグが追加された場合、その新しいタグは既存のリソースには追加されません。ただし、新しく作成されるリソースには、この新しいタグがリソースにアタッチされます。

前提条件

  • ユーザーがリソースを作成するには、sagemaker:AddTags アクセス許可が付与されている必要があります。

    • SageMakerFullAccess マネージドポリシーまたは SageMaker Role Manager を使用して作成される新しいドメインの場合は、sagemaker:AddTags アクセス許可は事前入力されます。

    • カスタム AWS Identity and Access Management ポリシーを使用する既存のドメインでは、ユーザーがリソースを作成できるようにする sagemaker:AddTags アクセス許可を含めるようにポリシーを更新する必要があります。

カスタムタグ伝搬にオプトインする

カスタムタグ伝搬にオプトインするプロセスは、コンソールからオプトインするか、AWS CLI からオプトインするかによって異なります。コンソールからは、既存のドメインを更新することによってのみ、カスタムタグ伝搬にオプトインできます。AWS CLI からは、ドメインの作成時または既存のドメインの更新時に、カスタムタグ伝搬にオプトインできます。

コンソールからオプトインする

次の手順では、コンソールからカスタムタグ伝搬にオプトインする方法を概説します。コンソールからは、既存のドメインを更新することによってのみ、カスタムタグ伝搬にオプトインできます。

  1. Amazon SageMaker AI コンソール (https://console.aws.amazon.com/sagemaker/) を開きます。

  2. 左側のナビゲーションペインで、[管理者設定] を選択します。[管理者設定] で、[ドメイン] を選択します。

  3. [ドメイン] ページで、カスタムタグ伝搬を有効にするドメインを選択します。

  4. [ドメインの詳細] ページで、[ドメインの設定] タブを選択します。

  5. [ドメインの設定] タブで、[カスタムタグ伝搬] に移動します。

  6. [Edit] (編集) を選択します。

  7. [カスタムタグ伝搬を編集] ページで、[カスタムタグを自動的に伝搬] を選択します。

  8. [Submit] (送信) を選択します。

AWS CLI を使用してオプトインする

AWS CLI を使用してカスタムタグ伝搬にオプトインするには、CreateDomain API と UpdateDomain API の TagPropagation 属性を使用します。このフィールドのデフォルト値は、DISABLED です。空の値もデフォルトで DISABLED になります。次の例は、カスタムタグ伝搬を有効にする方法について説明しています。

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

カスタムタグを追加する

カスタムタグ伝搬を追加するプロセスは、コンソールから追加するか、AWS CLI から追加するかによって異なります。

コンソールから追加する

次の手順では、コンソールからカスタムタグをドメインに追加する方法を概説します。

  1. Amazon SageMaker AI コンソール (https://console.aws.amazon.com/sagemaker/) を開きます。

  2. 左側のナビゲーションペインで、[管理者設定] を選択します。[管理者設定] で、[ドメイン] を選択します。

  3. [ドメイン] ページで、カスタムタグを追加するドメインを選択します。

  4. [ドメインの詳細] ページで、[ドメインの設定] タブを選択します。

  5. [ドメインの設定] タブで、[タグ] に移動します。

  6. [Edit] (編集) を選択します。

  7. [タグ] ページで、[タグの追加] をクリックします。タグにキー値のペアを追加します。

  8. [保存] を選択します。これで、このドメインで作成された SageMaker AI リソースにこのカスタムタグが伝播されるようになりました。

次の手順では、コンソールからカスタムタグをユーザープロファイルに追加する方法を概説します。

  1. Amazon SageMaker AI コンソール (https://console.aws.amazon.com/sagemaker/) を開きます。

  2. 左側のナビゲーションペインで、[管理者設定] を選択します。[管理者設定] で、[ドメイン] を選択します。

  3. [ドメイン] ページで、カスタムタグを追加するユーザープロファイルがあるドメインを選択します。

  4. [ドメインの詳細] ページで、[ユーザープロファイル] タブを選択します。

  5. [ユーザープロファイル] ページで、カスタムタグを追加するユーザープロファイルを選択します。

  6. [ユーザーの詳細] タブで、[詳細] セクションに移動します。

  7. [Edit] (編集) を選択します。

  8. [タグ] セクションで、[タグの追加] をクリックします。タグにキー値のペアを追加します。

  9. [Submit] (送信) を選択します。これで、このドメインで作成された SageMaker AI リソースにこのカスタムタグが伝播されるようになりました。

AWS CLI を使用して追加する

カスタムタグ伝搬を有効にしたら、ドメイン、ユーザープロファイル、またはスペースレベルで作成したり更新したりする際に AWS CLI を使用してカスタムタグを追加できます。カスタムタグを追加する方法は、新しいリソースを作成する場合か、既存のリソースにタグを追加する場合かによって異なります。

次の例では、作成時にカスタムタグをドメインレベルで追加する方法について説明します。

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

既存のドメイン、ユーザープロファイル、スペースにカスタムタグを追加するには、次のとおり AddTags API を使用する必要があります。

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