API Reference (API Version 2016-04-12)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


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" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.


The filter expression defining criteria by which to group traces.

Type: String

Required: No


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

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Group": { "FilterExpression": "string", "GroupARN": "string", "GroupName": "string" } }

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.


The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, and the filter expression that was assigned to the group.

Type: Group object


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


The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400


The request exceeds the maximum number of requests per second.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: