AWS SDK Version 2 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.

.NET Framework 4.5
 
 
Container for the parameters to the FilterLogEvents operation. Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp. You can limit the streams searched to an explicit list of logStreamNames.

By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken, then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

Inheritance Hierarchy

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

Namespace: Amazon.CloudWatchLogs.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C# 
public class FilterLogEventsRequest : AmazonCloudWatchLogsRequest
         IRequestEvents

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.

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.

Public Property FilterPattern System.String Gets and sets the property FilterPattern.

A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

Public Property Interleaved System.Boolean Gets and sets the property Interleaved.

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

Public Property Limit System.Int32 Gets and sets the property Limit.

The maximum number of events to return in a page of results. Default is 10,000 events.

Public Property LogGroupName System.String Gets and sets the property LogGroupName.

The name of the log group to query.

Public Property LogStreamNames System.Collections.Generic.List<System.String> Gets and sets the property LogStreamNames.

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

Public Property NextToken System.String Gets and sets the property NextToken.

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.

Public Property StartTime System.Int64 Gets and sets the property StartTime.

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.

Version Information

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