AWS CLI Command Reference

[ aws . logs ]

list-aggregate-log-group-summaries

Description

Returns an aggregate summary of all log groups in the Region grouped by specified data source characteristics. Supports optional filtering by log group class, name patterns, and data sources. If you perform this action in a monitoring account, you can also return aggregated summaries of log groups from source accounts that are linked to the monitoring account. For more information about using cross-account observability to set up monitoring accounts and source accounts, see CloudWatch cross-account observability .

The operation aggregates log groups by data source name and type and optionally format, providing counts of log groups that share these characteristics. The operation paginates results. By default, it returns up to 50 results and includes a token to retrieve more results.

See also: AWS API Documentation

Synopsis

  list-aggregate-log-group-summaries
[--account-identifiers <value>]
[--include-linked-accounts | --no-include-linked-accounts]
[--log-group-class <value>]
[--log-group-name-pattern <value>]
[--data-sources <value>]
--group-by <value>
[--next-token <value>]
[--limit <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

--account-identifiers (list)

When includeLinkedAccounts is set to true , use this parameter to specify the list of accounts to search. You can specify as many as 20 account IDs in the array.

Constraints:

  • min: 0
  • max: 20

(string)

Constraints:

  • min: 12
  • max: 12
  • pattern: ^\d{12}$

Syntax:

"string" "string" ...

--include-linked-accounts | --no-include-linked-accounts (boolean)

If you are using a monitoring account, set this to true to have the operation return log groups in the accounts listed in accountIdentifiers .

If this parameter is set to true and accountIdentifiers contains a null value, the operation returns all log groups in the monitoring account and all log groups in all source accounts that are linked to the monitoring account.

The default for this parameter is false .

--log-group-class (string)

Filters the results by log group class to include only log groups of the specified class.

Possible values:

  • STANDARD
  • INFREQUENT_ACCESS
  • DELIVERY

--log-group-name-pattern (string)

Use this parameter to limit the returned log groups to only those with names that match the pattern that you specify. This parameter is a regular expression that can match prefixes and substrings, and supports wildcard matching and matching multiple patterns, as in the following examples.

  • Use ^ to match log group names by prefix.
  • For a substring match, specify the string to match. All matches are case sensitive
  • To match multiple patterns, separate them with a | as in the example ^/aws/lambda|discovery

You can specify as many as five different regular expression patterns in this field, each of which must be between 3 and 24 characters. You can include the ^ symbol as many as five times, and include the | symbol as many as four times.

Constraints:

  • min: 3
  • max: 129
  • pattern: (\^?[\.\-_\/#A-Za-z0-9]{3,24})(\|\^?[\.\-_\/#A-Za-z0-9]{3,24}){0,4}

--data-sources (list)

Filters the results by data source characteristics to include only log groups associated with the specified data sources.

Constraints:

  • min: 1
  • max: 5

(structure)

Filter criteria for data sources, used to specify which data sources to include in operations based on name and type.

name -> (string) [required]

The name pattern to filter data sources by.

type -> (string)

The type pattern to filter data sources by.

Shorthand Syntax:

name=string,type=string ...

JSON Syntax:

[
  {
    "name": "string",
    "type": "string"
  }
  ...
]

--group-by (string) [required]

Specifies how to group the log groups in the summary.

Possible values:

  • DATA_SOURCE_NAME_TYPE_AND_FORMAT
  • DATA_SOURCE_NAME_AND_TYPE

--next-token (string)

The token for the next set of items to return. The token expires after 24 hours.

Constraints:

  • min: 1

--limit (integer)

The maximum number of aggregated summaries to return. If you omit this parameter, the default is up to 50 aggregated summaries.

Constraints:

  • min: 1
  • max: 50

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

aggregateLogGroupSummaries -> (list)

The list of aggregate log group summaries grouped by the specified data source characteristics.

(structure)

Contains an aggregate summary of log groups grouped by data source characteristics, including the count of log groups and their grouping identifiers.

logGroupCount -> (integer)

The number of log groups in this aggregate summary group.

groupingIdentifiers -> (list)

An array of key-value pairs that identify the data source characteristics used to group the log groups.

The size and content of this array depends on the groupBy parameter specified in the request.

(structure)

A key-value pair that identifies how log groups are grouped in aggregate summaries.

key -> (string)

The key that identifies the grouping characteristic. The format of the key uses dot notation. Examples are, dataSource.Name , dataSource.Type , and dataSource.Format .

value -> (string)

The value associated with the grouping characteristic. Examples are amazon_vpc , flow , and OCSF .

nextToken -> (string)

The token for the next set of items to return. The token expires after 24 hours.

Constraints:

  • min: 1
© Copyright 2025, Amazon Web Services. Created using Sphinx.