Class: Aws::CloudWatchLogs::Types::FilterLogEventsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeInteger

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Returns:

  • (Integer)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#filter_patternString

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Returns:

  • (String)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#interleavedBoolean

If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

Important As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

Returns:

  • (Boolean)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#limitInteger

The maximum number of events to return. The default is 10,000 events.

Returns:

  • (Integer)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_identifierString

Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

  • (String)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#log_group_nameString

The name of the log group to search.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

  • (String)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#log_stream_name_prefixString

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Returns:

  • (String)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#log_stream_namesArray<String>

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNames and logStreamNamePrefix, the action returns an InvalidParameterException error.

Returns:

  • (Array<String>)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeInteger

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

Returns:

  • (Integer)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end

#unmaskBoolean

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Returns:

  • (Boolean)


2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
# File 'gems/aws-sdk-cloudwatchlogs/lib/aws-sdk-cloudwatchlogs/types.rb', line 2890

class FilterLogEventsRequest < Struct.new(
  :log_group_name,
  :log_group_identifier,
  :log_stream_names,
  :log_stream_name_prefix,
  :start_time,
  :end_time,
  :filter_pattern,
  :next_token,
  :limit,
  :interleaved,
  :unmask)
  SENSITIVE = []
  include Aws::Structure
end