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

UpdateGroup

Updates a group resource.

Request Syntax


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

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

FilterExpression

The updated filter expression defining criteria by which to group traces.

Type: String

Required: No

GroupARN

The ARN that was generated upon creation.

Type: String

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

Required: No

GroupName

The case-sensitive name of the group.

Type: String

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

Required: No

InsightsConfiguration

The structure containing configurations related to insights.

The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group.
The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.

Type: InsightsConfiguration object

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 updated. Contains the name of the group that was updated, the ARN of the group that was updated, the updated filter expression, and the updated insight configuration 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