Amazon OpenSearch Service API · JSON Structure

Openapi Tag Structure

Specifies a key value pair for a resource tag.

Type: object Properties: 2 Required: 2
AnalyticsElasticsearchSearch

Tag is a JSON Structure definition published by Amazon OpenSearch Service API, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Key Value

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-tag-structure.json",
  "name": "Tag",
  "description": "Specifies a key value pair for a resource tag.",
  "type": "object",
  "properties": {
    "Key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagKey"
        },
        {
          "description": "Specifies the <code>TagKey</code>, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached."
        }
      ]
    },
    "Value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagValue"
        },
        {
          "description": "Specifies the <code>TagValue</code>, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of <code>project : Trinity</code> and <code>cost-center : Trinity</code>"
        }
      ]
    }
  },
  "required": [
    "Key",
    "Value"
  ]
}