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.

You must have the logs:FilterLogEvents permission to perform this operation.

You can specify the log group to search by using either logGroupIdentifier or logGroupName. You must include one of these two parameters, but you can't include both.

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 specified time range. If the results include a token, that means there are more log events available. You can get additional results by specifying the token in a subsequent call. This operation can return empty results while there are more log events available through the token.

The returned log events are sorted by event timestamp, the timestamp when the event was ingested by CloudWatch Logs, and the ID of the PutLogEvents request.

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.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 timestamp later than this time are not returned.

Public Property FilterPattern System.String

Gets and sets the property FilterPattern.

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

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

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 LogGroupIdentifier System.String

Gets and sets the property LogGroupIdentifier.

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.

Public Property LogGroupName System.String

Gets and sets the property LogGroupName.

The name of the log group to search.

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

Public Property LogStreamNamePrefix System.String

Gets and sets the property LogStreamNamePrefix.

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, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

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

Gets and sets the property LogStreamNames.

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

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

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 timestamp before this time are not returned.

Public Property Unmask System.Boolean

Gets and sets the property Unmask.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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