Tagging your API Gateway resources - Amazon API Gateway
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).

Tagging your API Gateway resources

A tag is a metadata label that you assign or that Amazon assigns to an Amazon resource. Each tag has two parts:

  • A tag key (for example, CostCenter, Environment, or Project). Tag keys are case sensitive.

  • An optional field known as a tag value (for example, 111122223333 or Production). Omitting the tag value is the same as using an empty string. Like tag keys, tag values are case-sensitive.

Tags help you do the following:

  • Control access to your resources based on the tags that are assigned to them. You control access by specifying tag keys and values in the conditions for an Amazon Identity and Access Management (IAM) policy. For more information about tag-based access control, see Controlling Access Using Tags in the IAM User Guide.

  • Track your Amazon costs. You activate these tags on the Amazon Billing and Cost Management dashboard. Amazon uses the tags to categorize your costs and deliver a monthly cost allocation report to you. For more information, see Use Cost Allocation Tags in the Amazon Billing User Guide.

  • Identify and organize your Amazon resources. Many Amazon services support tagging, so you can assign the same tag to resources from different services to indicate that the resources are related. For example, you could assign the same tag to an API Gateway stage that you assign to a CloudWatch Events rule.

For tips on using tags, see the Amazon Tagging Strategies post on the Amazon Answers blog.

The following sections provide more information about tags for Amazon API Gateway.