CloudWatchApplicationSignals / Client / list_grouping_attribute_definitions

list_grouping_attribute_definitions¶

CloudWatchApplicationSignals.Client.list_grouping_attribute_definitions(**kwargs)¶

Returns the current grouping configuration for this account, including all custom grouping attribute definitions that have been configured. These definitions determine how services are logically grouped based on telemetry attributes, Amazon Web Services tags, or predefined mappings.

Request Syntax

response = client.list_grouping_attribute_definitions(
    NextToken='string'
)

Parameters:

NextToken (string) – Include this value, if it was returned by the previous operation, to get the next set of grouping attribute definitions.

Return type:

dict

Returns:

Response Syntax

{
    'GroupingAttributeDefinitions': [
        {
            'GroupingName': 'string',
            'GroupingSourceKeys': [
                'string',
            ],
            'DefaultGroupingValue': 'string'
        },
    ],
    'UpdatedAt': datetime(2015, 1, 1),
    'NextToken': 'string'
}

Response Structure

(dict) –
- GroupingAttributeDefinitions (list) –
  
  An array of structures, where each structure contains information about one grouping attribute definition, including the grouping name, source keys, and default values.
  - (dict) –
    
    A structure that defines how services should be grouped based on specific attributes. This includes the friendly name for the grouping, the source keys to derive values from, and an optional default value.
    - GroupingName (string) –
      
      The friendly name for this grouping attribute, such as BusinessUnit or Environment. This name is used to identify the grouping in the console and APIs.
    - GroupingSourceKeys (list) –
      
      An array of source keys used to derive the grouping attribute value from telemetry data, Amazon Web Services tags, or other sources. For example, [“business_unit”, “team”] would look for values in those fields.
      - (string) –
    - DefaultGroupingValue (string) –
      
      The default value to use for this grouping attribute when no value can be derived from the source keys. This ensures all services have a grouping value even if the source data is missing.
- UpdatedAt (datetime) –
  
  The timestamp when the grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
- NextToken (string) –
  
  Include this value in your next use of this API to get the next set of grouping attribute definitions.

Exceptions

CloudWatchApplicationSignals.Client.exceptions.ValidationException
CloudWatchApplicationSignals.Client.exceptions.ThrottlingException
CloudWatchApplicationSignals.Client.exceptions.AccessDeniedException