AWS CLI Command Reference

[ aws . application-signals ]

put-grouping-configuration

Description

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

Synopsis

  put-grouping-configuration
--grouping-attribute-definitions <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--grouping-attribute-definitions (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.

(structure)

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

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)

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

Shorthand Syntax:

GroupingName=string,GroupingSourceKeys=string,string,DefaultGroupingValue=string ...

JSON Syntax:

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

GroupingConfiguration -> (structure)

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

GroupingAttributeDefinitions -> (list) [required]

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

(structure)

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

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)

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

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.

Constraints:

  • min: 1
  • max: 128
  • pattern: [a-zA-Z0-9\s+\-=\._:/@]*

UpdatedAt -> (timestamp) [required]

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.
© Copyright 2025, Amazon Web Services. Created using Sphinx.