Amazon Comprehend · JSON Structure

Openapi.Yml Tag Structure

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

Type: object Properties: 2 Required: 1
Machine LearningNatural Language ProcessingNLPText Analysis

Tag is a JSON Structure definition published by Amazon Comprehend, describing 2 properties, of which 1 is 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-comprehend/refs/heads/main/json-structure/openapi.yml-tag-structure.json",
  "name": "Tag",
  "description": "A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair \u2018Department\u2019:\u2019Sales\u2019 might be added to a resource to indicate its use by a particular department. ",
  "type": "object",
  "properties": {
    "Key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagKey"
        },
        {
          "description": "The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \u201cDepartment\u201d as the key portion of the pair, with multiple possible values such as \u201csales,\u201d \u201clegal,\u201d and \u201cadministration.\u201d "
        }
      ]
    },
    "Value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TagValue"
        },
        {
          "description": " The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use \u201cDepartment\u201d as the initial (key) portion of the pair, with a value of \u201csales\u201d to indicate the sales department. "
        }
      ]
    }
  },
  "required": [
    "Key"
  ]
}