Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateGroup

Creates a group resource with a name and a filter expression.

Request Syntax


POST /CreateGroup HTTP/1.1
Content-type: application/json

{
   "FilterExpression": "string",
   "GroupName": "string",
   "InsightsConfiguration": { 
      "InsightsEnabled": boolean,
      "NotificationsEnabled": boolean
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FilterExpression

The filter expression defining criteria by which to group traces.

Type: String

Required: No

GroupName

The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Required: Yes

InsightsConfiguration

The structure containing configurations related to insights.

The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group.
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.

Type: InsightsConfiguration object

Required: No

Tags

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 Tagging Amazon resources in the Amazon General Reference.

The following restrictions apply to tags:

Maximum number of user-applied tags per resource: 50
Maximum tag key length: 128 Unicode characters
Maximum tag value length: 256 Unicode characters
Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @
Tag keys and values are case sensitive.
Don't use aws: as a prefix for keys; it's reserved for Amazon use.

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Group": { 
      "FilterExpression": "string",
      "GroupARN": "string",
      "GroupName": "string",
      "InsightsConfiguration": { 
         "InsightsEnabled": boolean,
         "NotificationsEnabled": boolean
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Group

The group that was created. Contains the name of the group that was created, the Amazon Resource Name (ARN) of the group that was generated based on the group name, the filter expression, and the insight configuration that was assigned to the group.

Type: Group object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429