

# x-amazon-apigateway-tag-value プロパティ
<a name="api-gateway-openapi-extensions-x-amazon-apigateway-tag-value"></a>

HTTP API の [AWS タグ](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html)の値を指定します。`x-amazon-apigateway-tag-value` プロパティを、ルートレベルの [OpenAPI タグオブジェクト](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#tag-object)の一部として使用して、HTTP API の AWS タグを指定できます。`x-amazon-apigateway-tag-value` プロパティを指定せずにタグ名を指定すると、API Gateway は値として空の文字列を持つタグを作成します。

タグ付けの詳細については、「[API Gateway リソースのタグ付け](apigateway-tagging.md)」を参照してください。


| プロパティ名 | タイプ | 説明 | 
| --- | --- | --- | 
| `name` | String |  タグキーを指定します。  | 
| `x-amazon-apigateway-tag-value` | String |  タグ値を指定します。  | 

## `x-amazon-apigateway-tag-value` の例
<a name="api-gateway-openapi-extensions-x-amazon-apigateway-tag-value-example"></a>

 次の例では、HTTP API に 2 つのタグを指定します。
+ "Owner": "Admin"
+ "Prod": ""

```
"tags": [
    {
      "name": "Owner",
      "x-amazon-apigateway-tag-value": "Admin"
    },
    {
      "name": "Prod"
    }
]
```