CloudWatchLogs / Client / list_log_groups

list_log_groups

CloudWatchLogs.Client.list_log_groups(**kwargs)

Returns a list of log groups in the Region in your account. If you are performing this action in a monitoring account, you can choose to also return 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.

You can optionally filter the list by log group class and by using regular expressions in your request to match strings in the log group names.

This operation is paginated. By default, your first use of this operation returns 50 results, and includes a token to use in a subsequent operation to return more results.

See also: AWS API Documentation

Request Syntax

response = client.list_log_groups(
    logGroupNamePattern='string',
    logGroupClass='STANDARD'|'INFREQUENT_ACCESS'|'DELIVERY',
    includeLinkedAccounts=True|False,
    accountIdentifiers=[
        'string',
    ],
    nextToken='string',
    limit=123
)
Parameters:

  • logGroupNamePattern (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.

  • logGroupClass (string) – Use this parameter to limit the results to only those log groups in the specified log group class. If you omit this parameter, log groups of all classes can be returned.

  • includeLinkedAccounts (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.

  • accountIdentifiers (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.

    • (string) –

  • nextToken (string) – The token for the next set of items to return. The token expires after 24 hours.

  • limit (integer) – The maximum number of log groups to return. If you omit this parameter, the default is up to 50 log groups.

Return type:

dict

Returns:

Response Syntax

{
    'logGroups': [
        {
            'logGroupName': 'string',
            'logGroupArn': 'string',
            'logGroupClass': 'STANDARD'|'INFREQUENT_ACCESS'|'DELIVERY'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • logGroups (list) –

      An array of structures, where each structure contains the information about one log group.

      • (dict) –

        This structure contains information about one log group in your account.

        • logGroupName (string) –

          The name of the log group.

        • logGroupArn (string) –

          The Amazon Resource Name (ARN) of the log group.

        • logGroupClass (string) –

          The log group class for this log group. For details about the features supported by each log group class, see Log classes

    • nextToken (string) –

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

Exceptions