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

PutGroupingConfiguration

Creates or updates the grouping configuration for this account. This operation allows you to define custom grouping attributes that determine how services are logically grouped based on telemetry attributes, AWS tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.

Request Syntax


PUT /grouping-configuration HTTP/1.1
Content-type: application/json

{
   "GroupingAttributeDefinitions": [ 
      { 
         "DefaultGroupingValue": "string",
         "GroupingName": "string",
         "GroupingSourceKeys": [ "string" ]
      }
   ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

GroupingAttributeDefinitions

An array of grouping attribute definitions that specify how services should be grouped. Each definition includes a friendly name, source keys to derive the grouping value from, and an optional default value.

Type: Array of GroupingAttributeDefinition objects

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "GroupingConfiguration": { 
      "GroupingAttributeDefinitions": [ 
         { 
            "DefaultGroupingValue": "string",
            "GroupingName": "string",
            "GroupingSourceKeys": [ "string" ]
         }
      ],
      "UpdatedAt": number
   }
}

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.

GroupingConfiguration

A structure containing the updated grouping configuration, including all grouping attribute definitions and the timestamp when it was last updated.

Type: GroupingConfiguration object

Errors

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

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 403

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

The resource is not valid.

HTTP Status Code: 400