DescribeLogGroupsRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeLogGroups operation. Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

CloudWatch Logs doesn't support IAM policies that control access to the DescribeLogGroups action by using the aws:ResourceTag/key-name condition key. Other CloudWatch Logs actions do support the use of the aws:ResourceTag/key-name condition key to control access. For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account and view data from the linked source accounts. For more information, see CloudWatch cross-account observability.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudWatchLogs.AmazonCloudWatchLogsRequest
      Amazon.CloudWatchLogs.Model.DescribeLogGroupsRequest

Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.CloudWatchLogs.dll
Version: 3.x.y.z

Syntax

public class DescribeLogGroupsRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The DescribeLogGroupsRequest type exposes the following members

Constructors

	Name	Description
	DescribeLogGroupsRequest()

Properties

Name	Type	Description
AccountIdentifiers	System.Collections.Generic.List<System.String>	Gets and sets the property AccountIdentifiers. 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.
IncludeLinkedAccounts	System.Boolean	Gets and sets the property IncludeLinkedAccounts. 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.
Limit	System.Int32	Gets and sets the property Limit. The maximum number of items returned. If you don't specify a value, the default is up to 50 items.
LogGroupClass	Amazon.CloudWatchLogs.LogGroupClass	Gets and sets the property LogGroupClass. Specifies the log group class for this log group. There are two classes: The `Standard` log class supports all CloudWatch Logs features. The `Infrequent Access` log class supports a subset of CloudWatch Logs features and incurs lower costs. For details about the features supported by each class, see Log classes
LogGroupNamePattern	System.String	Gets and sets the property LogGroupNamePattern. If you specify a string for this parameter, the operation returns only log groups that have names that match the string based on a case-sensitive substring search. For example, if you specify `Foo`, log groups named `FooBar`, `aws/Foo`, and `GroupFoo` would match, but `foo`, `F/o/o` and `Froo` would not match. If you specify `logGroupNamePattern` in your request, then only `arn`, `creationTime`, and `logGroupName` are included in the response. `logGroupNamePattern` and `logGroupNamePrefix` are mutually exclusive. Only one of these parameters can be passed.
LogGroupNamePrefix	System.String	Gets and sets the property LogGroupNamePrefix. The prefix to match. `logGroupNamePrefix` and `logGroupNamePattern` are mutually exclusive. Only one of these parameters can be passed.
NextToken	System.String	Gets and sets the property NextToken. The token for the next set of items to return. (You received this token from a previous call.)

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5