

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# 標記 Amazon OpenSearch Service 網域
<a name="managedomains-awsresourcetagging"></a>

標籤可讓您將任意資訊指派給 Amazon OpenSearch Service 網域，以便對該資訊進行分類和篩選。標籤是一個鍵值對，您可定義它並與 OpenSearch Service 網域建立關聯。您可以使用這些標籤，透過將類似標記資源的費用分組來追蹤成本。 AWS 不會將任何語意意義套用至您的標籤。標籤會嚴格解譯為字元字串。所有標籤均包含以下元素：


| 標籤元素 | Description | 必要 | 
| --- | --- | --- | 
| 標籤鍵 |  標籤金鑰是標籤名稱。鍵對於所連接的 OpenSearch Service 網域必須具有唯一性。如需標籤鍵和標籤值各項基本限制的清單，請參閱[使用者定義的標籤限制](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)。  | 是 | 
| 標籤值 |  標籤值即為標籤的字串值。標籤值可以是 `null`，並且在標籤集內不必具有唯一性。例如，在 project/Trinity 及 cost-center/Trinity 標籤集中，均能擁有一個索引鍵/值組。如需標籤鍵和標籤值各項基本限制的清單，請參閱[使用者定義的標籤限制](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)。  | 否 | 

每個 OpenSearch Service 網域皆有標籤集，其中包含指派給該 OpenSearch Service 網域的所有標籤。 AWS 不會自動將任何標籤指派給 OpenSearch Service 網域。標籤集可以包含 0 到 50 個標籤。如果您對網域新增標籤，而該標籤與現有標籤具有相同的鍵，則新值會覆寫舊值。

## 標記範例
<a name="managedomains-awsresourcetagging-examples"></a>

您可以使用鍵來定義類別，其值可為該類別中的某個項目。例如，您可以定義標籤鍵為 `project` 且標籤值為 `Salix`，表示 OpenSearch Service 網域已指派給 Salix 專案。您也可利用 `environment=test` 或 `environment=production` 之類的鍵，以使用標籤來指定用於測試或生產的 OpenSearch Service 網域。嘗試使用一組一致的標籤鍵，讓您更方便追蹤與 OpenSearch Service 網域關聯的中繼資料。

您也可以使用標籤來整理 AWS 帳單，以反映您自己的成本結構。若要這樣做，請註冊以取得包含標籤索引鍵值的 AWS 帳戶 帳單。接著，根據具有相同標籤鍵值的資源來整理您的帳單資訊，以便查看合併資源的成本。例如，您可以使用鍵值對為數個 OpenSearch Service 網域加上標籤，然後整理帳單資訊以查看數項服務的每個網域的總成本。如需詳細資訊，請參閱 [https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) 帳單與成本管理*文件中的AWS 使用成本分配標記*。

**注意**  
標籤是快取用於授權之用。因此，對 OpenSearch Service 網域新增及更新標籤可能需要幾分鐘之後才會生效。

# 標記網域 （主控台）
<a name="managedomains-awsresourcetagging-console"></a>

主控台是標記網域的最簡單方法。

****建立標籤 (主控台)****

1. 前往 [https://aws.amazon.com](https://aws.amazon.com/ )，然後選擇 **Sign In to the Console (登入主控台)**。

1. 在 **Analytics** (分析) 下，選擇 **Amazon OpenSearch Service**。

1. 選取您要新增標籤的目標網域，然後前往 **Tags** (標籤) 索引標籤。

1. 選擇 **Manage** (管理) 和 **Add new tag** (新增標籤)。

1. 輸入標籤索引鍵和選用的值。

1. 選擇**儲存**。

若要刪除標籤，請按照同樣的步驟進行，然後在 **Manage tags** (管理標籤) 頁面上選擇 **Remove** (移除)。

如需使用主控台處理標籤的詳細資訊，請參閱 《*AWS 管理主控台入門指南*》中的[標籤編輯器](https://docs.aws.amazon.com/awsconsolehelpdocs/latest/gsg/tag-editor.html)。

# 標記網域 (AWS CLI)
<a name="managedomains-awsresourcetagging-cli"></a>

您可以使用 AWS CLI 搭配 **--add-tags**命令來建立資源標籤。

**語法**

`add-tags --arn=<domain_arn> --tag-list Key=<key>,Value=<value>`


****  

| 參數 | Description | 
| --- | --- | 
| --arn | 要為其附加標籤的 OpenSearch Service 網域的 Amazon 資源名稱。 | 
| --tag-list | 以空格分隔且格式如下的一系列鍵值組：Key=<key>,Value=<value> | 

**範例**

以下範例為 *logs* 網域建立兩個標籤：

```
aws opensearch add-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-list Key=service,Value=OpenSearch Key=instances,Value=m3.2xlarge
```

您可以使用 **--remove-tags** 命令，從 OpenSearch Service 網域移除標籤。

**語法**

`remove-tags --arn=<domain_arn> --tag-keys Key=<key>,Value=<value>`


****  

| 參數 | Description | 
| --- | --- | 
| --arn | 要為其附加標籤的 OpenSearch Service 網域的 Amazon Resource Name (ARN)。 | 
| --tag-keys | 要從 OpenSearch Service 網域中移除的一組以空格分隔的鍵值對。 | 

**範例**

以下範例會將上述範例所建立的兩個標籤從 *logs* 網域移除：

```
aws opensearch remove-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs --tag-keys service instances
```

您可以使用 **--list-tags** 命令來檢視 OpenSearch Service 網域的現有標籤：

**語法**

`list-tags --arn=<domain_arn>`


****  

| 參數 | Description | 
| --- | --- | 
| --arn | 要為其附加標籤的 OpenSearch Service 網域的 Amazon Resource Name (ARN)。 | 

**範例**

以下範例會列出 *logs* 網域的所有資源標籤：

```
aws opensearch list-tags --arn arn:aws:es:us-east-1:379931976431:domain/logs
```

# 標記網域 (AWS SDKs)
<a name="managedomains-awsresourcetagging-sdk"></a>

 AWS SDKs(Android 和 iOS SDKs除外） 支援 [Amazon OpenSearch Service API 參考](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html)中定義的所有動作，包括 `AddTags`、 `ListTags`和 `RemoveTags`操作。如需安裝和使用 AWS SDKs 的詳細資訊，請參閱[AWS 軟體開發套件](https://aws.amazon.com/code)。

## **Python**
<a name="pythonsample"></a>

此範例使用適用於 Python (Boto) 的 AWS SDK 中的 [OpenSearchService](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/opensearch.html) 低階 Python 用戶端，將標籤新增至網域、列出連接至網域的標籤，以及從網域移除標籤。您必須提供 `DOMAIN_ARN`、`TAG_KEY` 和 `TAG_VALUE` 的值。

```
import boto3
from botocore.config import Config  # import configuration

DOMAIN_ARN = ''  # ARN for the domain. i.e "arn:aws:es:us-east-1:123456789012:domain/my-domain
TAG_KEY = ''  # The name of the tag key. i.e 'Smileyface'
TAG_VALUE = ''  # The value assigned to the tag. i.e 'Practicetag'

# defines the configurations parameters such as region

my_config = Config(region_name='us-east-1')
client = boto3.client('opensearch', config=my_config)


# defines the client variable

def addTags():
    """Adds tags to the domain"""

    response = client.add_tags(ARN=DOMAIN_ARN,
                               TagList=[{'Key': TAG_KEY,
                                         'Value': TAG_VALUE}])

    print(response)


def listTags():
    """List tags that have been added to the domain"""

    response = client.list_tags(ARN=DOMAIN_ARN)
    print(response)


def removeTags():
    """Remove tags that have been added to the domain"""

    response = client.remove_tags(ARN=DOMAIN_ARN, TagKeys=[TAG_KEY])

    print('Tag removed')
    return response
```