CloudWatchApplicationSignals / Client / list_grouping_attribute_definitions

list_grouping_attribute_definitions¶

CloudWatchApplicationSignals.Client.list_grouping_attribute_definitions(**kwargs)¶

Retrieves the available grouping attribute definitions that can be used to create grouping configurations. These definitions specify the attributes and rules available for organizing services.

Use this operation to discover what grouping options are available before creating or updating grouping configurations.

Request Syntax

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

Parameters:

NextToken (string) – The token for the next set of results. Use this token to retrieve additional pages of grouping attribute definitions when the result set is large.

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 available grouping attribute definitions that can be used to create grouping configurations.
  - (dict) –
    
    Defines how services should be grouped based on specific attributes. This allows logical organization of services in dashboards and service maps.
    - GroupingName (string) –
      
      The name of the grouping attribute, such as “Environment”, “Team”, or “Application”.
    - GroupingSourceKeys (list) –
      
      An array of source attribute keys that will be used to determine the grouping value for each service. These keys correspond to service metadata or tags.
      - (string) –
    - DefaultGroupingValue (string) –
      
      The default value to use for grouping when a service doesn’t have any of the specified source keys, such as “Unknown” or “Unassigned”.
- UpdatedAt (datetime) –
  
  The timestamp when the grouping attribute definitions were last updated. Expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.
- NextToken (string) –
  
  The token to use for retrieving the next page of results. This value is present only if there are more results available than were returned in the current response.

Exceptions

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