Amazon DevOps Guru · Schema
TagHealth
Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.
Anomaly DetectionDevOpsMachine LearningOperational Intelligence
Properties
| Name | Type | Description |
|---|---|---|
| AppBoundaryKey | object | |
| TagValue | object | |
| Insight | object | |
| AnalyzedResourceCount | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-devops-guru/refs/heads/main/json-schema/amazon-devops-guru-tag-health-schema.json",
"title": "TagHealth",
"description": "Information about the health of Amazon Web Services resources in your account that are specified by an Amazon Web Services tag key.",
"type": "object",
"properties": {
"AppBoundaryKey": {
"allOf": [
{
"$ref": "#/components/schemas/AppBoundaryKey"
},
{
"description": "<p>An Amazon Web Services tag <i>key</i> that is used to identify the Amazon Web Services resources that DevOps Guru analyzes. All Amazon Web Services resources in your account and Region tagged with this <i>key</i> make up your DevOps Guru application and analysis boundary.</p> <important> <p>The string used for a <i>key</i> in a tag that you use to define your resource coverage must begin with the prefix <code>Devops-guru-</code>. The tag <i>key</i> might be <code>DevOps-Guru-deployment-application</code> or <code>devops-guru-rds-application</code>. When you create a <i>key</i>, the case of characters in the <i>key</i> can be whatever you choose. After you create a <i>key</i>, it is case-sensitive. For example, DevOps Guru works with a <i>key</i> named <code>devops-guru-rds</code> and a <i>key</i> named <code>DevOps-Guru-RDS</code>, and these act as two different <i>keys</i>. Possible <i>key</i>/<i>value</i> pairs in your application might be <code>Devops-Guru-production-application/RDS</code> or <code>Devops-Guru-production-application/containers</code>.</p> </important>"
}
]
},
"TagValue": {
"allOf": [
{
"$ref": "#/components/schemas/TagValue"
},
{
"description": "<p>The value in an Amazon Web Services tag.</p> <p>The tag's <i>value</i> is an optional field used to associate a string with the tag <i>key</i> (for example, <code>111122223333</code>, <code>Production</code>, or a team name). The <i>key</i> and <i>value</i> are the tag's <i>key</i> pair. Omitting the tag <i>value</i> is the same as using an empty string. Like tag <i>keys</i>, tag <i>values</i> are case-sensitive. You can specify a maximum of 256 characters for a tag value.</p>"
}
]
},
"Insight": {
"allOf": [
{
"$ref": "#/components/schemas/InsightHealth"
},
{
"description": "Information about the health of the Amazon Web Services resources in your account that are specified by an Amazon Web Services tag, including the number of open proactive, open reactive insights, and the Mean Time to Recover (MTTR) of closed insights. "
}
]
},
"AnalyzedResourceCount": {
"allOf": [
{
"$ref": "#/components/schemas/AnalyzedResourceCount"
},
{
"description": " Number of resources that DevOps Guru is monitoring in your account that are specified by an Amazon Web Services tag. "
}
]
}
}
}