Amazon X-Ray · Schema
CreateGroupRequest
CreateGroupRequest schema from Amazon X-Ray API
Application PerformanceDebuggingDistributed TracingMonitoringObservability
Properties
| Name | Type | Description |
|---|---|---|
| GroupName | object | |
| FilterExpression | object | |
| InsightsConfiguration | object | |
| Tags | object |
JSON Schema
{
"type": "object",
"required": [
"GroupName"
],
"title": "CreateGroupRequest",
"properties": {
"GroupName": {
"allOf": [
{
"$ref": "#/components/schemas/GroupName"
},
{
"description": "The case-sensitive name of the new group. Default is a reserved name and names must be unique."
}
]
},
"FilterExpression": {
"allOf": [
{
"$ref": "#/components/schemas/FilterExpression"
},
{
"description": "The filter expression defining criteria by which to group traces."
}
]
},
"InsightsConfiguration": {
"allOf": [
{
"$ref": "#/components/schemas/InsightsConfiguration"
},
{
"description": "<p>The structure containing configurations related to insights.</p> <ul> <li> <p>The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.</p> </li> <li> <p>The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.</p> </li> </ul>"
}
]
},
"Tags": {
"allOf": [
{
"$ref": "#/components/schemas/TagList"
},
{
"description": "<p>A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html\">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference</i>.</p> <p>The following restrictions apply to tags:</p> <ul> <li> <p>Maximum number of user-applied tags per resource: 50</p> </li> <li> <p>Maximum tag key length: 128 Unicode characters</p> </li> <li> <p>Maximum tag value length: 256 Unicode characters</p> </li> <li> <p>Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Don't use <code>aws:</code> as a prefix for keys; it's reserved for Amazon Web Services use.</p> </li> </ul>"
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-xray/refs/heads/main/json-schema/xray-create-group-request-schema.json",
"description": "CreateGroupRequest schema from Amazon X-Ray API"
}