x-amazon-apigateway-tag-value property - Amazon API Gateway
x-amazon-apigateway-tag-value example
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

x-amazon-apigateway-tag-value property

Specifies the value of an Amazon tag for an HTTP API. You can use the x-amazon-apigateway-tag-value property as part of the root-level OpenAPI tag object to specify Amazon tags for an HTTP API. If you specify a tag name without the x-amazon-apigateway-tag-value property, API Gateway creates a tag with an empty string for a value.

To learn more about tagging, see Tagging your API Gateway resources.

Properties
Property name Type Description

name

 String

Specifies the tag key.

x-amazon-apigateway-tag-value

 String

Specifies the tag value.

x-amazon-apigateway-tag-value example

The following example specifies two tags for an HTTP API:

  • "Owner": "Admin"

  • "Prod": ""

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