CloudWatchApplicationSignals / Client / put_grouping_configuration

put_grouping_configuration

CloudWatchApplicationSignals.Client.put_grouping_configuration(**kwargs)

Creates or updates a grouping configuration that defines how services are organized and grouped in Application Signals dashboards and service maps.

Grouping configurations allow you to logically organize services based on attributes such as environment, team ownership, or business function, making it easier to monitor and manage related services together.

See also: AWS API Documentation

Request Syntax

response = client.put_grouping_configuration(
    GroupingAttributeDefinitions=[
        {
            'GroupingName': 'string',
            'GroupingSourceKeys': [
                'string',
            ],
            'DefaultGroupingValue': 'string'
        },
    ]
)

Parameters:

GroupingAttributeDefinitions (list) –

[REQUIRED]

An array of grouping attribute definitions that specify how services should be grouped. Each definition includes the grouping name, source keys, and default values.

• (dict) –

  Defines how services should be grouped based on specific attributes. This allows logical organization of services in dashboards and service maps.

  • GroupingName (string) – [REQUIRED]

    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”.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • GroupingConfiguration (dict) –

    The created or updated grouping configuration, including all attribute definitions and metadata such as the update timestamp.

    • GroupingAttributeDefinitions (list) –

      An array of grouping attribute definitions that specify the rules for organizing services into groups.

      • (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 configuration was last updated, expressed as the number of milliseconds since January 1, 1970, 00:00:00 UTC.

Exceptions

• CloudWatchApplicationSignals.Client.exceptions.ValidationException

• CloudWatchApplicationSignals.Client.exceptions.ThrottlingException

• CloudWatchApplicationSignals.Client.exceptions.AccessDeniedException