Class: Aws::CloudWatchLogs::Types::DescribeLogGroupsRequest

Inherits:

Struct

• Object
• Struct
• Aws::CloudWatchLogs::Types::DescribeLogGroupsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cloudwatchlogs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_identifiers ⇒ Array<String>

  When ‘includeLinkedAccounts` is set to `true`, use this parameter to specify the list of accounts to search.

• #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`.

• #limit ⇒ Integer

  The maximum number of items returned.

• #log_group_class ⇒ String

  Use this parameter to limit the results to only those log groups in the specified log group class.

• #log_group_identifiers ⇒ Array<String>

  Use this array to filter the list of log groups returned.

• #log_group_name_pattern ⇒ String

  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.

• #log_group_name_prefix ⇒ String

  The prefix to match.

• #next_token ⇒ String

  The token for the next set of items to return.

Instance Attribute Details

#account_identifiers ⇒ Array<String>

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.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#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`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

Returns:

• (Integer)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_class ⇒ 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.

Specifies the log group class for this log group. There are three 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.

• Use the ‘Delivery` log class only for delivering Lambda logs to store in Amazon S3 or Amazon Data Firehose. Log events in log groups in the Delivery class are kept in CloudWatch Logs for only one day. This log class doesn’t offer rich CloudWatch Logs capabilities such as CloudWatch Logs Insights queries.

For details about the features supported by each class, see [Log classes]

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifiers ⇒ Array<String>

Use this array to filter the list of log groups returned. If you specify this parameter, the only other filter that you can choose to specify is ‘includeLinkedAccounts`.

If you are using this operation in a monitoring account, you can specify the ARNs of log groups in source accounts and in the monitoring account itself. If you are using this operation in an account that is not a cross-account monitoring account, you can specify only log group names in the same account as the operation.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name_pattern ⇒ String

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 ‘DataLogs`, log groups named `DataLogs`, `aws/DataLogs`, and `GroupDataLogs` would match, but `datalogs`, `Data/log/s` and `Groupdata` would not match.

If you specify ‘logGroupNamePattern` in your request, then only `arn`, `creationTime`, and `logGroupName` are included in the response.

<note markdown=“1”> ‘logGroupNamePattern` and `logGroupNamePrefix` are mutually exclusive. Only one of these parameters can be passed.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_name_prefix ⇒ String

The prefix to match.

<note markdown=“1”> ‘logGroupNamePrefix` and `logGroupNamePattern` are mutually exclusive. Only one of these parameters can be passed.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The token for the next set of items to return. (You received this token from a previous call.)

Returns:

• (String)

# File 'lib/aws-sdk-cloudwatchlogs/types.rb', line 2120

class DescribeLogGroupsRequest < Struct.new(
  :account_identifiers,
  :log_group_name_prefix,
  :log_group_name_pattern,
  :next_token,
  :limit,
  :include_linked_accounts,
  :log_group_class,
  :log_group_identifiers)
  SENSITIVE = []
  include Aws::Structure
end