CloudWatchApplicationSignals / Client / put_grouping_configuration

put_grouping_configuration

CloudWatchApplicationSignals.Client.put_grouping_configuration(**kwargs)

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, Amazon Web Services tags, or predefined mappings. These grouping attributes can then be used to organize and filter services in the Application Signals console and APIs.

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 a friendly name, source keys to derive the grouping value from, and an optional default value.

• (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) – [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • GroupingConfiguration (dict) –

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

    • GroupingAttributeDefinitions (list) –

      An array of grouping attribute definitions that specify how services should be grouped based on various attributes and source keys.

      • (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 this grouping configuration was last updated. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.

Exceptions

• CloudWatchApplicationSignals.Client.exceptions.ValidationException

• CloudWatchApplicationSignals.Client.exceptions.ThrottlingException

• CloudWatchApplicationSignals.Client.exceptions.AccessDeniedException