AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the FilterLogEvents operation. Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

Inheritance Hierarchy

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

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

Syntax

C#
public class FilterLogEventsRequest : AmazonCloudWatchLogsRequest
         IAmazonWebServiceRequest

The FilterLogEventsRequest type exposes the following members

Constructors

NameDescription
Public Method FilterLogEventsRequest()

Properties

NameTypeDescription
Public Property EndTime System.Int64

Gets and sets the property EndTime.

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

Public Property FilterPattern System.String

Gets and sets the property FilterPattern.

The filter pattern to use. If not provided, all the events are matched.

Public Property Interleaved System.Boolean

Gets and sets the property Interleaved.

If the value is true, the operation makes a best effort 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. The default is false.

Public Property Limit System.Int32

Gets and sets the property Limit.

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

Public Property LogGroupName System.String

Gets and sets the property LogGroupName.

The name of the log group.

Public Property LogStreamNames System.Collections.Generic.List<System.String>

Gets and sets the property LogStreamNames.

Optional list of log stream names.

Public Property NextToken System.String

Gets and sets the property NextToken.

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

Public Property StartTime System.Int64

Gets and sets the property StartTime.

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

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms